net/tipc/core.h

   1 /*
   2  * net/tipc/core.h: Include file for TIPC global declarations
   3  *
   4  * Copyright (c) 2005-2006, 2013 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
  62 struct tipc_node;
  63 struct tipc_bearer;
  64 struct tipc_bc_base;
  65 struct tipc_link;
  66 struct tipc_name_table;
  67 struct tipc_server;
  68 struct tipc_monitor;
  69
  70 #define TIPC_MOD_VER "2.0.0"
  71
  72 #define NODE_HTABLE_SIZE       512
  73 #define MAX_BEARERS              3
  74 #define TIPC_DEF_MON_THRESHOLD  32
  75
  76 extern unsigned int tipc_net_id __read_mostly;
  77 extern int sysctl_tipc_rmem[3] __read_mostly;
  78 extern int sysctl_tipc_named_timeout __read_mostly;
  79
  80 struct tipc_net {
  81         u32 own_addr;
  82         int net_id;
  83         int random;
  84
  85         /* Node table and node list */
  86         spinlock_t node_list_lock;
  87         struct hlist_head node_htable[NODE_HTABLE_SIZE];
  88         struct list_head node_list;
  89         u32 num_nodes;
  90         u32 num_links;
  91
  92         /* Neighbor monitoring list */
  93         struct tipc_monitor *monitors[MAX_BEARERS];
  94         int mon_threshold;
  95
  96         /* Bearer list */
  97         struct tipc_bearer __rcu *bearer_list[MAX_BEARERS + 1];
  98
  99         /* Broadcast link */
 100         spinlock_t bclock;
 101         struct tipc_bc_base *bcbase;
 102         struct tipc_link *bcl;
 103
 104         /* Socket hash table */
 105         struct rhashtable sk_rht;
 106
 107         /* Name table */
 108         spinlock_t nametbl_lock;
 109         struct name_table *nametbl;
 110
 111         /* Name dist queue */
 112         struct list_head dist_queue;
 113
 114         /* Topology subscription server */
 115         struct tipc_server *topsrv;
 116         atomic_t subscription_count;
 117 };
 118
 119 static inline struct tipc_net *tipc_net(struct net *net)
 120 {
 121         return net_generic(net, tipc_net_id);
 122 }
 123
 124 static inline int tipc_netid(struct net *net)
 125 {
 126         return tipc_net(net)->net_id;
 127 }
 128
 129 static inline struct list_head *tipc_nodes(struct net *net)
 130 {
 131         return &tipc_net(net)->node_list;
 132 }
 133
 134 static inline struct tipc_server *tipc_topsrv(struct net *net)
 135 {
 136         return tipc_net(net)->topsrv;
 137 }
 138
 139 static inline unsigned int tipc_hashfn(u32 addr)
 140 {
 141         return addr & (NODE_HTABLE_SIZE - 1);
 142 }
 143
 144 static inline u16 mod(u16 x)
 145 {
 146         return x & 0xffffu;
 147 }
 148
 149 static inline int less_eq(u16 left, u16 right)
 150 {
 151         return mod(right - left) < 32768u;
 152 }
 153
 154 static inline int more(u16 left, u16 right)
 155 {
 156         return !less_eq(left, right);
 157 }
 158
 159 static inline int less(u16 left, u16 right)
 160 {
 161         return less_eq(left, right) && (mod(right) != mod(left));
 162 }
 163
 164 static inline int in_range(u16 val, u16 min, u16 max)
 165 {
 166         return !less(val, min) && !more(val, max);
 167 }
 168
 169 #ifdef CONFIG_SYSCTL
 170 int tipc_register_sysctl(void);
 171 void tipc_unregister_sysctl(void);
 172 #else
 173 #define tipc_register_sysctl() 0
 174 #define tipc_unregister_sysctl()
 175 #endif
 176 #endif