blob: 93b9944a6a8bb1e94c332b8bd5e5f641d90899d8 [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"
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
Ying Xue7216cd92014-04-21 10:55:48 +080048 * port and node/link instances. The code consists of four major
Per Lidenb97bf3f2006-01-02 19:04:38 +010049 * locking domains, each protected with their own disjunct set of locks.
50 *
Ying Xue7216cd92014-04-21 10:55:48 +080051 * 1: The bearer level.
52 * RTNL lock is used to serialize the process of configuring bearer
53 * on update side, and RCU lock is applied on read side to make
54 * bearer instance valid on both paths of message transmission and
55 * reception.
Per Lidenb97bf3f2006-01-02 19:04:38 +010056 *
Ying Xue7216cd92014-04-21 10:55:48 +080057 * 2: The node and link level.
58 * All node instances are saved into two tipc_node_list and node_htable
59 * lists. The two lists are protected by node_list_lock on write side,
60 * and they are guarded with RCU lock on read side. Especially node
61 * instance is destroyed only when TIPC module is removed, and we can
62 * confirm that there has no any user who is accessing the node at the
63 * moment. Therefore, Except for iterating the two lists within RCU
64 * protection, it's no needed to hold RCU that we access node instance
65 * in other places.
Per Lidenb97bf3f2006-01-02 19:04:38 +010066 *
Ying Xue7216cd92014-04-21 10:55:48 +080067 * In addition, all members in node structure including link instances
68 * are protected by node spin lock.
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090069 *
Ying Xue7216cd92014-04-21 10:55:48 +080070 * 3: The transport level of the protocol.
71 * This consists of the structures port, (and its user level
72 * representations, such as user_port and tipc_sock), reference and
73 * tipc_user (port.c, reg.c, socket.c).
Per Lidenb97bf3f2006-01-02 19:04:38 +010074 *
Ying Xue7216cd92014-04-21 10:55:48 +080075 * This layer has four different locks:
Per Lidenb97bf3f2006-01-02 19:04:38 +010076 * - The tipc_port spin_lock. This is protecting each port instance
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090077 * from parallel data access and removal. Since we can not place
78 * this lock in the port itself, it has been placed in the
Per Lidenb97bf3f2006-01-02 19:04:38 +010079 * corresponding reference table entry, which has the same life
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090080 * cycle as the module. This entry is difficult to access from
81 * outside the TIPC core, however, so a pointer to the lock has
82 * been added in the port instance, -to be used for unlocking
Per Lidenb97bf3f2006-01-02 19:04:38 +010083 * only.
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090084 * - A read/write lock to protect the reference table itself (teg.c).
85 * (Nobody is using read-only access to this, so it can just as
Per Lidenb97bf3f2006-01-02 19:04:38 +010086 * well be changed to a spin_lock)
87 * - A spin lock to protect the registry of kernel/driver users (reg.c)
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090088 * - A global spin_lock (tipc_port_lock), which only task is to ensure
Per Lidenb97bf3f2006-01-02 19:04:38 +010089 * consistency where more than one port is involved in an operation,
90 * i.e., whe a port is part of a linked list of ports.
91 * There are two such lists; 'port_list', which is used for management,
92 * and 'wait_list', which is used to queue ports during congestion.
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090093 *
Ying Xue7216cd92014-04-21 10:55:48 +080094 * 4: The name table (name_table.c, name_distr.c, subscription.c)
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090095 * - There is one big read/write-lock (tipc_nametbl_lock) protecting the
96 * overall name table structure. Nothing must be added/removed to
Per Lidenb97bf3f2006-01-02 19:04:38 +010097 * this structure without holding write access to it.
98 * - There is one local spin_lock per sub_sequence, which can be seen
Per Liden4323add2006-01-18 00:38:21 +010099 * as a sub-domain to the tipc_nametbl_lock domain. It is used only
Per Lidenb97bf3f2006-01-02 19:04:38 +0100100 * for translation operations, and is needed because a translation
101 * steps the root of the 'publication' linked list between each lookup.
Per Liden4323add2006-01-18 00:38:21 +0100102 * This is always used within the scope of a tipc_nametbl_lock(read).
Per Lidenb97bf3f2006-01-02 19:04:38 +0100103 * - A local spin_lock protecting the queue of subscriber events.
104*/
Per Lidenb97bf3f2006-01-02 19:04:38 +0100105
Ying Xueeb8b00f2014-05-05 08:56:16 +0800106int tipc_net_start(u32 addr)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100107{
108 char addr_string[16];
Ying Xueeb8b00f2014-05-05 08:56:16 +0800109 int res;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100110
Allan Stephens03194372008-05-21 14:55:04 -0700111 tipc_own_addr = addr;
Per Liden4323add2006-01-18 00:38:21 +0100112 tipc_named_reinit();
Jon Paul Maloy5a9ee0be2014-08-22 18:09:14 -0400113 tipc_sk_reinit();
Ying Xueeb8b00f2014-05-05 08:56:16 +0800114 res = tipc_bclink_init();
115 if (res)
116 return res;
117
Erik Hugnea5e7ac52014-04-03 08:28:01 +0200118 tipc_nametbl_publish(TIPC_CFG_SRV, tipc_own_addr, tipc_own_addr,
119 TIPC_ZONE_SCOPE, 0, tipc_own_addr);
Ying Xue7216cd92014-04-21 10:55:48 +0800120
Erik Hugne2cf8aa12012-06-29 00:16:37 -0400121 pr_info("Started in network mode\n");
122 pr_info("Own node address %s, network identity %u\n",
123 tipc_addr_string_fill(addr_string, tipc_own_addr), tipc_net_id);
Ying Xueeb8b00f2014-05-05 08:56:16 +0800124 return 0;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100125}
126
Per Liden4323add2006-01-18 00:38:21 +0100127void tipc_net_stop(void)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100128{
Allan Stephensb58343f2011-11-08 13:48:28 -0500129 if (!tipc_own_addr)
Per Lidenb97bf3f2006-01-02 19:04:38 +0100130 return;
Ying Xue46651c52014-03-27 12:54:36 +0800131
Erik Hugnea5e7ac52014-04-03 08:28:01 +0200132 tipc_nametbl_withdraw(TIPC_CFG_SRV, tipc_own_addr, 0, tipc_own_addr);
Ying Xuef97e4552014-04-21 10:55:44 +0800133 rtnl_lock();
Allan Stephens97f1b622011-10-20 09:48:05 -0400134 tipc_bearer_stop();
Per Liden4323add2006-01-18 00:38:21 +0100135 tipc_bclink_stop();
Ying Xue46651c52014-03-27 12:54:36 +0800136 tipc_node_stop();
Ying Xuef97e4552014-04-21 10:55:44 +0800137 rtnl_unlock();
Ying Xue46651c52014-03-27 12:54:36 +0800138
Erik Hugne2cf8aa12012-06-29 00:16:37 -0400139 pr_info("Left network mode\n");
Per Lidenb97bf3f2006-01-02 19:04:38 +0100140}