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