xref: /linux/net/tipc/core.h (revision 4d66c56f7efe122d09d06cd3ebfa52a43d51a9cb)
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 struct tipc_node;
65 struct tipc_bearer;
66 struct tipc_bc_base;
67 struct tipc_link;
68 struct tipc_name_table;
69 struct tipc_topsrv;
70 struct tipc_monitor;
71 #ifdef CONFIG_TIPC_CRYPTO
72 struct tipc_crypto;
73 #endif
74 
75 #define TIPC_MOD_VER "2.0.0"
76 
77 #define NODE_HTABLE_SIZE       512
78 #define MAX_BEARERS	         3
79 #define TIPC_DEF_MON_THRESHOLD  32
80 #define NODE_ID_LEN             16
81 #define NODE_ID_STR_LEN        (NODE_ID_LEN * 2 + 1)
82 
83 extern unsigned int tipc_net_id __read_mostly;
84 extern int sysctl_tipc_rmem[3] __read_mostly;
85 extern int sysctl_tipc_named_timeout __read_mostly;
86 
87 struct tipc_net {
88 	u8  node_id[NODE_ID_LEN];
89 	u32 node_addr;
90 	u32 trial_addr;
91 	unsigned long addr_trial_end;
92 	char node_id_string[NODE_ID_STR_LEN];
93 	int net_id;
94 	int random;
95 	bool legacy_addr_format;
96 
97 	/* Node table and node list */
98 	spinlock_t node_list_lock;
99 	struct hlist_head node_htable[NODE_HTABLE_SIZE];
100 	struct list_head node_list;
101 	u32 num_nodes;
102 	u32 num_links;
103 
104 	/* Neighbor monitoring list */
105 	struct tipc_monitor *monitors[MAX_BEARERS];
106 	int mon_threshold;
107 
108 	/* Bearer list */
109 	struct tipc_bearer __rcu *bearer_list[MAX_BEARERS + 1];
110 
111 	/* Broadcast link */
112 	spinlock_t bclock;
113 	struct tipc_bc_base *bcbase;
114 	struct tipc_link *bcl;
115 
116 	/* Socket hash table */
117 	struct rhashtable sk_rht;
118 
119 	/* Name table */
120 	spinlock_t nametbl_lock;
121 	struct name_table *nametbl;
122 
123 	/* Name dist queue */
124 	struct list_head dist_queue;
125 
126 	/* Topology subscription server */
127 	struct tipc_topsrv *topsrv;
128 	atomic_t subscription_count;
129 
130 	/* Cluster capabilities */
131 	u16 capabilities;
132 
133 	/* Tracing of node internal messages */
134 	struct packet_type loopback_pt;
135 
136 #ifdef CONFIG_TIPC_CRYPTO
137 	/* TX crypto handler */
138 	struct tipc_crypto *crypto_tx;
139 #endif
140 };
141 
142 static inline struct tipc_net *tipc_net(struct net *net)
143 {
144 	return net_generic(net, tipc_net_id);
145 }
146 
147 static inline int tipc_netid(struct net *net)
148 {
149 	return tipc_net(net)->net_id;
150 }
151 
152 static inline struct list_head *tipc_nodes(struct net *net)
153 {
154 	return &tipc_net(net)->node_list;
155 }
156 
157 static inline struct name_table *tipc_name_table(struct net *net)
158 {
159 	return tipc_net(net)->nametbl;
160 }
161 
162 static inline struct tipc_topsrv *tipc_topsrv(struct net *net)
163 {
164 	return tipc_net(net)->topsrv;
165 }
166 
167 static inline unsigned int tipc_hashfn(u32 addr)
168 {
169 	return addr & (NODE_HTABLE_SIZE - 1);
170 }
171 
172 static inline u16 mod(u16 x)
173 {
174 	return x & 0xffffu;
175 }
176 
177 static inline int less_eq(u16 left, u16 right)
178 {
179 	return mod(right - left) < 32768u;
180 }
181 
182 static inline int more(u16 left, u16 right)
183 {
184 	return !less_eq(left, right);
185 }
186 
187 static inline int less(u16 left, u16 right)
188 {
189 	return less_eq(left, right) && (mod(right) != mod(left));
190 }
191 
192 static inline int in_range(u16 val, u16 min, u16 max)
193 {
194 	return !less(val, min) && !more(val, max);
195 }
196 
197 static inline u32 tipc_net_hash_mixes(struct net *net, int tn_rand)
198 {
199 	return net_hash_mix(&init_net) ^ net_hash_mix(net) ^ tn_rand;
200 }
201 
202 #ifdef CONFIG_SYSCTL
203 int tipc_register_sysctl(void);
204 void tipc_unregister_sysctl(void);
205 #else
206 #define tipc_register_sysctl() 0
207 #define tipc_unregister_sysctl()
208 #endif
209 #endif
210