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