Commit | Line | Data |
---|---|---|
b97bf3fd PL |
1 | /* |
2 | * net/tipc/net.c: TIPC network routing code | |
c4307285 | 3 | * |
5a379074 | 4 | * Copyright (c) 1995-2006, 2014, Ericsson AB |
9df3b7eb | 5 | * Copyright (c) 2005, 2010-2011, Wind River Systems |
b97bf3fd PL |
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 | * | |
9ea1fd3c PL |
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. | |
b97bf3fd PL |
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" | |
b97bf3fd | 38 | #include "net.h" |
b97bf3fd PL |
39 | #include "name_distr.h" |
40 | #include "subscr.h" | |
9816f061 | 41 | #include "socket.h" |
672d99e1 | 42 | #include "node.h" |
b97bf3fd PL |
43 | #include "config.h" |
44 | ||
c4307285 | 45 | /* |
b97bf3fd PL |
46 | * The TIPC locking policy is designed to ensure a very fine locking |
47 | * granularity, permitting complete parallel access to individual | |
7216cd94 | 48 | * port and node/link instances. The code consists of four major |
b97bf3fd PL |
49 | * locking domains, each protected with their own disjunct set of locks. |
50 | * | |
7216cd94 YX |
51 | * 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. | |
b97bf3fd | 56 | * |
7216cd94 YX |
57 | * 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. | |
b97bf3fd | 66 | * |
7216cd94 YX |
67 | * In addition, all members in node structure including link instances |
68 | * are protected by node spin lock. | |
c4307285 | 69 | * |
7216cd94 YX |
70 | * 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). | |
b97bf3fd | 74 | * |
7216cd94 | 75 | * This layer has four different locks: |
b97bf3fd | 76 | * - The tipc_port spin_lock. This is protecting each port instance |
c4307285 YH |
77 | * from parallel data access and removal. Since we can not place |
78 | * this lock in the port itself, it has been placed in the | |
b97bf3fd | 79 | * corresponding reference table entry, which has the same life |
c4307285 YH |
80 | * 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 | |
b97bf3fd | 83 | * only. |
c4307285 YH |
84 | * - 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 | |
b97bf3fd PL |
86 | * well be changed to a spin_lock) |
87 | * - A spin lock to protect the registry of kernel/driver users (reg.c) | |
c4307285 | 88 | * - A global spin_lock (tipc_port_lock), which only task is to ensure |
b97bf3fd PL |
89 | * 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. | |
c4307285 | 93 | * |
7216cd94 | 94 | * 4: The name table (name_table.c, name_distr.c, subscription.c) |
c4307285 YH |
95 | * - There is one big read/write-lock (tipc_nametbl_lock) protecting the |
96 | * overall name table structure. Nothing must be added/removed to | |
b97bf3fd PL |
97 | * this structure without holding write access to it. |
98 | * - There is one local spin_lock per sub_sequence, which can be seen | |
4323add6 | 99 | * as a sub-domain to the tipc_nametbl_lock domain. It is used only |
b97bf3fd PL |
100 | * for translation operations, and is needed because a translation |
101 | * steps the root of the 'publication' linked list between each lookup. | |
4323add6 | 102 | * This is always used within the scope of a tipc_nametbl_lock(read). |
b97bf3fd PL |
103 | * - A local spin_lock protecting the queue of subscriber events. |
104 | */ | |
b97bf3fd | 105 | |
eb8b00f5 | 106 | int tipc_net_start(u32 addr) |
b97bf3fd PL |
107 | { |
108 | char addr_string[16]; | |
eb8b00f5 | 109 | int res; |
b97bf3fd | 110 | |
03194379 | 111 | tipc_own_addr = addr; |
4323add6 | 112 | tipc_named_reinit(); |
5a9ee0be | 113 | tipc_sk_reinit(); |
eb8b00f5 YX |
114 | res = tipc_bclink_init(); |
115 | if (res) | |
116 | return res; | |
117 | ||
a5e7ac5c EH |
118 | tipc_nametbl_publish(TIPC_CFG_SRV, tipc_own_addr, tipc_own_addr, |
119 | TIPC_ZONE_SCOPE, 0, tipc_own_addr); | |
7216cd94 | 120 | |
2cf8aa19 EH |
121 | 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); | |
eb8b00f5 | 124 | return 0; |
b97bf3fd PL |
125 | } |
126 | ||
4323add6 | 127 | void tipc_net_stop(void) |
b97bf3fd | 128 | { |
b58343f9 | 129 | if (!tipc_own_addr) |
b97bf3fd | 130 | return; |
46651c59 | 131 | |
a5e7ac5c | 132 | tipc_nametbl_withdraw(TIPC_CFG_SRV, tipc_own_addr, 0, tipc_own_addr); |
f97e455a | 133 | rtnl_lock(); |
97f1b625 | 134 | tipc_bearer_stop(); |
4323add6 | 135 | tipc_bclink_stop(); |
46651c59 | 136 | tipc_node_stop(); |
f97e455a | 137 | rtnl_unlock(); |
46651c59 | 138 | |
2cf8aa19 | 139 | pr_info("Left network mode\n"); |
b97bf3fd | 140 | } |