blob: 68b3dd6372912ad49e2d58b1368b6502a8543a3c [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
Allan Stephens9df3b7e2011-02-24 13:20:20 -05005 * Copyright (c) 2005, 2010-2011, 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"
Per Lidenb97bf3f2006-01-02 19:04:38 +010038#include "net.h"
Per Lidenb97bf3f2006-01-02 19:04:38 +010039#include "name_distr.h"
40#include "subscr.h"
Per Lidenb97bf3f2006-01-02 19:04:38 +010041#include "port.h"
Allan Stephens672d99e2011-02-25 18:42:52 -050042#include "node.h"
Per Lidenb97bf3f2006-01-02 19:04:38 +010043#include "config.h"
44
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090045/*
Per Lidenb97bf3f2006-01-02 19:04:38 +010046 * The TIPC locking policy is designed to ensure a very fine locking
47 * granularity, permitting complete parallel access to individual
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090048 * port and node/link instances. The code consists of three major
Per Lidenb97bf3f2006-01-02 19:04:38 +010049 * locking domains, each protected with their own disjunct set of locks.
50 *
51 * 1: The routing hierarchy.
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090052 * Comprises the structures 'zone', 'cluster', 'node', 'link'
53 * and 'bearer'. The whole hierarchy is protected by a big
54 * read/write lock, tipc_net_lock, to enssure that nothing is added
55 * or removed while code is accessing any of these structures.
56 * This layer must not be called from the two others while they
Per Lidenb97bf3f2006-01-02 19:04:38 +010057 * hold any of their own locks.
58 * Neither must it itself do any upcalls to the other two before
Per Liden4323add2006-01-18 00:38:21 +010059 * it has released tipc_net_lock and other protective locks.
Per Lidenb97bf3f2006-01-02 19:04:38 +010060 *
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090061 * Within the tipc_net_lock domain there are two sub-domains;'node' and
Per Lidenb97bf3f2006-01-02 19:04:38 +010062 * 'bearer', where local write operations are permitted,
63 * provided that those are protected by individual spin_locks
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090064 * per instance. Code holding tipc_net_lock(read) and a node spin_lock
Per Lidenb97bf3f2006-01-02 19:04:38 +010065 * is permitted to poke around in both the node itself and its
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090066 * subordinate links. I.e, it can update link counters and queues,
67 * change link state, send protocol messages, and alter the
68 * "active_links" array in the node; but it can _not_ remove a link
Per Lidenb97bf3f2006-01-02 19:04:38 +010069 * or a node from the overall structure.
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090070 * Correspondingly, individual bearers may change status within a
71 * tipc_net_lock(read), protected by an individual spin_lock ber bearer
Per Liden4323add2006-01-18 00:38:21 +010072 * instance, but it needs tipc_net_lock(write) to remove/add any bearers.
Per Lidenb97bf3f2006-01-02 19:04:38 +010073 *
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090074 *
75 * 2: The transport level of the protocol.
76 * This consists of the structures port, (and its user level
77 * representations, such as user_port and tipc_sock), reference and
78 * tipc_user (port.c, reg.c, socket.c).
Per Lidenb97bf3f2006-01-02 19:04:38 +010079 *
80 * This layer has four different locks:
81 * - The tipc_port spin_lock. This is protecting each port instance
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090082 * from parallel data access and removal. Since we can not place
83 * this lock in the port itself, it has been placed in the
Per Lidenb97bf3f2006-01-02 19:04:38 +010084 * corresponding reference table entry, which has the same life
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090085 * cycle as the module. This entry is difficult to access from
86 * outside the TIPC core, however, so a pointer to the lock has
87 * been added in the port instance, -to be used for unlocking
Per Lidenb97bf3f2006-01-02 19:04:38 +010088 * only.
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090089 * - A read/write lock to protect the reference table itself (teg.c).
90 * (Nobody is using read-only access to this, so it can just as
Per Lidenb97bf3f2006-01-02 19:04:38 +010091 * well be changed to a spin_lock)
92 * - A spin lock to protect the registry of kernel/driver users (reg.c)
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090093 * - A global spin_lock (tipc_port_lock), which only task is to ensure
Per Lidenb97bf3f2006-01-02 19:04:38 +010094 * consistency where more than one port is involved in an operation,
95 * i.e., whe a port is part of a linked list of ports.
96 * There are two such lists; 'port_list', which is used for management,
97 * and 'wait_list', which is used to queue ports during congestion.
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090098 *
Per Lidenb97bf3f2006-01-02 19:04:38 +010099 * 3: The name table (name_table.c, name_distr.c, subscription.c)
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900100 * - There is one big read/write-lock (tipc_nametbl_lock) protecting the
101 * overall name table structure. Nothing must be added/removed to
Per Lidenb97bf3f2006-01-02 19:04:38 +0100102 * this structure without holding write access to it.
103 * - There is one local spin_lock per sub_sequence, which can be seen
Per Liden4323add2006-01-18 00:38:21 +0100104 * as a sub-domain to the tipc_nametbl_lock domain. It is used only
Per Lidenb97bf3f2006-01-02 19:04:38 +0100105 * for translation operations, and is needed because a translation
106 * steps the root of the 'publication' linked list between each lookup.
Per Liden4323add2006-01-18 00:38:21 +0100107 * This is always used within the scope of a tipc_nametbl_lock(read).
Per Lidenb97bf3f2006-01-02 19:04:38 +0100108 * - A local spin_lock protecting the queue of subscriber events.
109*/
110
Ingo Molnar34af9462006-06-27 02:53:55 -0700111DEFINE_RWLOCK(tipc_net_lock);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100112
113static void net_route_named_msg(struct sk_buff *buf)
114{
115 struct tipc_msg *msg = buf_msg(buf);
116 u32 dnode;
117 u32 dport;
118
119 if (!msg_named(msg)) {
Per Lidenb97bf3f2006-01-02 19:04:38 +0100120 buf_discard(buf);
121 return;
122 }
123
124 dnode = addr_domain(msg_lookup_scope(msg));
Per Liden4323add2006-01-18 00:38:21 +0100125 dport = tipc_nametbl_translate(msg_nametype(msg), msg_nameinst(msg), &dnode);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100126 if (dport) {
127 msg_set_destnode(msg, dnode);
128 msg_set_destport(msg, dport);
Per Liden4323add2006-01-18 00:38:21 +0100129 tipc_net_route_msg(buf);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100130 return;
131 }
Per Lidenb97bf3f2006-01-02 19:04:38 +0100132 tipc_reject_msg(buf, TIPC_ERR_NO_NAME);
133}
134
Per Liden4323add2006-01-18 00:38:21 +0100135void tipc_net_route_msg(struct sk_buff *buf)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100136{
137 struct tipc_msg *msg;
138 u32 dnode;
139
140 if (!buf)
141 return;
142 msg = buf_msg(buf);
143
144 msg_incr_reroute_cnt(msg);
145 if (msg_reroute_cnt(msg) > 6) {
146 if (msg_errcode(msg)) {
Per Lidenb97bf3f2006-01-02 19:04:38 +0100147 buf_discard(buf);
148 } else {
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900149 tipc_reject_msg(buf, msg_destport(msg) ?
Per Lidenb97bf3f2006-01-02 19:04:38 +0100150 TIPC_ERR_NO_PORT : TIPC_ERR_NO_NAME);
151 }
152 return;
153 }
154
Per Lidenb97bf3f2006-01-02 19:04:38 +0100155 /* Handle message for this node */
156 dnode = msg_short(msg) ? tipc_own_addr : msg_destnode(msg);
Allan Stephensc68ca7b2010-05-11 14:30:12 +0000157 if (tipc_in_scope(dnode, tipc_own_addr)) {
Per Lidenb97bf3f2006-01-02 19:04:38 +0100158 if (msg_isdata(msg)) {
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900159 if (msg_mcast(msg))
Per Liden4323add2006-01-18 00:38:21 +0100160 tipc_port_recv_mcast(buf, NULL);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100161 else if (msg_destport(msg))
Per Liden4323add2006-01-18 00:38:21 +0100162 tipc_port_recv_msg(buf);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100163 else
164 net_route_named_msg(buf);
165 return;
166 }
167 switch (msg_user(msg)) {
Per Lidenb97bf3f2006-01-02 19:04:38 +0100168 case NAME_DISTRIBUTOR:
Per Liden4323add2006-01-18 00:38:21 +0100169 tipc_named_recv(buf);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100170 break;
171 case CONN_MANAGER:
Per Liden4323add2006-01-18 00:38:21 +0100172 tipc_port_recv_proto_msg(buf);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100173 break;
174 default:
Per Lidenb97bf3f2006-01-02 19:04:38 +0100175 buf_discard(buf);
176 }
177 return;
178 }
179
180 /* Handle message for another node */
Paul Gortmakerb2abd4c2010-09-08 13:31:24 +0000181 skb_trim(buf, msg_size(msg));
Per Liden4323add2006-01-18 00:38:21 +0100182 tipc_link_send(buf, dnode, msg_link_selector(msg));
Per Lidenb97bf3f2006-01-02 19:04:38 +0100183}
184
Allan Stephens03194372008-05-21 14:55:04 -0700185int tipc_net_start(u32 addr)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100186{
187 char addr_string[16];
188 int res;
189
190 if (tipc_mode != TIPC_NODE_MODE)
191 return -ENOPROTOOPT;
192
Allan Stephens03194372008-05-21 14:55:04 -0700193 tipc_subscr_stop();
194 tipc_cfg_stop();
195
196 tipc_own_addr = addr;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100197 tipc_mode = TIPC_NET_MODE;
Per Liden4323add2006-01-18 00:38:21 +0100198 tipc_named_reinit();
199 tipc_port_reinit();
Per Lidenb97bf3f2006-01-02 19:04:38 +0100200
Allan Stephens8f92df62010-12-31 18:59:19 +0000201 res = tipc_bclink_init();
202 if (res)
203 return res;
Allan Stephens03194372008-05-21 14:55:04 -0700204
Per Liden4323add2006-01-18 00:38:21 +0100205 tipc_k_signal((Handler)tipc_subscr_start, 0);
206 tipc_k_signal((Handler)tipc_cfg_init, 0);
Allan Stephens03194372008-05-21 14:55:04 -0700207
Per Lidenb97bf3f2006-01-02 19:04:38 +0100208 info("Started in network mode\n");
209 info("Own node address %s, network identity %u\n",
Allan Stephensc68ca7b2010-05-11 14:30:12 +0000210 tipc_addr_string_fill(addr_string, tipc_own_addr), tipc_net_id);
Allan Stephens0e35fd52008-07-14 22:44:01 -0700211 return 0;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100212}
213
Per Liden4323add2006-01-18 00:38:21 +0100214void tipc_net_stop(void)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100215{
Allan Stephens34e46252011-02-25 19:11:25 -0500216 struct tipc_node *node, *t_node;
217
Per Lidenb97bf3f2006-01-02 19:04:38 +0100218 if (tipc_mode != TIPC_NET_MODE)
219 return;
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900220 write_lock_bh(&tipc_net_lock);
Per Liden4323add2006-01-18 00:38:21 +0100221 tipc_bearer_stop();
Per Lidenb97bf3f2006-01-02 19:04:38 +0100222 tipc_mode = TIPC_NODE_MODE;
Per Liden4323add2006-01-18 00:38:21 +0100223 tipc_bclink_stop();
Paul Gortmaker1fa07382011-03-14 12:03:44 -0400224 list_for_each_entry_safe(node, t_node, &tipc_node_list, list)
Allan Stephens34e46252011-02-25 19:11:25 -0500225 tipc_node_delete(node);
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900226 write_unlock_bh(&tipc_net_lock);
Frans Popa570f092010-03-24 07:57:29 +0000227 info("Left network mode\n");
Per Lidenb97bf3f2006-01-02 19:04:38 +0100228}