1 /*
2 * net/tipc/core.h: Include file for TIPC global declarations
3 *
4 * Copyright (c) 2005-2006, 2013-2018 Ericsson AB
5 * Copyright (c) 2005-2007, 2010-2013, Wind River Systems
6 * Copyright (c) 2020, Red Hat Inc
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_CORE_H
39 #define _TIPC_CORE_H
40
41 #include <linux/tipc.h>
42 #include <linux/tipc_config.h>
43 #include <linux/tipc_netlink.h>
44 #include <linux/types.h>
45 #include <linux/kernel.h>
46 #include <linux/errno.h>
47 #include <linux/mm.h>
48 #include <linux/timer.h>
49 #include <linux/string.h>
50 #include <linux/uaccess.h>
51 #include <linux/interrupt.h>
52 #include <linux/atomic.h>
53 #include <linux/netdevice.h>
54 #include <linux/in.h>
55 #include <linux/list.h>
56 #include <linux/slab.h>
57 #include <linux/vmalloc.h>
58 #include <linux/rtnetlink.h>
59 #include <linux/etherdevice.h>
60 #include <net/netns/generic.h>
61 #include <linux/rhashtable.h>
62 #include <net/genetlink.h>
63 #include <net/netns/hash.h>
64
65 #ifdef pr_fmt
66 #undef pr_fmt
67 #endif
68
69 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
70
71 struct tipc_node;
72 struct tipc_bearer;
73 struct tipc_bc_base;
74 struct tipc_link;
75 struct tipc_topsrv;
76 struct tipc_monitor;
77 #ifdef CONFIG_TIPC_CRYPTO
78 struct tipc_crypto;
79 #endif
80
81 #define TIPC_MOD_VER "2.0.0"
82
83 #define NODE_HTABLE_SIZE 512
84 #define MAX_BEARERS 3
85 #define TIPC_DEF_MON_THRESHOLD 32
86 #define NODE_ID_LEN 16
87 #define NODE_ID_STR_LEN (NODE_ID_LEN * 2 + 1)
88
89 extern unsigned int tipc_net_id __read_mostly;
90 extern int sysctl_tipc_rmem[3] __read_mostly;
91 extern int sysctl_tipc_named_timeout __read_mostly;
92
93 struct tipc_net {
94 u8 node_id[NODE_ID_LEN];
95 u32 node_addr;
96 u32 trial_addr;
97 unsigned long addr_trial_end;
98 char node_id_string[NODE_ID_STR_LEN];
99 int net_id;
100 int random;
101 bool legacy_addr_format;
102
103 /* Node table and node list */
104 spinlock_t node_list_lock;
105 struct hlist_head node_htable[NODE_HTABLE_SIZE];
106 struct list_head node_list;
107 u32 num_nodes;
108 u32 num_links;
109
110 /* Neighbor monitoring list */
111 struct tipc_monitor *monitors[MAX_BEARERS];
112 int mon_threshold;
113
114 /* Bearer list */
115 struct tipc_bearer __rcu *bearer_list[MAX_BEARERS + 1];
116
117 /* Broadcast link */
118 spinlock_t bclock;
119 struct tipc_bc_base *bcbase;
120 struct tipc_link *bcl;
121
122 /* Socket hash table */
123 struct rhashtable sk_rht;
124
125 /* Name table */
126 spinlock_t nametbl_lock;
127 struct name_table *nametbl;
128
129 /* Topology subscription server */
130 struct tipc_topsrv *topsrv;
131 atomic_t subscription_count;
132
133 /* Cluster capabilities */
134 u16 capabilities;
135
136 /* Tracing of node internal messages */
137 struct packet_type loopback_pt;
138
139 #ifdef CONFIG_TIPC_CRYPTO
140 /* TX crypto handler */
141 struct tipc_crypto *crypto_tx;
142 #endif
143 /* Work item for net finalize */
144 struct work_struct work;
145 /* The numbers of work queues in schedule */
146 atomic_t wq_count;
147 };
148
149 static inline struct tipc_net *tipc_net(struct net *net)
150 {
151 return net_generic(net, tipc_net_id);
152 }
153
154 static inline int tipc_netid(struct net *net)
155 {
156 return tipc_net(net)->net_id;
157 }
158
159 static inline struct list_head *tipc_nodes(struct net *net)
160 {
161 return &tipc_net(net)->node_list;
162 }
163
164 static inline struct name_table *tipc_name_table(struct net *net)
165 {
166 return tipc_net(net)->nametbl;
167 }
168
169 static inline struct tipc_topsrv *tipc_topsrv(struct net *net)
170 {
171 return tipc_net(net)->topsrv;
172 }
173
174 static inline unsigned int tipc_hashfn(u32 addr)
175 {
176 return addr & (NODE_HTABLE_SIZE - 1);
177 }
178
179 static inline u16 mod(u16 x)
180 {
181 return x & 0xffffu;
182 }
183
184 static inline int less_eq(u16 left, u16 right)
185 {
186 return mod(right - left) < 32768u;
187 }
188
189 static inline int more(u16 left, u16 right)
190 {
191 return !less_eq(left, right);
192 }
193
194 static inline int less(u16 left, u16 right)
195 {
196 return less_eq(left, right) && (mod(right) != mod(left));
197 }
198
199 static inline int tipc_in_range(u16 val, u16 min, u16 max)
200 {
201 return !less(val, min) && !more(val, max);
202 }
203
204 static inline u32 tipc_net_hash_mixes(struct net *net, int tn_rand)
205 {
206 return net_hash_mix(&init_net) ^ net_hash_mix(net) ^ tn_rand;
207 }
208
209 static inline u32 hash128to32(char *bytes)
210 {
211 __be32 *tmp = (__be32 *)bytes;
212 u32 res;
213
214 res = ntohl(tmp[0] ^ tmp[1] ^ tmp[2] ^ tmp[3]);
215 if (likely(res))
216 return res;
217 return ntohl(tmp[0] | tmp[1] | tmp[2] | tmp[3]);
218 }
219
220 #ifdef CONFIG_SYSCTL
221 int tipc_register_sysctl(void);
222 void tipc_unregister_sysctl(void);
223 #else
224 #define tipc_register_sysctl() 0
225 #define tipc_unregister_sysctl()
226 #endif
227 #endif
228
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.