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