xref: /openbmc/linux/net/tipc/core.h (revision 680ef72a)
1 /*
2  * net/tipc/core.h: Include file for TIPC global declarations
3  *
4  * Copyright (c) 2005-2006, 2013 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 <asm/hardirq.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 
63 struct tipc_node;
64 struct tipc_bearer;
65 struct tipc_bc_base;
66 struct tipc_link;
67 struct tipc_name_table;
68 struct tipc_server;
69 struct tipc_monitor;
70 
71 #define TIPC_MOD_VER "2.0.0"
72 
73 #define NODE_HTABLE_SIZE       512
74 #define MAX_BEARERS	         3
75 #define TIPC_DEF_MON_THRESHOLD  32
76 
77 extern unsigned int tipc_net_id __read_mostly;
78 extern int sysctl_tipc_rmem[3] __read_mostly;
79 extern int sysctl_tipc_named_timeout __read_mostly;
80 
81 struct tipc_net {
82 	u32 own_addr;
83 	int net_id;
84 	int random;
85 
86 	/* Node table and node list */
87 	spinlock_t node_list_lock;
88 	struct hlist_head node_htable[NODE_HTABLE_SIZE];
89 	struct list_head node_list;
90 	u32 num_nodes;
91 	u32 num_links;
92 
93 	/* Neighbor monitoring list */
94 	struct tipc_monitor *monitors[MAX_BEARERS];
95 	int mon_threshold;
96 
97 	/* Bearer list */
98 	struct tipc_bearer __rcu *bearer_list[MAX_BEARERS + 1];
99 
100 	/* Broadcast link */
101 	spinlock_t bclock;
102 	struct tipc_bc_base *bcbase;
103 	struct tipc_link *bcl;
104 
105 	/* Socket hash table */
106 	struct rhashtable sk_rht;
107 
108 	/* Name table */
109 	spinlock_t nametbl_lock;
110 	struct name_table *nametbl;
111 
112 	/* Name dist queue */
113 	struct list_head dist_queue;
114 
115 	/* Topology subscription server */
116 	struct tipc_server *topsrv;
117 	atomic_t subscription_count;
118 };
119 
120 static inline struct tipc_net *tipc_net(struct net *net)
121 {
122 	return net_generic(net, tipc_net_id);
123 }
124 
125 static inline int tipc_netid(struct net *net)
126 {
127 	return tipc_net(net)->net_id;
128 }
129 
130 static inline struct list_head *tipc_nodes(struct net *net)
131 {
132 	return &tipc_net(net)->node_list;
133 }
134 
135 static inline struct tipc_server *tipc_topsrv(struct net *net)
136 {
137 	return tipc_net(net)->topsrv;
138 }
139 
140 static inline unsigned int tipc_hashfn(u32 addr)
141 {
142 	return addr & (NODE_HTABLE_SIZE - 1);
143 }
144 
145 static inline u16 mod(u16 x)
146 {
147 	return x & 0xffffu;
148 }
149 
150 static inline int less_eq(u16 left, u16 right)
151 {
152 	return mod(right - left) < 32768u;
153 }
154 
155 static inline int more(u16 left, u16 right)
156 {
157 	return !less_eq(left, right);
158 }
159 
160 static inline int less(u16 left, u16 right)
161 {
162 	return less_eq(left, right) && (mod(right) != mod(left));
163 }
164 
165 static inline int in_range(u16 val, u16 min, u16 max)
166 {
167 	return !less(val, min) && !more(val, max);
168 }
169 
170 #ifdef CONFIG_SYSCTL
171 int tipc_register_sysctl(void);
172 void tipc_unregister_sysctl(void);
173 #else
174 #define tipc_register_sysctl() 0
175 #define tipc_unregister_sysctl()
176 #endif
177 #endif
178