net/tipc/net.c

   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 "config.h"
  44 #include "bcast.h"
  45
  46 static const struct nla_policy tipc_nl_net_policy[TIPC_NLA_NET_MAX + 1] = {
  47         [TIPC_NLA_NET_UNSPEC]   = { .type = NLA_UNSPEC },
  48         [TIPC_NLA_NET_ID]       = { .type = NLA_U32 }
  49 };
  50
  51 /*
  52  * The TIPC locking policy is designed to ensure a very fine locking
  53  * granularity, permitting complete parallel access to individual
  54  * port and node/link instances. The code consists of four major
  55  * locking domains, each protected with their own disjunct set of locks.
  56  *
  57  * 1: The bearer level.
  58  *    RTNL lock is used to serialize the process of configuring bearer
  59  *    on update side, and RCU lock is applied on read side to make
  60  *    bearer instance valid on both paths of message transmission and
  61  *    reception.
  62  *
  63  * 2: The node and link level.
  64  *    All node instances are saved into two tipc_node_list and node_htable
  65  *    lists. The two lists are protected by node_list_lock on write side,
  66  *    and they are guarded with RCU lock on read side. Especially node
  67  *    instance is destroyed only when TIPC module is removed, and we can
  68  *    confirm that there has no any user who is accessing the node at the
  69  *    moment. Therefore, Except for iterating the two lists within RCU
  70  *    protection, it's no needed to hold RCU that we access node instance
  71  *    in other places.
  72  *
  73  *    In addition, all members in node structure including link instances
  74  *    are protected by node spin lock.
  75  *
  76  * 3: The transport level of the protocol.
  77  *    This consists of the structures port, (and its user level
  78  *    representations, such as user_port and tipc_sock), reference and
  79  *    tipc_user (port.c, reg.c, socket.c).
  80  *
  81  *    This layer has four different locks:
  82  *     - The tipc_port spin_lock. This is protecting each port instance
  83  *       from parallel data access and removal. Since we can not place
  84  *       this lock in the port itself, it has been placed in the
  85  *       corresponding reference table entry, which has the same life
  86  *       cycle as the module. This entry is difficult to access from
  87  *       outside the TIPC core, however, so a pointer to the lock has
  88  *       been added in the port instance, -to be used for unlocking
  89  *       only.
  90  *     - A read/write lock to protect the reference table itself (teg.c).
  91  *       (Nobody is using read-only access to this, so it can just as
  92  *       well be changed to a spin_lock)
  93  *     - A spin lock to protect the registry of kernel/driver users (reg.c)
  94  *     - A global spin_lock (tipc_port_lock), which only task is to ensure
  95  *       consistency where more than one port is involved in an operation,
  96  *       i.e., whe a port is part of a linked list of ports.
  97  *       There are two such lists; 'port_list', which is used for management,
  98  *       and 'wait_list', which is used to queue ports during congestion.
  99  *
 100  *  4: The name table (name_table.c, name_distr.c, subscription.c)
 101  *     - There is one big read/write-lock (tipc_nametbl_lock) protecting the
 102  *       overall name table structure. Nothing must be added/removed to
 103  *       this structure without holding write access to it.
 104  *     - There is one local spin_lock per sub_sequence, which can be seen
 105  *       as a sub-domain to the tipc_nametbl_lock domain. It is used only
 106  *       for translation operations, and is needed because a translation
 107  *       steps the root of the 'publication' linked list between each lookup.
 108  *       This is always used within the scope of a tipc_nametbl_lock(read).
 109  *     - A local spin_lock protecting the queue of subscriber events.
 110 */
 111
 112 int tipc_net_start(struct net *net, u32 addr)
 113 {
 114         struct tipc_net *tn = net_generic(net, tipc_net_id);
 115         char addr_string[16];
 116         int res;
 117
 118         tn->own_addr = addr;
 119         tipc_named_reinit(net);
 120         tipc_sk_reinit(net);
 121         res = tipc_bclink_init(net);
 122         if (res)
 123                 return res;
 124
 125         tipc_nametbl_publish(net, TIPC_CFG_SRV, tn->own_addr, tn->own_addr,
 126                              TIPC_ZONE_SCOPE, 0, tn->own_addr);
 127
 128         pr_info("Started in network mode\n");
 129         pr_info("Own node address %s, network identity %u\n",
 130                 tipc_addr_string_fill(addr_string, tn->own_addr),
 131                 tn->net_id);
 132         return 0;
 133 }
 134
 135 void tipc_net_stop(struct net *net)
 136 {
 137         struct tipc_net *tn = net_generic(net, tipc_net_id);
 138
 139         if (!tn->own_addr)
 140                 return;
 141
 142         tipc_nametbl_withdraw(net, TIPC_CFG_SRV, tn->own_addr, 0,
 143                               tn->own_addr);
 144         rtnl_lock();
 145         tipc_bearer_stop(net);
 146         tipc_bclink_stop(net);
 147         tipc_node_stop(net);
 148         rtnl_unlock();
 149
 150         pr_info("Left network mode\n");
 151 }
 152
 153 static int __tipc_nl_add_net(struct net *net, struct tipc_nl_msg *msg)
 154 {
 155         struct tipc_net *tn = net_generic(net, tipc_net_id);
 156         void *hdr;
 157         struct nlattr *attrs;
 158
 159         hdr = genlmsg_put(msg->skb, msg->portid, msg->seq, &tipc_genl_v2_family,
 160                           NLM_F_MULTI, TIPC_NL_NET_GET);
 161         if (!hdr)
 162                 return -EMSGSIZE;
 163
 164         attrs = nla_nest_start(msg->skb, TIPC_NLA_NET);
 165         if (!attrs)
 166                 goto msg_full;
 167
 168         if (nla_put_u32(msg->skb, TIPC_NLA_NET_ID, tn->net_id))
 169                 goto attr_msg_full;
 170
 171         nla_nest_end(msg->skb, attrs);
 172         genlmsg_end(msg->skb, hdr);
 173
 174         return 0;
 175
 176 attr_msg_full:
 177         nla_nest_cancel(msg->skb, attrs);
 178 msg_full:
 179         genlmsg_cancel(msg->skb, hdr);
 180
 181         return -EMSGSIZE;
 182 }
 183
 184 int tipc_nl_net_dump(struct sk_buff *skb, struct netlink_callback *cb)
 185 {
 186         struct net *net = sock_net(skb->sk);
 187         int err;
 188         int done = cb->args[0];
 189         struct tipc_nl_msg msg;
 190
 191         if (done)
 192                 return 0;
 193
 194         msg.skb = skb;
 195         msg.portid = NETLINK_CB(cb->skb).portid;
 196         msg.seq = cb->nlh->nlmsg_seq;
 197
 198         err = __tipc_nl_add_net(net, &msg);
 199         if (err)
 200                 goto out;
 201
 202         done = 1;
 203 out:
 204         cb->args[0] = done;
 205
 206         return skb->len;
 207 }
 208
 209 int tipc_nl_net_set(struct sk_buff *skb, struct genl_info *info)
 210 {
 211         struct net *net = genl_info_net(info);
 212         struct tipc_net *tn = net_generic(net, tipc_net_id);
 213         struct nlattr *attrs[TIPC_NLA_NET_MAX + 1];
 214         int err;
 215
 216         if (!info->attrs[TIPC_NLA_NET])
 217                 return -EINVAL;
 218
 219         err = nla_parse_nested(attrs, TIPC_NLA_NET_MAX,
 220                                info->attrs[TIPC_NLA_NET],
 221                                tipc_nl_net_policy);
 222         if (err)
 223                 return err;
 224
 225         if (attrs[TIPC_NLA_NET_ID]) {
 226                 u32 val;
 227
 228                 /* Can't change net id once TIPC has joined a network */
 229                 if (tn->own_addr)
 230                         return -EPERM;
 231
 232                 val = nla_get_u32(attrs[TIPC_NLA_NET_ID]);
 233                 if (val < 1 || val > 9999)
 234                         return -EINVAL;
 235
 236                 tn->net_id = val;
 237         }
 238
 239         if (attrs[TIPC_NLA_NET_ADDR]) {
 240                 u32 addr;
 241
 242                 /* Can't change net addr once TIPC has joined a network */
 243                 if (tn->own_addr)
 244                         return -EPERM;
 245
 246                 addr = nla_get_u32(attrs[TIPC_NLA_NET_ADDR]);
 247                 if (!tipc_addr_node_valid(addr))
 248                         return -EINVAL;
 249
 250                 rtnl_lock();
 251                 tipc_net_start(net, addr);
 252                 rtnl_unlock();
 253         }
 254
 255         return 0;
 256 }