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