xref: /openbmc/linux/net/tipc/addr.c (revision 94cdda6b)
1 /*
2  * net/tipc/addr.c: TIPC address utility routines
3  *
4  * Copyright (c) 2000-2006, Ericsson AB
5  * Copyright (c) 2004-2005, 2010-2011, 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 #include <linux/kernel.h>
38 #include "addr.h"
39 #include "core.h"
40 
41 u32 tipc_own_addr(struct net *net)
42 {
43 	struct tipc_net *tn = net_generic(net, tipc_net_id);
44 
45 	return tn->own_addr;
46 }
47 
48 /**
49  * in_own_cluster - test for cluster inclusion; <0.0.0> always matches
50  */
51 int in_own_cluster(struct net *net, u32 addr)
52 {
53 	return in_own_cluster_exact(net, addr) || !addr;
54 }
55 
56 int in_own_cluster_exact(struct net *net, u32 addr)
57 {
58 	struct tipc_net *tn = net_generic(net, tipc_net_id);
59 
60 	return !((addr ^ tn->own_addr) >> 12);
61 }
62 
63 /**
64  * in_own_node - test for node inclusion; <0.0.0> always matches
65  */
66 int in_own_node(struct net *net, u32 addr)
67 {
68 	struct tipc_net *tn = net_generic(net, tipc_net_id);
69 
70 	return (addr == tn->own_addr) || !addr;
71 }
72 
73 /**
74  * addr_domain - convert 2-bit scope value to equivalent message lookup domain
75  *
76  * Needed when address of a named message must be looked up a second time
77  * after a network hop.
78  */
79 u32 addr_domain(struct net *net, u32 sc)
80 {
81 	struct tipc_net *tn = net_generic(net, tipc_net_id);
82 
83 	if (likely(sc == TIPC_NODE_SCOPE))
84 		return tn->own_addr;
85 	if (sc == TIPC_CLUSTER_SCOPE)
86 		return tipc_cluster_mask(tn->own_addr);
87 	return tipc_zone_mask(tn->own_addr);
88 }
89 
90 /**
91  * tipc_addr_domain_valid - validates a network domain address
92  *
93  * Accepts <Z.C.N>, <Z.C.0>, <Z.0.0>, and <0.0.0>,
94  * where Z, C, and N are non-zero.
95  *
96  * Returns 1 if domain address is valid, otherwise 0
97  */
98 int tipc_addr_domain_valid(u32 addr)
99 {
100 	u32 n = tipc_node(addr);
101 	u32 c = tipc_cluster(addr);
102 	u32 z = tipc_zone(addr);
103 
104 	if (n && (!z || !c))
105 		return 0;
106 	if (c && !z)
107 		return 0;
108 	return 1;
109 }
110 
111 /**
112  * tipc_addr_node_valid - validates a proposed network address for this node
113  *
114  * Accepts <Z.C.N>, where Z, C, and N are non-zero.
115  *
116  * Returns 1 if address can be used, otherwise 0
117  */
118 int tipc_addr_node_valid(u32 addr)
119 {
120 	return tipc_addr_domain_valid(addr) && tipc_node(addr);
121 }
122 
123 int tipc_in_scope(u32 domain, u32 addr)
124 {
125 	if (!domain || (domain == addr))
126 		return 1;
127 	if (domain == tipc_cluster_mask(addr)) /* domain <Z.C.0> */
128 		return 1;
129 	if (domain == tipc_zone_mask(addr)) /* domain <Z.0.0> */
130 		return 1;
131 	return 0;
132 }
133 
134 /**
135  * tipc_addr_scope - convert message lookup domain to a 2-bit scope value
136  */
137 int tipc_addr_scope(u32 domain)
138 {
139 	if (likely(!domain))
140 		return TIPC_ZONE_SCOPE;
141 	if (tipc_node(domain))
142 		return TIPC_NODE_SCOPE;
143 	if (tipc_cluster(domain))
144 		return TIPC_CLUSTER_SCOPE;
145 	return TIPC_ZONE_SCOPE;
146 }
147 
148 char *tipc_addr_string_fill(char *string, u32 addr)
149 {
150 	snprintf(string, 16, "<%u.%u.%u>",
151 		 tipc_zone(addr), tipc_cluster(addr), tipc_node(addr));
152 	return string;
153 }
154