blob: d6d1399ae22922754ba24364e21e89a6a3497d22 [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 *
Jon Paul Maloy5a379072014-06-25 20:41:36 -05004 * Copyright (c) 1995-2006, 2014, 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"
Jon Paul Maloy9816f062014-05-14 05:39:15 -040041#include "socket.h"
Allan Stephens672d99e2011-02-25 18:42:52 -050042#include "node.h"
Jon Paul Maloya6bf70f2015-05-14 10:46:13 -040043#include "bcast.h"
Per Lidenb97bf3f2006-01-02 19:04:38 +010044
Richard Alpefd3cf2a2014-11-20 10:29:18 +010045static const struct nla_policy tipc_nl_net_policy[TIPC_NLA_NET_MAX + 1] = {
46 [TIPC_NLA_NET_UNSPEC] = { .type = NLA_UNSPEC },
47 [TIPC_NLA_NET_ID] = { .type = NLA_U32 }
48};
49
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090050/*
Per Lidenb97bf3f2006-01-02 19:04:38 +010051 * The TIPC locking policy is designed to ensure a very fine locking
52 * granularity, permitting complete parallel access to individual
Ying Xue7216cd92014-04-21 10:55:48 +080053 * port and node/link instances. The code consists of four major
Per Lidenb97bf3f2006-01-02 19:04:38 +010054 * locking domains, each protected with their own disjunct set of locks.
55 *
Ying Xue7216cd92014-04-21 10:55:48 +080056 * 1: The bearer level.
57 * RTNL lock is used to serialize the process of configuring bearer
58 * on update side, and RCU lock is applied on read side to make
59 * bearer instance valid on both paths of message transmission and
60 * reception.
Per Lidenb97bf3f2006-01-02 19:04:38 +010061 *
Ying Xue7216cd92014-04-21 10:55:48 +080062 * 2: The node and link level.
63 * All node instances are saved into two tipc_node_list and node_htable
64 * lists. The two lists are protected by node_list_lock on write side,
65 * and they are guarded with RCU lock on read side. Especially node
66 * instance is destroyed only when TIPC module is removed, and we can
67 * confirm that there has no any user who is accessing the node at the
68 * moment. Therefore, Except for iterating the two lists within RCU
69 * protection, it's no needed to hold RCU that we access node instance
70 * in other places.
Per Lidenb97bf3f2006-01-02 19:04:38 +010071 *
Ying Xue7216cd92014-04-21 10:55:48 +080072 * In addition, all members in node structure including link instances
73 * are protected by node spin lock.
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090074 *
Ying Xue7216cd92014-04-21 10:55:48 +080075 * 3: 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 *
Ying Xue7216cd92014-04-21 10:55:48 +080080 * This layer has four different locks:
Per Lidenb97bf3f2006-01-02 19:04:38 +010081 * - 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 *
Ying Xue7216cd92014-04-21 10:55:48 +080099 * 4: 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*/
Per Lidenb97bf3f2006-01-02 19:04:38 +0100110
Ying Xuec93d3ba2015-01-09 15:27:04 +0800111int tipc_net_start(struct net *net, u32 addr)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100112{
Ying Xuec93d3ba2015-01-09 15:27:04 +0800113 struct tipc_net *tn = net_generic(net, tipc_net_id);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100114 char addr_string[16];
Ying Xueeb8b00f2014-05-05 08:56:16 +0800115 int res;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100116
Ying Xue34747532015-01-09 15:27:10 +0800117 tn->own_addr = addr;
Ying Xue4ac1c8d2015-01-09 15:27:09 +0800118 tipc_named_reinit(net);
Ying Xuee05b31f2015-01-09 15:27:08 +0800119 tipc_sk_reinit(net);
Ying Xue7f9f95d2015-01-09 15:27:06 +0800120 res = tipc_bclink_init(net);
Ying Xueeb8b00f2014-05-05 08:56:16 +0800121 if (res)
122 return res;
123
Ying Xue34747532015-01-09 15:27:10 +0800124 tipc_nametbl_publish(net, TIPC_CFG_SRV, tn->own_addr, tn->own_addr,
125 TIPC_ZONE_SCOPE, 0, tn->own_addr);
Ying Xue7216cd92014-04-21 10:55:48 +0800126
Erik Hugne2cf8aa12012-06-29 00:16:37 -0400127 pr_info("Started in network mode\n");
128 pr_info("Own node address %s, network identity %u\n",
Ying Xue34747532015-01-09 15:27:10 +0800129 tipc_addr_string_fill(addr_string, tn->own_addr),
Ying Xuec93d3ba2015-01-09 15:27:04 +0800130 tn->net_id);
Ying Xueeb8b00f2014-05-05 08:56:16 +0800131 return 0;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100132}
133
Ying Xuef2f98002015-01-09 15:27:05 +0800134void tipc_net_stop(struct net *net)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100135{
Ying Xue34747532015-01-09 15:27:10 +0800136 struct tipc_net *tn = net_generic(net, tipc_net_id);
137
138 if (!tn->own_addr)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100139 return;
Ying Xue46651c52014-03-27 12:54:36 +0800140
Ying Xue34747532015-01-09 15:27:10 +0800141 tipc_nametbl_withdraw(net, TIPC_CFG_SRV, tn->own_addr, 0,
142 tn->own_addr);
Ying Xuef97e4552014-04-21 10:55:44 +0800143 rtnl_lock();
Ying Xuef2f98002015-01-09 15:27:05 +0800144 tipc_bearer_stop(net);
Ying Xue7f9f95d2015-01-09 15:27:06 +0800145 tipc_bclink_stop(net);
Ying Xuef2f98002015-01-09 15:27:05 +0800146 tipc_node_stop(net);
Ying Xuef97e4552014-04-21 10:55:44 +0800147 rtnl_unlock();
Ying Xue46651c52014-03-27 12:54:36 +0800148
Erik Hugne2cf8aa12012-06-29 00:16:37 -0400149 pr_info("Left network mode\n");
Per Lidenb97bf3f2006-01-02 19:04:38 +0100150}
Richard Alpefd3cf2a2014-11-20 10:29:18 +0100151
Ying Xuec93d3ba2015-01-09 15:27:04 +0800152static int __tipc_nl_add_net(struct net *net, struct tipc_nl_msg *msg)
Richard Alpefd3cf2a2014-11-20 10:29:18 +0100153{
Ying Xuec93d3ba2015-01-09 15:27:04 +0800154 struct tipc_net *tn = net_generic(net, tipc_net_id);
Richard Alpefd3cf2a2014-11-20 10:29:18 +0100155 void *hdr;
156 struct nlattr *attrs;
157
Richard Alpebfb3e5d2015-02-09 09:50:03 +0100158 hdr = genlmsg_put(msg->skb, msg->portid, msg->seq, &tipc_genl_family,
Richard Alpefd3cf2a2014-11-20 10:29:18 +0100159 NLM_F_MULTI, TIPC_NL_NET_GET);
160 if (!hdr)
161 return -EMSGSIZE;
162
163 attrs = nla_nest_start(msg->skb, TIPC_NLA_NET);
164 if (!attrs)
165 goto msg_full;
166
Ying Xuec93d3ba2015-01-09 15:27:04 +0800167 if (nla_put_u32(msg->skb, TIPC_NLA_NET_ID, tn->net_id))
Richard Alpefd3cf2a2014-11-20 10:29:18 +0100168 goto attr_msg_full;
169
170 nla_nest_end(msg->skb, attrs);
171 genlmsg_end(msg->skb, hdr);
172
173 return 0;
174
175attr_msg_full:
176 nla_nest_cancel(msg->skb, attrs);
177msg_full:
178 genlmsg_cancel(msg->skb, hdr);
179
180 return -EMSGSIZE;
181}
182
183int tipc_nl_net_dump(struct sk_buff *skb, struct netlink_callback *cb)
184{
Ying Xuec93d3ba2015-01-09 15:27:04 +0800185 struct net *net = sock_net(skb->sk);
Richard Alpefd3cf2a2014-11-20 10:29:18 +0100186 int err;
187 int done = cb->args[0];
188 struct tipc_nl_msg msg;
189
190 if (done)
191 return 0;
192
193 msg.skb = skb;
194 msg.portid = NETLINK_CB(cb->skb).portid;
195 msg.seq = cb->nlh->nlmsg_seq;
196
Ying Xuec93d3ba2015-01-09 15:27:04 +0800197 err = __tipc_nl_add_net(net, &msg);
Richard Alpefd3cf2a2014-11-20 10:29:18 +0100198 if (err)
199 goto out;
200
201 done = 1;
202out:
203 cb->args[0] = done;
204
205 return skb->len;
206}
Richard Alpe27c21412014-11-20 10:29:19 +0100207
208int tipc_nl_net_set(struct sk_buff *skb, struct genl_info *info)
209{
Richard Alped7cc75d2015-02-09 09:50:14 +0100210 struct net *net = sock_net(skb->sk);
Ying Xuec93d3ba2015-01-09 15:27:04 +0800211 struct tipc_net *tn = net_generic(net, tipc_net_id);
Richard Alpe27c21412014-11-20 10:29:19 +0100212 struct nlattr *attrs[TIPC_NLA_NET_MAX + 1];
Ying Xuec93d3ba2015-01-09 15:27:04 +0800213 int err;
Richard Alpe27c21412014-11-20 10:29:19 +0100214
215 if (!info->attrs[TIPC_NLA_NET])
216 return -EINVAL;
217
218 err = nla_parse_nested(attrs, TIPC_NLA_NET_MAX,
219 info->attrs[TIPC_NLA_NET],
220 tipc_nl_net_policy);
221 if (err)
222 return err;
223
224 if (attrs[TIPC_NLA_NET_ID]) {
225 u32 val;
226
227 /* Can't change net id once TIPC has joined a network */
Ying Xue34747532015-01-09 15:27:10 +0800228 if (tn->own_addr)
Richard Alpe27c21412014-11-20 10:29:19 +0100229 return -EPERM;
230
231 val = nla_get_u32(attrs[TIPC_NLA_NET_ID]);
232 if (val < 1 || val > 9999)
233 return -EINVAL;
234
Ying Xuec93d3ba2015-01-09 15:27:04 +0800235 tn->net_id = val;
Richard Alpe27c21412014-11-20 10:29:19 +0100236 }
237
238 if (attrs[TIPC_NLA_NET_ADDR]) {
239 u32 addr;
240
241 /* Can't change net addr once TIPC has joined a network */
Ying Xue34747532015-01-09 15:27:10 +0800242 if (tn->own_addr)
Richard Alpe27c21412014-11-20 10:29:19 +0100243 return -EPERM;
244
245 addr = nla_get_u32(attrs[TIPC_NLA_NET_ADDR]);
246 if (!tipc_addr_node_valid(addr))
247 return -EINVAL;
248
249 rtnl_lock();
Ying Xuec93d3ba2015-01-09 15:27:04 +0800250 tipc_net_start(net, addr);
Richard Alpe27c21412014-11-20 10:29:19 +0100251 rtnl_unlock();
252 }
253
254 return 0;
255}