LXR linux/net/tipc/name

   1/*
   2 * net/tipc/name_table.h: Include file for TIPC name table code
   3 *
   4 * Copyright (c) 2000-2006, 2014-2015, Ericsson AB
   5 * Copyright (c) 2004-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#ifndef _TIPC_NAME_TABLE_H
  38#define _TIPC_NAME_TABLE_H
  39
  40struct tipc_subscription;
  41struct tipc_plist;
  42
  43/*
  44 * TIPC name types reserved for internal TIPC use (both current and planned)
  45 */
  46#define TIPC_ZM_SRV             3       /* zone master service name type */
  47#define TIPC_PUBL_SCOPE_NUM     (TIPC_NODE_SCOPE + 1)
  48#define TIPC_NAMETBL_SIZE       1024    /* must be a power of 2 */
  49
  50/**
  51 * struct publication - info about a published (name or) name sequence
  52 * @type: name sequence type
  53 * @lower: name sequence lower bound
  54 * @upper: name sequence upper bound
  55 * @scope: scope of publication
  56 * @node: network address of publishing port's node
  57 * @ref: publishing port
  58 * @key: publication key
  59 * @nodesub_list: subscription to "node down" event (off-node publication only)
  60 * @local_list: adjacent entries in list of publications made by this node
  61 * @pport_list: adjacent entries in list of publications made by this port
  62 * @node_list: adjacent matching name seq publications with >= node scope
  63 * @cluster_list: adjacent matching name seq publications with >= cluster scope
  64 * @zone_list: adjacent matching name seq publications with >= zone scope
  65 * @rcu: RCU callback head used for deferred freeing
  66 *
  67 * Note that the node list, cluster list, and zone list are circular lists.
  68 */
  69struct publication {
  70        u32 type;
  71        u32 lower;
  72        u32 upper;
  73        u32 scope;
  74        u32 node;
  75        u32 ref;
  76        u32 key;
  77        struct list_head nodesub_list;
  78        struct list_head local_list;
  79        struct list_head pport_list;
  80        struct list_head node_list;
  81        struct list_head cluster_list;
  82        struct list_head zone_list;
  83        struct rcu_head rcu;
  84};
  85
  86/**
  87 * struct name_table - table containing all existing port name publications
  88 * @seq_hlist: name sequence hash lists
  89 * @publ_list: pulication lists
  90 * @local_publ_count: number of publications issued by this node
  91 */
  92struct name_table {
  93        struct hlist_head seq_hlist[TIPC_NAMETBL_SIZE];
  94        struct list_head publ_list[TIPC_PUBL_SCOPE_NUM];
  95        u32 local_publ_count;
  96};
  97
  98int tipc_nl_name_table_dump(struct sk_buff *skb, struct netlink_callback *cb);
  99
 100u32 tipc_nametbl_translate(struct net *net, u32 type, u32 instance, u32 *node);
 101int tipc_nametbl_mc_translate(struct net *net, u32 type, u32 lower, u32 upper,
 102                              u32 limit, struct tipc_plist *dports);
 103struct publication *tipc_nametbl_publish(struct net *net, u32 type, u32 lower,
 104                                         u32 upper, u32 scope, u32 port_ref,
 105                                         u32 key);
 106int tipc_nametbl_withdraw(struct net *net, u32 type, u32 lower, u32 ref,
 107                          u32 key);
 108struct publication *tipc_nametbl_insert_publ(struct net *net, u32 type,
 109                                             u32 lower, u32 upper, u32 scope,
 110                                             u32 node, u32 ref, u32 key);
 111struct publication *tipc_nametbl_remove_publ(struct net *net, u32 type,
 112                                             u32 lower, u32 node, u32 ref,
 113                                             u32 key);
 114void tipc_nametbl_subscribe(struct tipc_subscription *s);
 115void tipc_nametbl_unsubscribe(struct tipc_subscription *s);
 116int tipc_nametbl_init(struct net *net);
 117void tipc_nametbl_stop(struct net *net);
 118
 119struct tipc_plist {
 120        struct list_head list;
 121        u32 port;
 122};
 123
 124static inline void tipc_plist_init(struct tipc_plist *pl)
 125{
 126        INIT_LIST_HEAD(&pl->list);
 127        pl->port = 0;
 128}
 129
 130void tipc_plist_push(struct tipc_plist *pl, u32 port);
 131u32 tipc_plist_pop(struct tipc_plist *pl);
 132
 133#endif
 134