net/tipc/addr.h

   1 /*
   2  * net/tipc/addr.h: Include file for TIPC address utility routines
   3  *
   4  * Copyright (c) 2003-2005, Ericsson Research Canada
   5  * Copyright (c) 2004-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  * Redistributions of source code must retain the above copyright notice, this
  13  * list of conditions and the following disclaimer.
  14  * Redistributions in binary form must reproduce the above copyright notice,
  15  * this list of conditions and the following disclaimer in the documentation
  16  * and/or other materials provided with the distribution.
  17  * Neither the names of the copyright holders nor the names of its
  18  * contributors may be used to endorse or promote products derived from this
  19  * software without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  22  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  25  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  31  * POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _TIPC_ADDR_H
  35 #define _TIPC_ADDR_H
  36
  37 static inline u32 own_node(void)
  38 {
  39         return tipc_node(tipc_own_addr);
  40 }
  41
  42 static inline u32 own_cluster(void)
  43 {
  44         return tipc_cluster(tipc_own_addr);
  45 }
  46
  47 static inline u32 own_zone(void)
  48 {
  49         return tipc_zone(tipc_own_addr);
  50 }
  51
  52 static inline int in_own_cluster(u32 addr)
  53 {
  54         return !((addr ^ tipc_own_addr) >> 12);
  55 }
  56
  57 static inline int in_own_zone(u32 addr)
  58 {
  59         return !((addr ^ tipc_own_addr) >> 24);
  60 }
  61
  62 static inline int is_slave(u32 addr)
  63 {
  64         return addr & 0x800;
  65 }
  66
  67 static inline int may_route(u32 addr)
  68 {
  69         return(addr ^ tipc_own_addr) >> 11;
  70 }
  71
  72 static inline int in_scope(u32 domain, u32 addr)
  73 {
  74         if (!domain || (domain == addr))
  75                 return 1;
  76         if (domain == (addr & 0xfffff000u)) /* domain <Z.C.0> */
  77                 return 1;
  78         if (domain == (addr & 0xff000000u)) /* domain <Z.0.0> */
  79                 return 1;
  80         return 0;
  81 }
  82
  83 /**
  84  * addr_scope - convert message lookup domain to equivalent 2-bit scope value
  85  */
  86
  87 static inline int addr_scope(u32 domain)
  88 {
  89         if (likely(!domain))
  90                 return TIPC_ZONE_SCOPE;
  91         if (tipc_node(domain))
  92                 return TIPC_NODE_SCOPE;
  93         if (tipc_cluster(domain))
  94                 return TIPC_CLUSTER_SCOPE;
  95         return TIPC_ZONE_SCOPE;
  96 }
  97
  98 /**
  99  * addr_domain - convert 2-bit scope value to equivalent message lookup domain
 100  *
 101  * Needed when address of a named message must be looked up a second time
 102  * after a network hop.
 103  */
 104
 105 static inline int addr_domain(int sc)
 106 {
 107         if (likely(sc == TIPC_NODE_SCOPE))
 108                 return tipc_own_addr;
 109         if (sc == TIPC_CLUSTER_SCOPE)
 110                 return tipc_addr(tipc_zone(tipc_own_addr),
 111                                  tipc_cluster(tipc_own_addr), 0);
 112         return tipc_addr(tipc_zone(tipc_own_addr), 0, 0);
 113 }
 114
 115 static inline char *addr_string_fill(char *string, u32 addr)
 116 {
 117         snprintf(string, 16, "<%u.%u.%u>",
 118                  tipc_zone(addr), tipc_cluster(addr), tipc_node(addr));
 119         return string;
 120 }
 121
 122 int addr_domain_valid(u32);
 123 int addr_node_valid(u32 addr);
 124
 125 #endif