blob: f7c8223ddf7dd0f3e9ce9c148e2cca1d1915cb3f [file] [log] [blame]
Per Lidenb97bf3f2006-01-02 19:04:38 +01001/*
2 * net/tipc/net.c: TIPC network routing code
3 *
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
52/*
53 * The TIPC locking policy is designed to ensure a very fine locking
54 * granularity, permitting complete parallel access to individual
55 * port and node/link instances. The code consists of three major
56 * locking domains, each protected with their own disjunct set of locks.
57 *
58 * 1: The routing hierarchy.
59 * Comprises the structures 'zone', 'cluster', 'node', 'link'
60 * and 'bearer'. The whole hierarchy is protected by a big
Per Liden4323add2006-01-18 00:38:21 +010061 * read/write lock, tipc_net_lock, to enssure that nothing is added
Per Lidenb97bf3f2006-01-02 19:04:38 +010062 * or removed while code is accessing any of these structures.
63 * This layer must not be called from the two others while they
64 * 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 *
Per Liden4323add2006-01-18 00:38:21 +010068 * 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
Per Liden4323add2006-01-18 00:38:21 +010071 * 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
73 * 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
76 * or a node from the overall structure.
77 * Correspondingly, individual bearers may change status within a
Per Liden4323add2006-01-18 00:38:21 +010078 * tipc_net_lock(read), protected by an individual spin_lock ber bearer
79 * instance, but it needs tipc_net_lock(write) to remove/add any bearers.
Per Lidenb97bf3f2006-01-02 19:04:38 +010080 *
81 *
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).
86 *
87 * This layer has four different locks:
88 * - The tipc_port spin_lock. This is protecting each port instance
89 * from parallel data access and removal. Since we can not place
90 * this lock in the port itself, it has been placed in the
91 * corresponding reference table entry, which has the same life
92 * 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
95 * only.
96 * - 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
98 * well be changed to a spin_lock)
99 * - A spin lock to protect the registry of kernel/driver users (reg.c)
Per Liden4323add2006-01-18 00:38:21 +0100100 * - 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.
105 *
106 * 3: The name table (name_table.c, name_distr.c, subscription.c)
Per Liden4323add2006-01-18 00:38:21 +0100107 * - There is one big read/write-lock (tipc_nametbl_lock) protecting the
Per Lidenb97bf3f2006-01-02 19:04:38 +0100108 * overall name table structure. Nothing must be added/removed to
109 * 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
Per Liden4323add2006-01-18 00:38:21 +0100118rwlock_t tipc_net_lock = RW_LOCK_UNLOCKED;
Sam Ravnborg1fc54d82006-03-20 22:36:47 -0800119struct network tipc_net = { NULL };
Per Lidenb97bf3f2006-01-02 19:04:38 +0100120
Per Liden4323add2006-01-18 00:38:21 +0100121struct 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{
163 u32 sz = sizeof(struct _zone *) * (tipc_max_zones + 1);
164
Per Liden4323add2006-01-18 00:38:21 +0100165 memset(&tipc_net, 0, sizeof(tipc_net));
166 tipc_net.zones = (struct _zone **)kmalloc(sz, GFP_ATOMIC);
167 if (!tipc_net.zones) {
Per Lidenb97bf3f2006-01-02 19:04:38 +0100168 return -ENOMEM;
169 }
Per Liden4323add2006-01-18 00:38:21 +0100170 memset(tipc_net.zones, 0, sz);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100171 return TIPC_OK;
172}
173
Per Liden4323add2006-01-18 00:38:21 +0100174static void net_stop(void)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100175{
176 u32 z_num;
177
Per Liden4323add2006-01-18 00:38:21 +0100178 if (!tipc_net.zones)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100179 return;
180
181 for (z_num = 1; z_num <= tipc_max_zones; z_num++) {
Per Liden4323add2006-01-18 00:38:21 +0100182 tipc_zone_delete(tipc_net.zones[z_num]);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100183 }
Per Liden4323add2006-01-18 00:38:21 +0100184 kfree(tipc_net.zones);
Sam Ravnborg1fc54d82006-03-20 22:36:47 -0800185 tipc_net.zones = NULL;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100186}
187
188static void net_route_named_msg(struct sk_buff *buf)
189{
190 struct tipc_msg *msg = buf_msg(buf);
191 u32 dnode;
192 u32 dport;
193
194 if (!msg_named(msg)) {
Per Liden4323add2006-01-18 00:38:21 +0100195 msg_dbg(msg, "tipc_net->drop_nam:");
Per Lidenb97bf3f2006-01-02 19:04:38 +0100196 buf_discard(buf);
197 return;
198 }
199
200 dnode = addr_domain(msg_lookup_scope(msg));
Per Liden4323add2006-01-18 00:38:21 +0100201 dport = tipc_nametbl_translate(msg_nametype(msg), msg_nameinst(msg), &dnode);
202 dbg("tipc_net->lookup<%u,%u>-><%u,%x>\n",
Per Lidenb97bf3f2006-01-02 19:04:38 +0100203 msg_nametype(msg), msg_nameinst(msg), dport, dnode);
204 if (dport) {
205 msg_set_destnode(msg, dnode);
206 msg_set_destport(msg, dport);
Per Liden4323add2006-01-18 00:38:21 +0100207 tipc_net_route_msg(buf);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100208 return;
209 }
Per Liden4323add2006-01-18 00:38:21 +0100210 msg_dbg(msg, "tipc_net->rej:NO NAME: ");
Per Lidenb97bf3f2006-01-02 19:04:38 +0100211 tipc_reject_msg(buf, TIPC_ERR_NO_NAME);
212}
213
Per Liden4323add2006-01-18 00:38:21 +0100214void tipc_net_route_msg(struct sk_buff *buf)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100215{
216 struct tipc_msg *msg;
217 u32 dnode;
218
219 if (!buf)
220 return;
221 msg = buf_msg(buf);
222
223 msg_incr_reroute_cnt(msg);
224 if (msg_reroute_cnt(msg) > 6) {
225 if (msg_errcode(msg)) {
226 msg_dbg(msg, "NET>DISC>:");
227 buf_discard(buf);
228 } else {
229 msg_dbg(msg, "NET>REJ>:");
230 tipc_reject_msg(buf, msg_destport(msg) ?
231 TIPC_ERR_NO_PORT : TIPC_ERR_NO_NAME);
232 }
233 return;
234 }
235
Per Liden4323add2006-01-18 00:38:21 +0100236 msg_dbg(msg, "tipc_net->rout: ");
Per Lidenb97bf3f2006-01-02 19:04:38 +0100237
238 /* Handle message for this node */
239 dnode = msg_short(msg) ? tipc_own_addr : msg_destnode(msg);
240 if (in_scope(dnode, tipc_own_addr)) {
241 if (msg_isdata(msg)) {
242 if (msg_mcast(msg))
Per Liden4323add2006-01-18 00:38:21 +0100243 tipc_port_recv_mcast(buf, NULL);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100244 else if (msg_destport(msg))
Per Liden4323add2006-01-18 00:38:21 +0100245 tipc_port_recv_msg(buf);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100246 else
247 net_route_named_msg(buf);
248 return;
249 }
250 switch (msg_user(msg)) {
251 case ROUTE_DISTRIBUTOR:
Per Liden4323add2006-01-18 00:38:21 +0100252 tipc_cltr_recv_routing_table(buf);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100253 break;
254 case NAME_DISTRIBUTOR:
Per Liden4323add2006-01-18 00:38:21 +0100255 tipc_named_recv(buf);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100256 break;
257 case CONN_MANAGER:
Per Liden4323add2006-01-18 00:38:21 +0100258 tipc_port_recv_proto_msg(buf);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100259 break;
260 default:
261 msg_dbg(msg,"DROP/NET/<REC<");
262 buf_discard(buf);
263 }
264 return;
265 }
266
267 /* Handle message for another node */
268 msg_dbg(msg, "NET>SEND>: ");
Per Liden4323add2006-01-18 00:38:21 +0100269 tipc_link_send(buf, dnode, msg_link_selector(msg));
Per Lidenb97bf3f2006-01-02 19:04:38 +0100270}
271
Per Liden4323add2006-01-18 00:38:21 +0100272int tipc_net_start(void)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100273{
274 char addr_string[16];
275 int res;
276
277 if (tipc_mode != TIPC_NODE_MODE)
278 return -ENOPROTOOPT;
279
280 tipc_mode = TIPC_NET_MODE;
Per Liden4323add2006-01-18 00:38:21 +0100281 tipc_named_reinit();
282 tipc_port_reinit();
Per Lidenb97bf3f2006-01-02 19:04:38 +0100283
Per Liden4323add2006-01-18 00:38:21 +0100284 if ((res = tipc_bearer_init()) ||
Per Lidenb97bf3f2006-01-02 19:04:38 +0100285 (res = net_init()) ||
Per Liden4323add2006-01-18 00:38:21 +0100286 (res = tipc_cltr_init()) ||
287 (res = tipc_bclink_init())) {
Per Lidenb97bf3f2006-01-02 19:04:38 +0100288 return res;
289 }
Per Liden4323add2006-01-18 00:38:21 +0100290 tipc_subscr_stop();
291 tipc_cfg_stop();
292 tipc_k_signal((Handler)tipc_subscr_start, 0);
293 tipc_k_signal((Handler)tipc_cfg_init, 0);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100294 info("Started in network mode\n");
295 info("Own node address %s, network identity %u\n",
296 addr_string_fill(addr_string, tipc_own_addr), tipc_net_id);
297 return TIPC_OK;
298}
299
Per Liden4323add2006-01-18 00:38:21 +0100300void tipc_net_stop(void)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100301{
302 if (tipc_mode != TIPC_NET_MODE)
303 return;
Per Liden4323add2006-01-18 00:38:21 +0100304 write_lock_bh(&tipc_net_lock);
305 tipc_bearer_stop();
Per Lidenb97bf3f2006-01-02 19:04:38 +0100306 tipc_mode = TIPC_NODE_MODE;
Per Liden4323add2006-01-18 00:38:21 +0100307 tipc_bclink_stop();
Per Lidenb97bf3f2006-01-02 19:04:38 +0100308 net_stop();
Per Liden4323add2006-01-18 00:38:21 +0100309 write_unlock_bh(&tipc_net_lock);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100310 info("Left network mode \n");
311}
312