xref: /kernel/linux/linux-5.10/net/tipc/core.h (revision 8c2ecf20)
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
70struct tipc_node;
71struct tipc_bearer;
72struct tipc_bc_base;
73struct tipc_link;
74struct tipc_name_table;
75struct tipc_topsrv;
76struct tipc_monitor;
77#ifdef CONFIG_TIPC_CRYPTO
78struct 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
89extern unsigned int tipc_net_id __read_mostly;
90extern int sysctl_tipc_rmem[3] __read_mostly;
91extern int sysctl_tipc_named_timeout __read_mostly;
92
93struct 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	/* Name dist queue */
130	struct list_head dist_queue;
131
132	/* Topology subscription server */
133	struct tipc_topsrv *topsrv;
134	atomic_t subscription_count;
135
136	/* Cluster capabilities */
137	u16 capabilities;
138
139	/* Tracing of node internal messages */
140	struct packet_type loopback_pt;
141
142#ifdef CONFIG_TIPC_CRYPTO
143	/* TX crypto handler */
144	struct tipc_crypto *crypto_tx;
145#endif
146	/* Work item for net finalize */
147	struct work_struct work;
148	/* The numbers of work queues in schedule */
149	atomic_t wq_count;
150};
151
152static inline struct tipc_net *tipc_net(struct net *net)
153{
154	return net_generic(net, tipc_net_id);
155}
156
157static inline int tipc_netid(struct net *net)
158{
159	return tipc_net(net)->net_id;
160}
161
162static inline struct list_head *tipc_nodes(struct net *net)
163{
164	return &tipc_net(net)->node_list;
165}
166
167static inline struct name_table *tipc_name_table(struct net *net)
168{
169	return tipc_net(net)->nametbl;
170}
171
172static inline struct tipc_topsrv *tipc_topsrv(struct net *net)
173{
174	return tipc_net(net)->topsrv;
175}
176
177static inline unsigned int tipc_hashfn(u32 addr)
178{
179	return addr & (NODE_HTABLE_SIZE - 1);
180}
181
182static inline u16 mod(u16 x)
183{
184	return x & 0xffffu;
185}
186
187static inline int less_eq(u16 left, u16 right)
188{
189	return mod(right - left) < 32768u;
190}
191
192static inline int more(u16 left, u16 right)
193{
194	return !less_eq(left, right);
195}
196
197static inline int less(u16 left, u16 right)
198{
199	return less_eq(left, right) && (mod(right) != mod(left));
200}
201
202static inline int in_range(u16 val, u16 min, u16 max)
203{
204	return !less(val, min) && !more(val, max);
205}
206
207static inline u32 tipc_net_hash_mixes(struct net *net, int tn_rand)
208{
209	return net_hash_mix(&init_net) ^ net_hash_mix(net) ^ tn_rand;
210}
211
212#ifdef CONFIG_SYSCTL
213int tipc_register_sysctl(void);
214void tipc_unregister_sysctl(void);
215#else
216#define tipc_register_sysctl() 0
217#define tipc_unregister_sysctl()
218#endif
219#endif
220