LXR linux/net/tipc/addr.h

   1/*
   2 * net/tipc/addr.h: Include file for 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#ifndef _TIPC_ADDR_H
  38#define _TIPC_ADDR_H
  39
  40static inline u32 own_node(void)
  41{
  42        return tipc_node(tipc_own_addr);
  43}
  44
  45static inline u32 own_cluster(void)
  46{
  47        return tipc_cluster(tipc_own_addr);
  48}
  49
  50static inline u32 own_zone(void)
  51{
  52        return tipc_zone(tipc_own_addr);
  53}
  54
  55static inline int in_own_cluster(u32 addr)
  56{
  57        return !((addr ^ tipc_own_addr) >> 12);
  58}
  59
  60static inline int is_slave(u32 addr)
  61{
  62        return addr & 0x800;
  63}
  64
  65static inline int may_route(u32 addr)
  66{
  67        return(addr ^ tipc_own_addr) >> 11;
  68}
  69
  70static inline int in_scope(u32 domain, u32 addr)
  71{
  72        if (!domain || (domain == addr))
  73                return 1;
  74        if (domain == (addr & 0xfffff000u)) /* domain <Z.C.0> */
  75                return 1;
  76        if (domain == (addr & 0xff000000u)) /* domain <Z.0.0> */
  77                return 1;
  78        return 0;
  79}
  80
  81/**
  82 * addr_scope - convert message lookup domain to equivalent 2-bit scope value
  83 */
  84
  85static inline int addr_scope(u32 domain)
  86{
  87        if (likely(!domain))
  88                return TIPC_ZONE_SCOPE;
  89        if (tipc_node(domain))
  90                return TIPC_NODE_SCOPE;
  91        if (tipc_cluster(domain))
  92                return TIPC_CLUSTER_SCOPE;
  93        return TIPC_ZONE_SCOPE;
  94}
  95
  96/**
  97 * addr_domain - convert 2-bit scope value to equivalent message lookup domain
  98 *
  99 * Needed when address of a named message must be looked up a second time
 100 * after a network hop.
 101 */
 102
 103static inline int addr_domain(int sc)
 104{
 105        if (likely(sc == TIPC_NODE_SCOPE))
 106                return tipc_own_addr;
 107        if (sc == TIPC_CLUSTER_SCOPE)
 108                return tipc_addr(tipc_zone(tipc_own_addr),
 109                                 tipc_cluster(tipc_own_addr), 0);
 110        return tipc_addr(tipc_zone(tipc_own_addr), 0, 0);
 111}
 112
 113static inline char *addr_string_fill(char *string, u32 addr)
 114{
 115        snprintf(string, 16, "<%u.%u.%u>",
 116                 tipc_zone(addr), tipc_cluster(addr), tipc_node(addr));
 117        return string;
 118}
 119
 120int tipc_addr_domain_valid(u32);
 121int tipc_addr_node_valid(u32 addr);
 122
 123#endif
 124