xref: /linux/net/tipc/core.c (revision d39d0ed196aa1685bb24771e92f78633c66ac9cb)
1 /*
2  * net/tipc/core.c: TIPC module code
3  *
4  * Copyright (c) 2003-2006, Ericsson AB
5  * Copyright (c) 2005-2006, 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 #include <linux/init.h>
38 #include <linux/module.h>
39 #include <linux/kernel.h>
40 #include <linux/random.h>
41 
42 #include "core.h"
43 #include "dbg.h"
44 #include "ref.h"
45 #include "net.h"
46 #include "user_reg.h"
47 #include "name_table.h"
48 #include "subscr.h"
49 #include "config.h"
50 
51 
52 #ifndef CONFIG_TIPC_ZONES
53 #define CONFIG_TIPC_ZONES 3
54 #endif
55 
56 #ifndef CONFIG_TIPC_CLUSTERS
57 #define CONFIG_TIPC_CLUSTERS 1
58 #endif
59 
60 #ifndef CONFIG_TIPC_NODES
61 #define CONFIG_TIPC_NODES 255
62 #endif
63 
64 #ifndef CONFIG_TIPC_SLAVE_NODES
65 #define CONFIG_TIPC_SLAVE_NODES 0
66 #endif
67 
68 #ifndef CONFIG_TIPC_PORTS
69 #define CONFIG_TIPC_PORTS 8191
70 #endif
71 
72 #ifndef CONFIG_TIPC_LOG
73 #define CONFIG_TIPC_LOG 0
74 #endif
75 
76 /* global variables used by multiple sub-systems within TIPC */
77 
78 int tipc_mode = TIPC_NOT_RUNNING;
79 int tipc_random;
80 atomic_t tipc_user_count = ATOMIC_INIT(0);
81 
82 const char tipc_alphabet[] =
83 	"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789_.";
84 
85 /* configurable TIPC parameters */
86 
87 u32 tipc_own_addr;
88 int tipc_max_zones;
89 int tipc_max_clusters;
90 int tipc_max_nodes;
91 int tipc_max_slaves;
92 int tipc_max_ports;
93 int tipc_max_subscriptions;
94 int tipc_max_publications;
95 int tipc_net_id;
96 int tipc_remote_management;
97 
98 
99 int tipc_get_mode(void)
100 {
101 	return tipc_mode;
102 }
103 
104 /**
105  * buf_acquire - creates a TIPC message buffer
106  * @size: message size (including TIPC header)
107  *
108  * Returns a new buffer with data pointers set to the specified size.
109  *
110  * NOTE: Headroom is reserved to allow prepending of a data link header.
111  *       There may also be unrequested tailroom present at the buffer's end.
112  */
113 
114 struct sk_buff *buf_acquire(u32 size)
115 {
116 	struct sk_buff *skb;
117 	unsigned int buf_size = (BUF_HEADROOM + size + 3) & ~3u;
118 
119 	skb = alloc_skb_fclone(buf_size, GFP_ATOMIC);
120 	if (skb) {
121 		skb_reserve(skb, BUF_HEADROOM);
122 		skb_put(skb, size);
123 		skb->next = NULL;
124 	}
125 	return skb;
126 }
127 
128 /**
129  * tipc_core_stop_net - shut down TIPC networking sub-systems
130  */
131 
132 void tipc_core_stop_net(void)
133 {
134 	tipc_eth_media_stop();
135 	tipc_net_stop();
136 }
137 
138 /**
139  * start_net - start TIPC networking sub-systems
140  */
141 
142 int tipc_core_start_net(unsigned long addr)
143 {
144 	int res;
145 
146 	if ((res = tipc_net_start(addr)) ||
147 	    (res = tipc_eth_media_start())) {
148 		tipc_core_stop_net();
149 	}
150 	return res;
151 }
152 
153 /**
154  * tipc_core_stop - switch TIPC from SINGLE NODE to NOT RUNNING mode
155  */
156 
157 void tipc_core_stop(void)
158 {
159 	if (tipc_mode != TIPC_NODE_MODE)
160 		return;
161 
162 	tipc_mode = TIPC_NOT_RUNNING;
163 
164 	tipc_netlink_stop();
165 	tipc_handler_stop();
166 	tipc_cfg_stop();
167 	tipc_subscr_stop();
168 	tipc_reg_stop();
169 	tipc_nametbl_stop();
170 	tipc_ref_table_stop();
171 	tipc_socket_stop();
172 }
173 
174 /**
175  * tipc_core_start - switch TIPC from NOT RUNNING to SINGLE NODE mode
176  */
177 
178 int tipc_core_start(void)
179 {
180 	int res;
181 
182 	if (tipc_mode != TIPC_NOT_RUNNING)
183 		return -ENOPROTOOPT;
184 
185 	get_random_bytes(&tipc_random, sizeof(tipc_random));
186 	tipc_mode = TIPC_NODE_MODE;
187 
188 	if ((res = tipc_handler_start()) ||
189 	    (res = tipc_ref_table_init(tipc_max_ports, tipc_random)) ||
190 	    (res = tipc_reg_start()) ||
191 	    (res = tipc_nametbl_init()) ||
192 	    (res = tipc_k_signal((Handler)tipc_subscr_start, 0)) ||
193 	    (res = tipc_k_signal((Handler)tipc_cfg_init, 0)) ||
194 	    (res = tipc_netlink_start()) ||
195 	    (res = tipc_socket_init())) {
196 		tipc_core_stop();
197 	}
198 	return res;
199 }
200 
201 
202 static int __init tipc_init(void)
203 {
204 	int res;
205 
206 	tipc_log_resize(CONFIG_TIPC_LOG);
207 	info("Activated (version " TIPC_MOD_VER
208 	     " compiled " __DATE__ " " __TIME__ ")\n");
209 
210 	tipc_own_addr = 0;
211 	tipc_remote_management = 1;
212 	tipc_max_publications = 10000;
213 	tipc_max_subscriptions = 2000;
214 	tipc_max_ports = CONFIG_TIPC_PORTS;
215 	tipc_max_zones = CONFIG_TIPC_ZONES;
216 	tipc_max_clusters = CONFIG_TIPC_CLUSTERS;
217 	tipc_max_nodes = CONFIG_TIPC_NODES;
218 	tipc_max_slaves = CONFIG_TIPC_SLAVE_NODES;
219 	tipc_net_id = 4711;
220 
221 	if ((res = tipc_core_start()))
222 		err("Unable to start in single node mode\n");
223 	else
224 		info("Started in single node mode\n");
225 	return res;
226 }
227 
228 static void __exit tipc_exit(void)
229 {
230 	tipc_core_stop_net();
231 	tipc_core_stop();
232 	info("Deactivated\n");
233 	tipc_log_resize(0);
234 }
235 
236 module_init(tipc_init);
237 module_exit(tipc_exit);
238 
239 MODULE_DESCRIPTION("TIPC: Transparent Inter Process Communication");
240 MODULE_LICENSE("Dual BSD/GPL");
241 MODULE_VERSION(TIPC_MOD_VER);
242 
243 /* Native TIPC API for kernel-space applications (see tipc.h) */
244 
245 EXPORT_SYMBOL(tipc_attach);
246 EXPORT_SYMBOL(tipc_detach);
247 EXPORT_SYMBOL(tipc_get_addr);
248 EXPORT_SYMBOL(tipc_get_mode);
249 EXPORT_SYMBOL(tipc_createport);
250 EXPORT_SYMBOL(tipc_deleteport);
251 EXPORT_SYMBOL(tipc_ownidentity);
252 EXPORT_SYMBOL(tipc_portimportance);
253 EXPORT_SYMBOL(tipc_set_portimportance);
254 EXPORT_SYMBOL(tipc_portunreliable);
255 EXPORT_SYMBOL(tipc_set_portunreliable);
256 EXPORT_SYMBOL(tipc_portunreturnable);
257 EXPORT_SYMBOL(tipc_set_portunreturnable);
258 EXPORT_SYMBOL(tipc_publish);
259 EXPORT_SYMBOL(tipc_withdraw);
260 EXPORT_SYMBOL(tipc_connect2port);
261 EXPORT_SYMBOL(tipc_disconnect);
262 EXPORT_SYMBOL(tipc_shutdown);
263 EXPORT_SYMBOL(tipc_isconnected);
264 EXPORT_SYMBOL(tipc_peer);
265 EXPORT_SYMBOL(tipc_ref_valid);
266 EXPORT_SYMBOL(tipc_send);
267 EXPORT_SYMBOL(tipc_send_buf);
268 EXPORT_SYMBOL(tipc_send2name);
269 EXPORT_SYMBOL(tipc_forward2name);
270 EXPORT_SYMBOL(tipc_send_buf2name);
271 EXPORT_SYMBOL(tipc_forward_buf2name);
272 EXPORT_SYMBOL(tipc_send2port);
273 EXPORT_SYMBOL(tipc_forward2port);
274 EXPORT_SYMBOL(tipc_send_buf2port);
275 EXPORT_SYMBOL(tipc_forward_buf2port);
276 EXPORT_SYMBOL(tipc_multicast);
277 /* EXPORT_SYMBOL(tipc_multicast_buf); not available yet */
278 EXPORT_SYMBOL(tipc_ispublished);
279 EXPORT_SYMBOL(tipc_available_nodes);
280 
281 /* TIPC API for external bearers (see tipc_bearer.h) */
282 
283 EXPORT_SYMBOL(tipc_block_bearer);
284 EXPORT_SYMBOL(tipc_continue);
285 EXPORT_SYMBOL(tipc_disable_bearer);
286 EXPORT_SYMBOL(tipc_enable_bearer);
287 EXPORT_SYMBOL(tipc_recv_msg);
288 EXPORT_SYMBOL(tipc_register_media);
289 
290 /* TIPC API for external APIs (see tipc_port.h) */
291 
292 EXPORT_SYMBOL(tipc_createport_raw);
293 EXPORT_SYMBOL(tipc_reject_msg);
294 EXPORT_SYMBOL(tipc_send_buf_fast);
295 EXPORT_SYMBOL(tipc_acknowledge);
296 EXPORT_SYMBOL(tipc_get_port);
297 EXPORT_SYMBOL(tipc_get_handle);
298 
299