net/tipc/core.h

   1 /*
   2  * net/tipc/core.h: Include file for TIPC global declarations
   3  *
   4  * Copyright (c) 2005-2006, 2013-2018 Ericsson AB
   5  * Copyright (c) 2005-2007, 2010-2013, 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 #ifndef _TIPC_CORE_H
  38 #define _TIPC_CORE_H
  39
  40 #include <linux/tipc.h>
  41 #include <linux/tipc_config.h>
  42 #include <linux/tipc_netlink.h>
  43 #include <linux/types.h>
  44 #include <linux/kernel.h>
  45 #include <linux/errno.h>
  46 #include <linux/mm.h>
  47 #include <linux/timer.h>
  48 #include <linux/string.h>
  49 #include <linux/uaccess.h>
  50 #include <linux/interrupt.h>
  51 #include <linux/atomic.h>
  52 #include <linux/netdevice.h>
  53 #include <linux/in.h>
  54 #include <linux/list.h>
  55 #include <linux/slab.h>
  56 #include <linux/vmalloc.h>
  57 #include <linux/rtnetlink.h>
  58 #include <linux/etherdevice.h>
  59 #include <net/netns/generic.h>
  60 #include <linux/rhashtable.h>
  61 #include <net/genetlink.h>
  62 #include <net/netns/hash.h>
  63
  64 struct tipc_node;
  65 struct tipc_bearer;
  66 struct tipc_bc_base;
  67 struct tipc_link;
  68 struct tipc_name_table;
  69 struct tipc_topsrv;
  70 struct tipc_monitor;
  71
  72 #define TIPC_MOD_VER "2.0.0"
  73
  74 #define NODE_HTABLE_SIZE       512
  75 #define MAX_BEARERS              3
  76 #define TIPC_DEF_MON_THRESHOLD  32
  77 #define NODE_ID_LEN             16
  78 #define NODE_ID_STR_LEN        (NODE_ID_LEN * 2 + 1)
  79
  80 extern unsigned int tipc_net_id __read_mostly;
  81 extern int sysctl_tipc_rmem[3] __read_mostly;
  82 extern int sysctl_tipc_named_timeout __read_mostly;
  83
  84 struct tipc_net {
  85         u8  node_id[NODE_ID_LEN];
  86         u32 node_addr;
  87         u32 trial_addr;
  88         unsigned long addr_trial_end;
  89         char node_id_string[NODE_ID_STR_LEN];
  90         int net_id;
  91         int random;
  92         bool legacy_addr_format;
  93
  94         /* Node table and node list */
  95         spinlock_t node_list_lock;
  96         struct hlist_head node_htable[NODE_HTABLE_SIZE];
  97         struct list_head node_list;
  98         u32 num_nodes;
  99         u32 num_links;
 100
 101         /* Neighbor monitoring list */
 102         struct tipc_monitor *monitors[MAX_BEARERS];
 103         int mon_threshold;
 104
 105         /* Bearer list */
 106         struct tipc_bearer __rcu *bearer_list[MAX_BEARERS + 1];
 107
 108         /* Broadcast link */
 109         spinlock_t bclock;
 110         struct tipc_bc_base *bcbase;
 111         struct tipc_link *bcl;
 112
 113         /* Socket hash table */
 114         struct rhashtable sk_rht;
 115
 116         /* Name table */
 117         spinlock_t nametbl_lock;
 118         struct name_table *nametbl;
 119
 120         /* Name dist queue */
 121         struct list_head dist_queue;
 122
 123         /* Topology subscription server */
 124         struct tipc_topsrv *topsrv;
 125         atomic_t subscription_count;
 126
 127         /* Cluster capabilities */
 128         u16 capabilities;
 129
 130         /* Tracing of node internal messages */
 131         struct packet_type loopback_pt;
 132 };
 133
 134 static inline struct tipc_net *tipc_net(struct net *net)
 135 {
 136         return net_generic(net, tipc_net_id);
 137 }
 138
 139 static inline int tipc_netid(struct net *net)
 140 {
 141         return tipc_net(net)->net_id;
 142 }
 143
 144 static inline struct list_head *tipc_nodes(struct net *net)
 145 {
 146         return &tipc_net(net)->node_list;
 147 }
 148
 149 static inline struct name_table *tipc_name_table(struct net *net)
 150 {
 151         return tipc_net(net)->nametbl;
 152 }
 153
 154 static inline struct tipc_topsrv *tipc_topsrv(struct net *net)
 155 {
 156         return tipc_net(net)->topsrv;
 157 }
 158
 159 static inline unsigned int tipc_hashfn(u32 addr)
 160 {
 161         return addr & (NODE_HTABLE_SIZE - 1);
 162 }
 163
 164 static inline u16 mod(u16 x)
 165 {
 166         return x & 0xffffu;
 167 }
 168
 169 static inline int less_eq(u16 left, u16 right)
 170 {
 171         return mod(right - left) < 32768u;
 172 }
 173
 174 static inline int more(u16 left, u16 right)
 175 {
 176         return !less_eq(left, right);
 177 }
 178
 179 static inline int less(u16 left, u16 right)
 180 {
 181         return less_eq(left, right) && (mod(right) != mod(left));
 182 }
 183
 184 static inline int in_range(u16 val, u16 min, u16 max)
 185 {
 186         return !less(val, min) && !more(val, max);
 187 }
 188
 189 static inline u32 tipc_net_hash_mixes(struct net *net, int tn_rand)
 190 {
 191         return net_hash_mix(&init_net) ^ net_hash_mix(net) ^ tn_rand;
 192 }
 193
 194 #ifdef CONFIG_SYSCTL
 195 int tipc_register_sysctl(void);
 196 void tipc_unregister_sysctl(void);
 197 #else
 198 #define tipc_register_sysctl() 0
 199 #define tipc_unregister_sysctl()
 200 #endif
 201 #endif