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