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 40 struct tipc_subscription; 41 struct tipc_plist; 42 struct tipc_nlist; 43 struct tipc_group; 44 45 /* 46 * TIPC name types reserved for internal TIPC use (both current and planned) 47 */ 48 #define TIPC_ZM_SRV 3 /* zone master service name type */ 49 #define TIPC_PUBL_SCOPE_NUM (TIPC_NODE_SCOPE + 1) 50 #define TIPC_NAMETBL_SIZE 1024 /* must be a power of 2 */ 51 52 /** 53 * struct publication - info about a published (name or) name sequence 54 * @type: name sequence type 55 * @lower: name sequence lower bound 56 * @upper: name sequence upper bound 57 * @scope: scope of publication 58 * @node: network address of publishing port's node 59 * @ref: publishing port 60 * @key: publication key 61 * @nodesub_list: subscription to "node down" event (off-node publication only) 62 * @local_list: adjacent entries in list of publications made by this node 63 * @pport_list: adjacent entries in list of publications made by this port 64 * @node_list: adjacent matching name seq publications with >= node scope 65 * @cluster_list: adjacent matching name seq publications with >= cluster scope 66 * @zone_list: adjacent matching name seq publications with >= zone scope 67 * @rcu: RCU callback head used for deferred freeing 68 * 69 * Note that the node list, cluster list, and zone list are circular lists. 70 */ 71 struct publication { 72 u32 type; 73 u32 lower; 74 u32 upper; 75 u32 scope; 76 u32 node; 77 u32 ref; 78 u32 key; 79 struct list_head nodesub_list; 80 struct list_head local_list; 81 struct list_head pport_list; 82 struct list_head node_list; 83 struct list_head cluster_list; 84 struct list_head zone_list; 85 struct rcu_head rcu; 86 }; 87 88 /** 89 * struct name_table - table containing all existing port name publications 90 * @seq_hlist: name sequence hash lists 91 * @publ_list: pulication lists 92 * @local_publ_count: number of publications issued by this node 93 */ 94 struct name_table { 95 struct hlist_head seq_hlist[TIPC_NAMETBL_SIZE]; 96 struct list_head publ_list[TIPC_PUBL_SCOPE_NUM]; 97 u32 local_publ_count; 98 }; 99 100 int tipc_nl_name_table_dump(struct sk_buff *skb, struct netlink_callback *cb); 101 102 u32 tipc_nametbl_translate(struct net *net, u32 type, u32 instance, u32 *node); 103 int tipc_nametbl_mc_lookup(struct net *net, u32 type, u32 lower, u32 upper, 104 u32 scope, bool exact, struct list_head *dports); 105 void tipc_nametbl_build_group(struct net *net, struct tipc_group *grp, 106 u32 type, u32 domain); 107 void tipc_nametbl_lookup_dst_nodes(struct net *net, u32 type, u32 lower, 108 u32 upper, struct tipc_nlist *nodes); 109 bool tipc_nametbl_lookup(struct net *net, u32 type, u32 instance, u32 domain, 110 struct list_head *dsts, int *dstcnt, u32 exclude, 111 bool all); 112 struct publication *tipc_nametbl_publish(struct net *net, u32 type, u32 lower, 113 u32 upper, u32 scope, u32 port_ref, 114 u32 key); 115 int tipc_nametbl_withdraw(struct net *net, u32 type, u32 lower, u32 ref, 116 u32 key); 117 struct publication *tipc_nametbl_insert_publ(struct net *net, u32 type, 118 u32 lower, u32 upper, u32 scope, 119 u32 node, u32 ref, u32 key); 120 struct publication *tipc_nametbl_remove_publ(struct net *net, u32 type, 121 u32 lower, u32 node, u32 ref, 122 u32 key); 123 void tipc_nametbl_subscribe(struct tipc_subscription *s); 124 void tipc_nametbl_unsubscribe(struct tipc_subscription *s); 125 int tipc_nametbl_init(struct net *net); 126 void tipc_nametbl_stop(struct net *net); 127 128 struct tipc_dest { 129 struct list_head list; 130 union { 131 struct { 132 u32 port; 133 u32 node; 134 }; 135 u64 value; 136 }; 137 }; 138 139 struct tipc_dest *tipc_dest_find(struct list_head *l, u32 node, u32 port); 140 bool tipc_dest_push(struct list_head *l, u32 node, u32 port); 141 bool tipc_dest_pop(struct list_head *l, u32 *node, u32 *port); 142 bool tipc_dest_del(struct list_head *l, u32 node, u32 port); 143 void tipc_dest_list_purge(struct list_head *l); 144 int tipc_dest_list_len(struct list_head *l); 145 146 #endif 147