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
  40#define TIPC_ZONE_MASK          0xff000000u
  41#define TIPC_CLUSTER_MASK       0xfffff000u
  42
  43static inline u32 tipc_zone_mask(u32 addr)
  44{
  45        return addr & TIPC_ZONE_MASK;
  46}
  47
  48static inline u32 tipc_cluster_mask(u32 addr)
  49{
  50        return addr & TIPC_CLUSTER_MASK;
  51}
  52
  53static inline int in_own_cluster_exact(u32 addr)
  54{
  55        return !((addr ^ tipc_own_addr) >> 12);
  56}
  57
  58/**
  59 * in_own_node - test for node inclusion; <0.0.0> always matches
  60 */
  61static inline int in_own_node(u32 addr)
  62{
  63        return (addr == tipc_own_addr) || !addr;
  64}
  65
  66/**
  67 * in_own_cluster - test for cluster inclusion; <0.0.0> always matches
  68 */
  69static inline int in_own_cluster(u32 addr)
  70{
  71        return in_own_cluster_exact(addr) || !addr;
  72}
  73
  74/**
  75 * addr_domain - convert 2-bit scope value to equivalent message lookup domain
  76 *
  77 * Needed when address of a named message must be looked up a second time
  78 * after a network hop.
  79 */
  80static inline u32 addr_domain(u32 sc)
  81{
  82        if (likely(sc == TIPC_NODE_SCOPE))
  83                return tipc_own_addr;
  84        if (sc == TIPC_CLUSTER_SCOPE)
  85                return tipc_cluster_mask(tipc_own_addr);
  86        return tipc_zone_mask(tipc_own_addr);
  87}
  88
  89int tipc_addr_domain_valid(u32);
  90int tipc_addr_node_valid(u32 addr);
  91int tipc_in_scope(u32 domain, u32 addr);
  92int tipc_addr_scope(u32 domain);
  93char *tipc_addr_string_fill(char *string, u32 addr);
  94#endif
  95