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