blob: c39c76201e8edb2bd343c68f4b5e6ce4de202c49 [file] [log] [blame]
Per Lidenb97bf3f2006-01-02 19:04:38 +01001/*
2 * net/tipc/net.c: TIPC network routing code
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +09003 *
Per Liden593a5f22006-01-11 19:14:19 +01004 * Copyright (c) 1995-2006, Ericsson AB
Per Lidenb97bf3f2006-01-02 19:04:38 +01005 * Copyright (c) 2005, Wind River Systems
Per Lidenb97bf3f2006-01-02 19:04:38 +01006 * 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 *
Per Liden9ea1fd32006-01-11 13:30:43 +010011 * 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.
Per Lidenb97bf3f2006-01-02 19:04:38 +010023 *
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 "core.h"
38#include "bearer.h"
39#include "net.h"
40#include "zone.h"
41#include "addr.h"
42#include "name_table.h"
43#include "name_distr.h"
44#include "subscr.h"
45#include "link.h"
46#include "msg.h"
47#include "port.h"
48#include "bcast.h"
49#include "discover.h"
50#include "config.h"
51
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090052/*
Per Lidenb97bf3f2006-01-02 19:04:38 +010053 * The TIPC locking policy is designed to ensure a very fine locking
54 * granularity, permitting complete parallel access to individual
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090055 * port and node/link instances. The code consists of three major
Per Lidenb97bf3f2006-01-02 19:04:38 +010056 * locking domains, each protected with their own disjunct set of locks.
57 *
58 * 1: The routing hierarchy.
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090059 * Comprises the structures 'zone', 'cluster', 'node', 'link'
60 * and 'bearer'. The whole hierarchy is protected by a big
61 * read/write lock, tipc_net_lock, to enssure that nothing is added
62 * or removed while code is accessing any of these structures.
63 * This layer must not be called from the two others while they
Per Lidenb97bf3f2006-01-02 19:04:38 +010064 * hold any of their own locks.
65 * Neither must it itself do any upcalls to the other two before
Per Liden4323add2006-01-18 00:38:21 +010066 * it has released tipc_net_lock and other protective locks.
Per Lidenb97bf3f2006-01-02 19:04:38 +010067 *
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090068 * Within the tipc_net_lock domain there are two sub-domains;'node' and
Per Lidenb97bf3f2006-01-02 19:04:38 +010069 * 'bearer', where local write operations are permitted,
70 * provided that those are protected by individual spin_locks
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090071 * per instance. Code holding tipc_net_lock(read) and a node spin_lock
Per Lidenb97bf3f2006-01-02 19:04:38 +010072 * is permitted to poke around in both the node itself and its
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090073 * subordinate links. I.e, it can update link counters and queues,
74 * change link state, send protocol messages, and alter the
75 * "active_links" array in the node; but it can _not_ remove a link
Per Lidenb97bf3f2006-01-02 19:04:38 +010076 * or a node from the overall structure.
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090077 * Correspondingly, individual bearers may change status within a
78 * tipc_net_lock(read), protected by an individual spin_lock ber bearer
Per Liden4323add2006-01-18 00:38:21 +010079 * instance, but it needs tipc_net_lock(write) to remove/add any bearers.
Per Lidenb97bf3f2006-01-02 19:04:38 +010080 *
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090081 *
82 * 2: The transport level of the protocol.
83 * This consists of the structures port, (and its user level
84 * representations, such as user_port and tipc_sock), reference and
85 * tipc_user (port.c, reg.c, socket.c).
Per Lidenb97bf3f2006-01-02 19:04:38 +010086 *
87 * This layer has four different locks:
88 * - The tipc_port spin_lock. This is protecting each port instance
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090089 * from parallel data access and removal. Since we can not place
90 * this lock in the port itself, it has been placed in the
Per Lidenb97bf3f2006-01-02 19:04:38 +010091 * corresponding reference table entry, which has the same life
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090092 * cycle as the module. This entry is difficult to access from
93 * outside the TIPC core, however, so a pointer to the lock has
94 * been added in the port instance, -to be used for unlocking
Per Lidenb97bf3f2006-01-02 19:04:38 +010095 * only.
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090096 * - A read/write lock to protect the reference table itself (teg.c).
97 * (Nobody is using read-only access to this, so it can just as
Per Lidenb97bf3f2006-01-02 19:04:38 +010098 * well be changed to a spin_lock)
99 * - A spin lock to protect the registry of kernel/driver users (reg.c)
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900100 * - A global spin_lock (tipc_port_lock), which only task is to ensure
Per Lidenb97bf3f2006-01-02 19:04:38 +0100101 * consistency where more than one port is involved in an operation,
102 * i.e., whe a port is part of a linked list of ports.
103 * There are two such lists; 'port_list', which is used for management,
104 * and 'wait_list', which is used to queue ports during congestion.
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900105 *
Per Lidenb97bf3f2006-01-02 19:04:38 +0100106 * 3: The name table (name_table.c, name_distr.c, subscription.c)
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900107 * - There is one big read/write-lock (tipc_nametbl_lock) protecting the
108 * overall name table structure. Nothing must be added/removed to
Per Lidenb97bf3f2006-01-02 19:04:38 +0100109 * this structure without holding write access to it.
110 * - There is one local spin_lock per sub_sequence, which can be seen
Per Liden4323add2006-01-18 00:38:21 +0100111 * as a sub-domain to the tipc_nametbl_lock domain. It is used only
Per Lidenb97bf3f2006-01-02 19:04:38 +0100112 * for translation operations, and is needed because a translation
113 * steps the root of the 'publication' linked list between each lookup.
Per Liden4323add2006-01-18 00:38:21 +0100114 * This is always used within the scope of a tipc_nametbl_lock(read).
Per Lidenb97bf3f2006-01-02 19:04:38 +0100115 * - A local spin_lock protecting the queue of subscriber events.
116*/
117
Ingo Molnar34af9462006-06-27 02:53:55 -0700118DEFINE_RWLOCK(tipc_net_lock);
Sam Ravnborg1fc54d82006-03-20 22:36:47 -0800119struct network tipc_net = { NULL };
Per Lidenb97bf3f2006-01-02 19:04:38 +0100120
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900121struct node *tipc_net_select_remote_node(u32 addr, u32 ref)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100122{
Per Liden4323add2006-01-18 00:38:21 +0100123 return tipc_zone_select_remote_node(tipc_net.zones[tipc_zone(addr)], addr, ref);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100124}
125
Per Liden4323add2006-01-18 00:38:21 +0100126u32 tipc_net_select_router(u32 addr, u32 ref)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100127{
Per Liden4323add2006-01-18 00:38:21 +0100128 return tipc_zone_select_router(tipc_net.zones[tipc_zone(addr)], addr, ref);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100129}
130
Adrian Bunk988f0882006-03-20 22:37:52 -0800131#if 0
Per Liden4323add2006-01-18 00:38:21 +0100132u32 tipc_net_next_node(u32 a)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100133{
Per Liden4323add2006-01-18 00:38:21 +0100134 if (tipc_net.zones[tipc_zone(a)])
135 return tipc_zone_next_node(a);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100136 return 0;
137}
Adrian Bunk988f0882006-03-20 22:37:52 -0800138#endif
Per Lidenb97bf3f2006-01-02 19:04:38 +0100139
Per Liden4323add2006-01-18 00:38:21 +0100140void tipc_net_remove_as_router(u32 router)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100141{
142 u32 z_num;
143
144 for (z_num = 1; z_num <= tipc_max_zones; z_num++) {
Per Liden4323add2006-01-18 00:38:21 +0100145 if (!tipc_net.zones[z_num])
Per Lidenb97bf3f2006-01-02 19:04:38 +0100146 continue;
Per Liden4323add2006-01-18 00:38:21 +0100147 tipc_zone_remove_as_router(tipc_net.zones[z_num], router);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100148 }
149}
150
Per Liden4323add2006-01-18 00:38:21 +0100151void tipc_net_send_external_routes(u32 dest)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100152{
153 u32 z_num;
154
155 for (z_num = 1; z_num <= tipc_max_zones; z_num++) {
Per Liden4323add2006-01-18 00:38:21 +0100156 if (tipc_net.zones[z_num])
157 tipc_zone_send_external_routes(tipc_net.zones[z_num], dest);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100158 }
159}
160
Per Liden4323add2006-01-18 00:38:21 +0100161static int net_init(void)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100162{
Per Liden4323add2006-01-18 00:38:21 +0100163 memset(&tipc_net, 0, sizeof(tipc_net));
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700164 tipc_net.zones = kcalloc(tipc_max_zones + 1, sizeof(struct _zone *), GFP_ATOMIC);
Per Liden4323add2006-01-18 00:38:21 +0100165 if (!tipc_net.zones) {
Per Lidenb97bf3f2006-01-02 19:04:38 +0100166 return -ENOMEM;
167 }
Per Lidenb97bf3f2006-01-02 19:04:38 +0100168 return TIPC_OK;
169}
170
Per Liden4323add2006-01-18 00:38:21 +0100171static void net_stop(void)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100172{
173 u32 z_num;
174
Per Liden4323add2006-01-18 00:38:21 +0100175 if (!tipc_net.zones)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100176 return;
177
178 for (z_num = 1; z_num <= tipc_max_zones; z_num++) {
Per Liden4323add2006-01-18 00:38:21 +0100179 tipc_zone_delete(tipc_net.zones[z_num]);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100180 }
Per Liden4323add2006-01-18 00:38:21 +0100181 kfree(tipc_net.zones);
Sam Ravnborg1fc54d82006-03-20 22:36:47 -0800182 tipc_net.zones = NULL;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100183}
184
185static void net_route_named_msg(struct sk_buff *buf)
186{
187 struct tipc_msg *msg = buf_msg(buf);
188 u32 dnode;
189 u32 dport;
190
191 if (!msg_named(msg)) {
Per Liden4323add2006-01-18 00:38:21 +0100192 msg_dbg(msg, "tipc_net->drop_nam:");
Per Lidenb97bf3f2006-01-02 19:04:38 +0100193 buf_discard(buf);
194 return;
195 }
196
197 dnode = addr_domain(msg_lookup_scope(msg));
Per Liden4323add2006-01-18 00:38:21 +0100198 dport = tipc_nametbl_translate(msg_nametype(msg), msg_nameinst(msg), &dnode);
199 dbg("tipc_net->lookup<%u,%u>-><%u,%x>\n",
Per Lidenb97bf3f2006-01-02 19:04:38 +0100200 msg_nametype(msg), msg_nameinst(msg), dport, dnode);
201 if (dport) {
202 msg_set_destnode(msg, dnode);
203 msg_set_destport(msg, dport);
Per Liden4323add2006-01-18 00:38:21 +0100204 tipc_net_route_msg(buf);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100205 return;
206 }
Per Liden4323add2006-01-18 00:38:21 +0100207 msg_dbg(msg, "tipc_net->rej:NO NAME: ");
Per Lidenb97bf3f2006-01-02 19:04:38 +0100208 tipc_reject_msg(buf, TIPC_ERR_NO_NAME);
209}
210
Per Liden4323add2006-01-18 00:38:21 +0100211void tipc_net_route_msg(struct sk_buff *buf)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100212{
213 struct tipc_msg *msg;
214 u32 dnode;
215
216 if (!buf)
217 return;
218 msg = buf_msg(buf);
219
220 msg_incr_reroute_cnt(msg);
221 if (msg_reroute_cnt(msg) > 6) {
222 if (msg_errcode(msg)) {
223 msg_dbg(msg, "NET>DISC>:");
224 buf_discard(buf);
225 } else {
226 msg_dbg(msg, "NET>REJ>:");
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900227 tipc_reject_msg(buf, msg_destport(msg) ?
Per Lidenb97bf3f2006-01-02 19:04:38 +0100228 TIPC_ERR_NO_PORT : TIPC_ERR_NO_NAME);
229 }
230 return;
231 }
232
Per Liden4323add2006-01-18 00:38:21 +0100233 msg_dbg(msg, "tipc_net->rout: ");
Per Lidenb97bf3f2006-01-02 19:04:38 +0100234
235 /* Handle message for this node */
236 dnode = msg_short(msg) ? tipc_own_addr : msg_destnode(msg);
237 if (in_scope(dnode, tipc_own_addr)) {
238 if (msg_isdata(msg)) {
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900239 if (msg_mcast(msg))
Per Liden4323add2006-01-18 00:38:21 +0100240 tipc_port_recv_mcast(buf, NULL);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100241 else if (msg_destport(msg))
Per Liden4323add2006-01-18 00:38:21 +0100242 tipc_port_recv_msg(buf);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100243 else
244 net_route_named_msg(buf);
245 return;
246 }
247 switch (msg_user(msg)) {
248 case ROUTE_DISTRIBUTOR:
Per Liden4323add2006-01-18 00:38:21 +0100249 tipc_cltr_recv_routing_table(buf);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100250 break;
251 case NAME_DISTRIBUTOR:
Per Liden4323add2006-01-18 00:38:21 +0100252 tipc_named_recv(buf);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100253 break;
254 case CONN_MANAGER:
Per Liden4323add2006-01-18 00:38:21 +0100255 tipc_port_recv_proto_msg(buf);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100256 break;
257 default:
258 msg_dbg(msg,"DROP/NET/<REC<");
259 buf_discard(buf);
260 }
261 return;
262 }
263
264 /* Handle message for another node */
265 msg_dbg(msg, "NET>SEND>: ");
Per Liden4323add2006-01-18 00:38:21 +0100266 tipc_link_send(buf, dnode, msg_link_selector(msg));
Per Lidenb97bf3f2006-01-02 19:04:38 +0100267}
268
Per Liden4323add2006-01-18 00:38:21 +0100269int tipc_net_start(void)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100270{
271 char addr_string[16];
272 int res;
273
274 if (tipc_mode != TIPC_NODE_MODE)
275 return -ENOPROTOOPT;
276
277 tipc_mode = TIPC_NET_MODE;
Per Liden4323add2006-01-18 00:38:21 +0100278 tipc_named_reinit();
279 tipc_port_reinit();
Per Lidenb97bf3f2006-01-02 19:04:38 +0100280
Per Liden4323add2006-01-18 00:38:21 +0100281 if ((res = tipc_bearer_init()) ||
Per Lidenb97bf3f2006-01-02 19:04:38 +0100282 (res = net_init()) ||
Per Liden4323add2006-01-18 00:38:21 +0100283 (res = tipc_cltr_init()) ||
284 (res = tipc_bclink_init())) {
Per Lidenb97bf3f2006-01-02 19:04:38 +0100285 return res;
286 }
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900287 tipc_subscr_stop();
Per Liden4323add2006-01-18 00:38:21 +0100288 tipc_cfg_stop();
289 tipc_k_signal((Handler)tipc_subscr_start, 0);
290 tipc_k_signal((Handler)tipc_cfg_init, 0);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100291 info("Started in network mode\n");
292 info("Own node address %s, network identity %u\n",
293 addr_string_fill(addr_string, tipc_own_addr), tipc_net_id);
294 return TIPC_OK;
295}
296
Per Liden4323add2006-01-18 00:38:21 +0100297void tipc_net_stop(void)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100298{
299 if (tipc_mode != TIPC_NET_MODE)
300 return;
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900301 write_lock_bh(&tipc_net_lock);
Per Liden4323add2006-01-18 00:38:21 +0100302 tipc_bearer_stop();
Per Lidenb97bf3f2006-01-02 19:04:38 +0100303 tipc_mode = TIPC_NODE_MODE;
Per Liden4323add2006-01-18 00:38:21 +0100304 tipc_bclink_stop();
Per Lidenb97bf3f2006-01-02 19:04:38 +0100305 net_stop();
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900306 write_unlock_bh(&tipc_net_lock);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100307 info("Left network mode \n");
308}
309