projects/linux·blob master · refs

347 lines · 10.2 KiB

1/*
2 * net/tipc/net.c: TIPC network routing code
3 *
4 * Copyright (c) 1995-2006, 2014, Ericsson AB
5 * Copyright (c) 2005, 2010-2011, 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 "core.h"
38#include "net.h"
39#include "name_distr.h"
40#include "subscr.h"
41#include "socket.h"
42#include "node.h"
43#include "bcast.h"
44#include "link.h"
45#include "netlink.h"
46#include "monitor.h"
47
48/*
49 * The TIPC locking policy is designed to ensure a very fine locking
50 * granularity, permitting complete parallel access to individual
51 * port and node/link instances. The code consists of four major
52 * locking domains, each protected with their own disjunct set of locks.
53 *
54 * 1: The bearer level.
55 * RTNL lock is used to serialize the process of configuring bearer
56 * on update side, and RCU lock is applied on read side to make
57 * bearer instance valid on both paths of message transmission and
58 * reception.
59 *
60 * 2: The node and link level.
61 * All node instances are saved into two tipc_node_list and node_htable
62 * lists. The two lists are protected by node_list_lock on write side,
63 * and they are guarded with RCU lock on read side. Especially node
64 * instance is destroyed only when TIPC module is removed, and we can
65 * confirm that there has no any user who is accessing the node at the
66 * moment. Therefore, Except for iterating the two lists within RCU
67 * protection, it's no needed to hold RCU that we access node instance
68 * in other places.
69 *
70 * In addition, all members in node structure including link instances
71 * are protected by node spin lock.
72 *
73 * 3: The transport level of the protocol.
74 * This consists of the structures port, (and its user level
75 * representations, such as user_port and tipc_sock), reference and
76 * tipc_user (port.c, reg.c, socket.c).
77 *
78 * This layer has four different locks:
79 * - The tipc_port spin_lock. This is protecting each port instance
80 * from parallel data access and removal. Since we can not place
81 * this lock in the port itself, it has been placed in the
82 * corresponding reference table entry, which has the same life
83 * cycle as the module. This entry is difficult to access from
84 * outside the TIPC core, however, so a pointer to the lock has
85 * been added in the port instance, -to be used for unlocking
86 * only.
87 * - A read/write lock to protect the reference table itself (teg.c).
88 * (Nobody is using read-only access to this, so it can just as
89 * well be changed to a spin_lock)
90 * - A spin lock to protect the registry of kernel/driver users (reg.c)
91 * - A global spin_lock (tipc_port_lock), which only task is to ensure
92 * consistency where more than one port is involved in an operation,
93 * i.e., when a port is part of a linked list of ports.
94 * There are two such lists; 'port_list', which is used for management,
95 * and 'wait_list', which is used to queue ports during congestion.
96 *
97 * 4: The name table (name_table.c, name_distr.c, subscription.c)
98 * - There is one big read/write-lock (tipc_nametbl_lock) protecting the
99 * overall name table structure. Nothing must be added/removed to
100 * this structure without holding write access to it.
101 * - There is one local spin_lock per sub_sequence, which can be seen
102 * as a sub-domain to the tipc_nametbl_lock domain. It is used only
103 * for translation operations, and is needed because a translation
104 * steps the root of the 'publication' linked list between each lookup.
105 * This is always used within the scope of a tipc_nametbl_lock(read).
106 * - A local spin_lock protecting the queue of subscriber events.
107*/
108
109static void tipc_net_finalize(struct net *net, u32 addr);
110
111int tipc_net_init(struct net *net, u8 *node_id, u32 addr)
112{
113 if (tipc_own_id(net)) {
114 pr_info("Cannot configure node identity twice\n");
115 return -1;
116 }
117 pr_info("Started in network mode\n");
118
119 if (node_id)
120 tipc_set_node_id(net, node_id);
121 if (addr)
122 tipc_net_finalize(net, addr);
123 return 0;
124}
125
126static void tipc_net_finalize(struct net *net, u32 addr)
127{
128 struct tipc_net *tn = tipc_net(net);
129 struct tipc_socket_addr sk = {0, addr};
130 struct tipc_uaddr ua;
131
132 tipc_uaddr(&ua, TIPC_SERVICE_RANGE, TIPC_CLUSTER_SCOPE,
133 TIPC_NODE_STATE, addr, addr);
134
135 if (cmpxchg(&tn->node_addr, 0, addr))
136 return;
137 tipc_set_node_addr(net, addr);
138 tipc_named_reinit(net);
139 tipc_sk_reinit(net);
140 tipc_mon_reinit_self(net);
141 tipc_nametbl_publish(net, &ua, &sk, addr);
142}
143
144void tipc_net_finalize_work(struct work_struct *work)
145{
146 struct tipc_net *tn = container_of(work, struct tipc_net, work);
147
148 rtnl_lock();
149 tipc_net_finalize(tipc_link_net(tn->bcl), tn->trial_addr);
150 rtnl_unlock();
151}
152
153void tipc_net_stop(struct net *net)
154{
155 if (!tipc_own_id(net))
156 return;
157
158 rtnl_lock();
159 tipc_bearer_stop(net);
160 tipc_node_stop(net);
161 rtnl_unlock();
162
163 pr_info("Left network mode\n");
164}
165
166static int __tipc_nl_add_net(struct net *net, struct tipc_nl_msg *msg)
167{
168 struct tipc_net *tn = net_generic(net, tipc_net_id);
169 u64 *w0 = (u64 *)&tn->node_id[0];
170 u64 *w1 = (u64 *)&tn->node_id[8];
171 struct nlattr *attrs;
172 void *hdr;
173
174 hdr = genlmsg_put(msg->skb, msg->portid, msg->seq, &tipc_genl_family,
175 NLM_F_MULTI, TIPC_NL_NET_GET);
176 if (!hdr)
177 return -EMSGSIZE;
178
179 attrs = nla_nest_start_noflag(msg->skb, TIPC_NLA_NET);
180 if (!attrs)
181 goto msg_full;
182
183 if (nla_put_u32(msg->skb, TIPC_NLA_NET_ID, tn->net_id))
184 goto attr_msg_full;
185 if (nla_put_u64_64bit(msg->skb, TIPC_NLA_NET_NODEID, *w0, 0))
186 goto attr_msg_full;
187 if (nla_put_u64_64bit(msg->skb, TIPC_NLA_NET_NODEID_W1, *w1, 0))
188 goto attr_msg_full;
189 nla_nest_end(msg->skb, attrs);
190 genlmsg_end(msg->skb, hdr);
191
192 return 0;
193
194attr_msg_full:
195 nla_nest_cancel(msg->skb, attrs);
196msg_full:
197 genlmsg_cancel(msg->skb, hdr);
198
199 return -EMSGSIZE;
200}
201
202int tipc_nl_net_dump(struct sk_buff *skb, struct netlink_callback *cb)
203{
204 struct net *net = sock_net(skb->sk);
205 int err;
206 int done = cb->args[0];
207 struct tipc_nl_msg msg;
208
209 if (done)
210 return 0;
211
212 msg.skb = skb;
213 msg.portid = NETLINK_CB(cb->skb).portid;
214 msg.seq = cb->nlh->nlmsg_seq;
215
216 err = __tipc_nl_add_net(net, &msg);
217 if (err)
218 goto out;
219
220 done = 1;
221out:
222 cb->args[0] = done;
223
224 return skb->len;
225}
226
227int __tipc_nl_net_set(struct sk_buff *skb, struct genl_info *info)
228{
229 struct nlattr *attrs[TIPC_NLA_NET_MAX + 1];
230 struct net *net = sock_net(skb->sk);
231 struct tipc_net *tn = tipc_net(net);
232 int err;
233
234 if (!info->attrs[TIPC_NLA_NET])
235 return -EINVAL;
236
237 err = nla_parse_nested_deprecated(attrs, TIPC_NLA_NET_MAX,
238 info->attrs[TIPC_NLA_NET],
239 tipc_nl_net_policy, info->extack);
240
241 if (err)
242 return err;
243
244 /* Can't change net id once TIPC has joined a network */
245 if (tipc_own_addr(net))
246 return -EPERM;
247
248 if (attrs[TIPC_NLA_NET_ID]) {
249 u32 val;
250
251 val = nla_get_u32(attrs[TIPC_NLA_NET_ID]);
252 if (val < 1 || val > 9999)
253 return -EINVAL;
254
255 tn->net_id = val;
256 }
257
258 if (attrs[TIPC_NLA_NET_ADDR]) {
259 u32 addr;
260
261 addr = nla_get_u32(attrs[TIPC_NLA_NET_ADDR]);
262 if (!addr)
263 return -EINVAL;
264 tn->legacy_addr_format = true;
265 tipc_net_init(net, NULL, addr);
266 }
267
268 if (attrs[TIPC_NLA_NET_NODEID]) {
269 u8 node_id[NODE_ID_LEN];
270 u64 *w0 = (u64 *)&node_id[0];
271 u64 *w1 = (u64 *)&node_id[8];
272
273 if (!attrs[TIPC_NLA_NET_NODEID_W1])
274 return -EINVAL;
275 *w0 = nla_get_u64(attrs[TIPC_NLA_NET_NODEID]);
276 *w1 = nla_get_u64(attrs[TIPC_NLA_NET_NODEID_W1]);
277 tipc_net_init(net, node_id, 0);
278 }
279 return 0;
280}
281
282int tipc_nl_net_set(struct sk_buff *skb, struct genl_info *info)
283{
284 int err;
285
286 rtnl_lock();
287 err = __tipc_nl_net_set(skb, info);
288 rtnl_unlock();
289
290 return err;
291}
292
293static int __tipc_nl_addr_legacy_get(struct net *net, struct tipc_nl_msg *msg)
294{
295 struct tipc_net *tn = tipc_net(net);
296 struct nlattr *attrs;
297 void *hdr;
298
299 hdr = genlmsg_put(msg->skb, msg->portid, msg->seq, &tipc_genl_family,
300 0, TIPC_NL_ADDR_LEGACY_GET);
301 if (!hdr)
302 return -EMSGSIZE;
303
304 attrs = nla_nest_start(msg->skb, TIPC_NLA_NET);
305 if (!attrs)
306 goto msg_full;
307
308 if (tn->legacy_addr_format)
309 if (nla_put_flag(msg->skb, TIPC_NLA_NET_ADDR_LEGACY))
310 goto attr_msg_full;
311
312 nla_nest_end(msg->skb, attrs);
313 genlmsg_end(msg->skb, hdr);
314
315 return 0;
316
317attr_msg_full:
318 nla_nest_cancel(msg->skb, attrs);
319msg_full:
320 genlmsg_cancel(msg->skb, hdr);
321
322 return -EMSGSIZE;
323}
324
325int tipc_nl_net_addr_legacy_get(struct sk_buff *skb, struct genl_info *info)
326{
327 struct net *net = sock_net(skb->sk);
328 struct tipc_nl_msg msg;
329 struct sk_buff *rep;
330 int err;
331
332 rep = nlmsg_new(NLMSG_GOODSIZE, GFP_KERNEL);
333 if (!rep)
334 return -ENOMEM;
335
336 msg.skb = rep;
337 msg.portid = info->snd_portid;
338 msg.seq = info->snd_seq;
339
340 err = __tipc_nl_addr_legacy_get(net, &msg);
341 if (err) {
342 nlmsg_free(msg.skb);
343 return err;
344 }
345
346 return genlmsg_reply(msg.skb, info);
347}