blob: 60b00ab93d74159cbc18e1caa1e469a7e38b651c [file] [log] [blame]
Per Lidenb97bf3f2006-01-02 19:04:38 +01001/*
2 * net/tipc/addr.h: Include file for TIPC address utility routines
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +09003 *
Per Liden593a5f22006-01-11 19:14:19 +01004 * Copyright (c) 2000-2006, Ericsson AB
Per Lidenb97bf3f2006-01-02 19:04:38 +01005 * Copyright (c) 2004-2005, Wind River Systems
Per Lidenb97bf3f2006-01-02 19:04:38 +01006 * All rights reserved.
7 *
Per Liden9ea1fd32006-01-11 13:30:43 +01008 * Redistribution and use in source and binary forms, with or without
Per Lidenb97bf3f2006-01-02 19:04:38 +01009 * modification, are permitted provided that the following conditions are met:
10 *
Per Liden9ea1fd32006-01-11 13:30:43 +010011 * 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.
Per Lidenb97bf3f2006-01-02 19:04:38 +010019 *
Per Liden9ea1fd32006-01-11 13:30:43 +010020 * 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
Per Lidenb97bf3f2006-01-02 19:04:38 +010034 * POSSIBILITY OF SUCH DAMAGE.
35 */
36
37#ifndef _TIPC_ADDR_H
38#define _TIPC_ADDR_H
39
Paul Gortmaker1f3de472011-04-19 13:11:23 -040040#define TIPC_ZONE_MASK 0xff000000u
41#define TIPC_CLUSTER_MASK 0xfffff000u
42
Allan Stephensa3796f82011-02-23 11:44:49 -050043static inline u32 tipc_zone_mask(u32 addr)
44{
Paul Gortmaker1f3de472011-04-19 13:11:23 -040045 return addr & TIPC_ZONE_MASK;
Allan Stephensa3796f82011-02-23 11:44:49 -050046}
47
48static inline u32 tipc_cluster_mask(u32 addr)
49{
Paul Gortmaker1f3de472011-04-19 13:11:23 -040050 return addr & TIPC_CLUSTER_MASK;
Allan Stephensa3796f82011-02-23 11:44:49 -050051}
52
Allan Stephens336ebf52012-04-17 18:02:01 -040053static inline int in_own_cluster_exact(u32 addr)
Per Lidenb97bf3f2006-01-02 19:04:38 +010054{
55 return !((addr ^ tipc_own_addr) >> 12);
56}
57
Per Lidenb97bf3f2006-01-02 19:04:38 +010058/**
Allan Stephens336ebf52012-04-17 18:02:01 -040059 * in_own_node - test for node inclusion; <0.0.0> always matches
60 */
Allan Stephens336ebf52012-04-17 18:02:01 -040061static 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 */
Allan Stephens336ebf52012-04-17 18:02:01 -040069static inline int in_own_cluster(u32 addr)
70{
71 return in_own_cluster_exact(addr) || !addr;
72}
73
74/**
Per Lidenb97bf3f2006-01-02 19:04:38 +010075 * addr_domain - convert 2-bit scope value to equivalent message lookup domain
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090076 *
77 * Needed when address of a named message must be looked up a second time
Per Lidenb97bf3f2006-01-02 19:04:38 +010078 * after a network hop.
79 */
Allan Stephensa3796f82011-02-23 11:44:49 -050080static inline u32 addr_domain(u32 sc)
Per Lidenb97bf3f2006-01-02 19:04:38 +010081{
82 if (likely(sc == TIPC_NODE_SCOPE))
83 return tipc_own_addr;
84 if (sc == TIPC_CLUSTER_SCOPE)
Allan Stephensa3796f82011-02-23 11:44:49 -050085 return tipc_cluster_mask(tipc_own_addr);
86 return tipc_zone_mask(tipc_own_addr);
Per Lidenb97bf3f2006-01-02 19:04:38 +010087}
88
Per Liden4323add2006-01-18 00:38:21 +010089int tipc_addr_domain_valid(u32);
90int tipc_addr_node_valid(u32 addr);
Allan Stephens80e0c332010-05-11 14:30:13 +000091int tipc_in_scope(u32 domain, u32 addr);
92int tipc_addr_scope(u32 domain);
93char *tipc_addr_string_fill(char *string, u32 addr);
Per Lidenb97bf3f2006-01-02 19:04:38 +010094#endif