net/tipc/net.c

   1 /*
   2  * net/tipc/net.c: TIPC network routing code
   3  *
   4  * Copyright (c) 1995-2006, Ericsson AB
   5  * Copyright (c) 2005, 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_table.h"
  40 #include "name_distr.h"
  41 #include "subscr.h"
  42 #include "link.h"
  43 #include "port.h"
  44 #include "config.h"
  45
  46 /*
  47  * The TIPC locking policy is designed to ensure a very fine locking
  48  * granularity, permitting complete parallel access to individual
  49  * port and node/link instances. The code consists of three major
  50  * locking domains, each protected with their own disjunct set of locks.
  51  *
  52  * 1: The routing hierarchy.
  53  *    Comprises the structures 'zone', 'cluster', 'node', 'link'
  54  *    and 'bearer'. The whole hierarchy is protected by a big
  55  *    read/write lock, tipc_net_lock, to enssure that nothing is added
  56  *    or removed while code is accessing any of these structures.
  57  *    This layer must not be called from the two others while they
  58  *    hold any of their own locks.
  59  *    Neither must it itself do any upcalls to the other two before
  60  *    it has released tipc_net_lock and other protective locks.
  61  *
  62  *   Within the tipc_net_lock domain there are two sub-domains;'node' and
  63  *   'bearer', where local write operations are permitted,
  64  *   provided that those are protected by individual spin_locks
  65  *   per instance. Code holding tipc_net_lock(read) and a node spin_lock
  66  *   is permitted to poke around in both the node itself and its
  67  *   subordinate links. I.e, it can update link counters and queues,
  68  *   change link state, send protocol messages, and alter the
  69  *   "active_links" array in the node; but it can _not_ remove a link
  70  *   or a node from the overall structure.
  71  *   Correspondingly, individual bearers may change status within a
  72  *   tipc_net_lock(read), protected by an individual spin_lock ber bearer
  73  *   instance, but it needs tipc_net_lock(write) to remove/add any bearers.
  74  *
  75  *
  76  *  2: 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  *  3: 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 DEFINE_RWLOCK(tipc_net_lock);
 113 struct network tipc_net;
 114
 115 static void net_stop(void)
 116 {
 117         u32 c_num;
 118
 119         for (c_num = 1; c_num <= tipc_max_clusters; c_num++)
 120                 tipc_cltr_delete(tipc_net.clusters[c_num]);
 121 }
 122
 123 static void net_route_named_msg(struct sk_buff *buf)
 124 {
 125         struct tipc_msg *msg = buf_msg(buf);
 126         u32 dnode;
 127         u32 dport;
 128
 129         if (!msg_named(msg)) {
 130                 msg_dbg(msg, "tipc_net->drop_nam:");
 131                 buf_discard(buf);
 132                 return;
 133         }
 134
 135         dnode = addr_domain(msg_lookup_scope(msg));
 136         dport = tipc_nametbl_translate(msg_nametype(msg), msg_nameinst(msg), &dnode);
 137         dbg("tipc_net->lookup<%u,%u>-><%u,%x>\n",
 138             msg_nametype(msg), msg_nameinst(msg), dport, dnode);
 139         if (dport) {
 140                 msg_set_destnode(msg, dnode);
 141                 msg_set_destport(msg, dport);
 142                 tipc_net_route_msg(buf);
 143                 return;
 144         }
 145         msg_dbg(msg, "tipc_net->rej:NO NAME: ");
 146         tipc_reject_msg(buf, TIPC_ERR_NO_NAME);
 147 }
 148
 149 void tipc_net_route_msg(struct sk_buff *buf)
 150 {
 151         struct tipc_msg *msg;
 152         u32 dnode;
 153
 154         if (!buf)
 155                 return;
 156         msg = buf_msg(buf);
 157
 158         msg_incr_reroute_cnt(msg);
 159         if (msg_reroute_cnt(msg) > 6) {
 160                 if (msg_errcode(msg)) {
 161                         msg_dbg(msg, "NET>DISC>:");
 162                         buf_discard(buf);
 163                 } else {
 164                         msg_dbg(msg, "NET>REJ>:");
 165                         tipc_reject_msg(buf, msg_destport(msg) ?
 166                                         TIPC_ERR_NO_PORT : TIPC_ERR_NO_NAME);
 167                 }
 168                 return;
 169         }
 170
 171         msg_dbg(msg, "tipc_net->rout: ");
 172
 173         /* Handle message for this node */
 174         dnode = msg_short(msg) ? tipc_own_addr : msg_destnode(msg);
 175         if (tipc_in_scope(dnode, tipc_own_addr)) {
 176                 if (msg_isdata(msg)) {
 177                         if (msg_mcast(msg))
 178                                 tipc_port_recv_mcast(buf, NULL);
 179                         else if (msg_destport(msg))
 180                                 tipc_port_recv_msg(buf);
 181                         else
 182                                 net_route_named_msg(buf);
 183                         return;
 184                 }
 185                 switch (msg_user(msg)) {
 186                 case NAME_DISTRIBUTOR:
 187                         tipc_named_recv(buf);
 188                         break;
 189                 case CONN_MANAGER:
 190                         tipc_port_recv_proto_msg(buf);
 191                         break;
 192                 default:
 193                         msg_dbg(msg,"DROP/NET/<REC<");
 194                         buf_discard(buf);
 195                 }
 196                 return;
 197         }
 198
 199         /* Handle message for another node */
 200         msg_dbg(msg, "NET>SEND>: ");
 201         skb_trim(buf, msg_size(msg));
 202         tipc_link_send(buf, dnode, msg_link_selector(msg));
 203 }
 204
 205 int tipc_net_start(u32 addr)
 206 {
 207         char addr_string[16];
 208         int res;
 209
 210         if (tipc_mode != TIPC_NODE_MODE)
 211                 return -ENOPROTOOPT;
 212
 213         tipc_subscr_stop();
 214         tipc_cfg_stop();
 215
 216         tipc_own_addr = addr;
 217         tipc_mode = TIPC_NET_MODE;
 218         tipc_named_reinit();
 219         tipc_port_reinit();
 220
 221         if ((res = tipc_cltr_init()) ||
 222             (res = tipc_bclink_init())) {
 223                 return res;
 224         }
 225
 226         tipc_k_signal((Handler)tipc_subscr_start, 0);
 227         tipc_k_signal((Handler)tipc_cfg_init, 0);
 228
 229         info("Started in network mode\n");
 230         info("Own node address %s, network identity %u\n",
 231              tipc_addr_string_fill(addr_string, tipc_own_addr), tipc_net_id);
 232         return 0;
 233 }
 234
 235 void tipc_net_stop(void)
 236 {
 237         if (tipc_mode != TIPC_NET_MODE)
 238                 return;
 239         write_lock_bh(&tipc_net_lock);
 240         tipc_bearer_stop();
 241         tipc_mode = TIPC_NODE_MODE;
 242         tipc_bclink_stop();
 243         net_stop();
 244         write_unlock_bh(&tipc_net_lock);
 245         info("Left network mode\n");
 246 }
 247