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 * 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 #ifndef _TIPC_CORE_H
38 #define _TIPC_CORE_H
39
40 #include <linux/tipc.h>
41 #include <linux/tipc_config.h>
42 #include <linux/tipc_netlink.h>
43 #include <linux/types.h>
44 #include <linux/kernel.h>
45 #include <linux/errno.h>
46 #include <linux/mm.h>
47 #include <linux/timer.h>
48 #include <linux/string.h>
49 #include <linux/uaccess.h>
50 #include <linux/interrupt.h>
51 #include <linux/atomic.h>
52 #include <linux/netdevice.h>
53 #include <linux/in.h>
54 #include <linux/list.h>
55 #include <linux/slab.h>
56 #include <linux/vmalloc.h>
57 #include <linux/rtnetlink.h>
58 #include <linux/etherdevice.h>
59 #include <net/netns/generic.h>
60 #include <linux/rhashtable.h>
61 #include <net/genetlink.h>
62 #include <net/netns/hash.h>
63
64 #ifdef pr_fmt
65 #undef pr_fmt
66 #endif
67
68 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
69
70 struct tipc_node;
71 struct tipc_bearer;
72 struct tipc_bc_base;
73 struct tipc_link;
74 struct tipc_name_table;
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_work {
94 struct work_struct work;
95 struct net *net;
96 u32 addr;
97 };
98
99 struct tipc_net {
100 u8 node_id[NODE_ID_LEN];
101 u32 node_addr;
102 u32 trial_addr;
103 unsigned long addr_trial_end;
104 char node_id_string[NODE_ID_STR_LEN];
105 int net_id;
106 int random;
107 bool legacy_addr_format;
108
109 /* Node table and node list */
110 spinlock_t node_list_lock;
111 struct hlist_head node_htable[NODE_HTABLE_SIZE];
112 struct list_head node_list;
113 u32 num_nodes;
114 u32 num_links;
115
116 /* Neighbor monitoring list */
117 struct tipc_monitor *monitors[MAX_BEARERS];
118 int mon_threshold;
119
120 /* Bearer list */
121 struct tipc_bearer __rcu *bearer_list[MAX_BEARERS + 1];
122
123 /* Broadcast link */
124 spinlock_t bclock;
125 struct tipc_bc_base *bcbase;
126 struct tipc_link *bcl;
127
128 /* Socket hash table */
129 struct rhashtable sk_rht;
130
131 /* Name table */
132 spinlock_t nametbl_lock;
133 struct name_table *nametbl;
134
135 /* Name dist queue */
136 struct list_head dist_queue;
137
138 /* Topology subscription server */
139 struct tipc_topsrv *topsrv;
140 atomic_t subscription_count;
141
142 /* Cluster capabilities */
143 u16 capabilities;
144
145 /* Tracing of node internal messages */
146 struct packet_type loopback_pt;
147
148 #ifdef CONFIG_TIPC_CRYPTO
149 /* TX crypto handler */
150 struct tipc_crypto *crypto_tx;
151 #endif
152 /* Work item for net finalize */
153 struct tipc_net_work final_work;
154 };
155
tipc_net(struct net * net)156 static inline struct tipc_net *tipc_net(struct net *net)
157 {
158 return net_generic(net, tipc_net_id);
159 }
160
tipc_netid(struct net * net)161 static inline int tipc_netid(struct net *net)
162 {
163 return tipc_net(net)->net_id;
164 }
165
tipc_nodes(struct net * net)166 static inline struct list_head *tipc_nodes(struct net *net)
167 {
168 return &tipc_net(net)->node_list;
169 }
170
tipc_name_table(struct net * net)171 static inline struct name_table *tipc_name_table(struct net *net)
172 {
173 return tipc_net(net)->nametbl;
174 }
175
tipc_topsrv(struct net * net)176 static inline struct tipc_topsrv *tipc_topsrv(struct net *net)
177 {
178 return tipc_net(net)->topsrv;
179 }
180
tipc_hashfn(u32 addr)181 static inline unsigned int tipc_hashfn(u32 addr)
182 {
183 return addr & (NODE_HTABLE_SIZE - 1);
184 }
185
mod(u16 x)186 static inline u16 mod(u16 x)
187 {
188 return x & 0xffffu;
189 }
190
less_eq(u16 left,u16 right)191 static inline int less_eq(u16 left, u16 right)
192 {
193 return mod(right - left) < 32768u;
194 }
195
more(u16 left,u16 right)196 static inline int more(u16 left, u16 right)
197 {
198 return !less_eq(left, right);
199 }
200
less(u16 left,u16 right)201 static inline int less(u16 left, u16 right)
202 {
203 return less_eq(left, right) && (mod(right) != mod(left));
204 }
205
in_range(u16 val,u16 min,u16 max)206 static inline int in_range(u16 val, u16 min, u16 max)
207 {
208 return !less(val, min) && !more(val, max);
209 }
210
tipc_net_hash_mixes(struct net * net,int tn_rand)211 static inline u32 tipc_net_hash_mixes(struct net *net, int tn_rand)
212 {
213 return net_hash_mix(&init_net) ^ net_hash_mix(net) ^ tn_rand;
214 }
215
216 #ifdef CONFIG_SYSCTL
217 int tipc_register_sysctl(void);
218 void tipc_unregister_sysctl(void);
219 #else
220 #define tipc_register_sysctl() 0
221 #define tipc_unregister_sysctl()
222 #endif
223 #endif
224
