| 1 | |
| 2 | * net/tipc/name_table.h: Include file for TIPC name table code
|
| 3 | *
|
| 4 | * Copyright (c) 2000-2006, 2014-2018, Ericsson AB
|
| 5 | * Copyright (c) 2004-2005, 2010-2011, Wind River Systems
|
| 6 | * Copyright (c) 2020-2021, Red Hat Inc
|
| 7 | * All rights reserved.
|
| 8 | *
|
| 9 | * Redistribution and use in source and binary forms, with or without
|
| 10 | * modification, are permitted provided that the following conditions are met:
|
| 11 | *
|
| 12 | * 1. Redistributions of source code must retain the above copyright
|
| 13 | * notice, this list of conditions and the following disclaimer.
|
| 14 | * 2. Redistributions in binary form must reproduce the above copyright
|
| 15 | * notice, this list of conditions and the following disclaimer in the
|
| 16 | * documentation and/or other materials provided with the distribution.
|
| 17 | * 3. Neither the names of the copyright holders nor the names of its
|
| 18 | * contributors may be used to endorse or promote products derived from
|
| 19 | * this software without specific prior written permission.
|
| 20 | *
|
| 21 | * Alternatively, this software may be distributed under the terms of the
|
| 22 | * GNU General Public License ("GPL") version 2 as published by the Free
|
| 23 | * Software Foundation.
|
| 24 | *
|
| 25 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
| 26 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
| 27 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
| 28 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
|
| 29 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
| 30 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
| 31 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
| 32 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
| 33 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
| 34 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
| 35 | * POSSIBILITY OF SUCH DAMAGE.
|
| 36 |
|
| 37 |
|
| 38 | #ifndef _TIPC_NAME_TABLE_H
|
| 39 | #define _TIPC_NAME_TABLE_H
|
| 40 |
|
| 41 | struct tipc_subscription;
|
| 42 | struct tipc_plist;
|
| 43 | struct tipc_nlist;
|
| 44 | struct tipc_group;
|
| 45 | struct tipc_uaddr;
|
| 46 |
|
| 47 | |
| 48 | * TIPC name types reserved for internal TIPC use (both current and planned)
|
| 49 |
|
| 50 | #define TIPC_ZM_SRV 3
|
| 51 | #define TIPC_PUBL_SCOPE_NUM (TIPC_NODE_SCOPE + 1)
|
| 52 | #define TIPC_NAMETBL_SIZE 1024
|
| 53 |
|
| 54 | #define TIPC_ANY_SCOPE 10
|
| 55 |
|
| 56 | |
| 57 | * struct publication - info about a published service address or range
|
| 58 | * @sr: service range represented by this publication
|
| 59 | * @sk: address of socket bound to this publication
|
| 60 | * @scope: scope of publication, TIPC_NODE_SCOPE or TIPC_CLUSTER_SCOPE
|
| 61 | * @key: publication key, unique across the cluster
|
| 62 | * @id: publication id
|
| 63 | * @binding_node: all publications from the same node which bound this one
|
| 64 | * - Remote publications: in node->publ_list;
|
| 65 | * Used by node/name distr to withdraw publications when node is lost
|
| 66 | * - Local/node scope publications: in name_table->node_scope list
|
| 67 | * - Local/cluster scope publications: in name_table->cluster_scope list
|
| 68 | * @binding_sock: all publications from the same socket which bound this one
|
| 69 | * Used by socket to withdraw publications when socket is unbound/released
|
| 70 | * @local_publ: list of identical publications made from this node
|
| 71 | * Used by closest_first and multicast receive lookup algorithms
|
| 72 | * @all_publ: all publications identical to this one, whatever node and scope
|
| 73 | * Used by round-robin lookup algorithm
|
| 74 | * @list: to form a list of publications in temporal order
|
| 75 | * @rcu: RCU callback head used for deferred freeing
|
| 76 |
|
| 77 | struct publication {
|
| 78 | struct tipc_service_range sr;
|
| 79 | struct tipc_socket_addr sk;
|
| 80 | u16 scope;
|
| 81 | u32 key;
|
| 82 | u32 id;
|
| 83 | struct list_head binding_node;
|
| 84 | struct list_head binding_sock;
|
| 85 | struct list_head local_publ;
|
| 86 | struct list_head all_publ;
|
| 87 | struct list_head list;
|
| 88 | struct rcu_head rcu;
|
| 89 | };
|
| 90 |
|
| 91 | |
| 92 | * struct name_table - table containing all existing port name publications
|
| 93 | * @rcu: RCU callback head used for deferred freeing
|
| 94 | * @services: name sequence hash lists
|
| 95 | * @node_scope: all local publications with node scope
|
| 96 | * - used by name_distr during re-init of name table
|
| 97 | * @cluster_scope: all local publications with cluster scope
|
| 98 | * - used by name_distr to send bulk updates to new nodes
|
| 99 | * - used by name_distr during re-init of name table
|
| 100 | * @cluster_scope_lock: lock for accessing @cluster_scope
|
| 101 | * @local_publ_count: number of publications issued by this node
|
| 102 | * @rc_dests: destination node counter
|
| 103 | * @snd_nxt: next sequence number to be used
|
| 104 |
|
| 105 | struct name_table {
|
| 106 | struct rcu_head rcu;
|
| 107 | struct hlist_head services[TIPC_NAMETBL_SIZE];
|
| 108 | struct list_head node_scope;
|
| 109 | struct list_head cluster_scope;
|
| 110 | rwlock_t cluster_scope_lock;
|
| 111 | u32 local_publ_count;
|
| 112 | u32 rc_dests;
|
| 113 | u32 snd_nxt;
|
| 114 | };
|
| 115 |
|
| 116 | int tipc_nl_name_table_dump(struct sk_buff *skb, struct netlink_callback *cb);
|
| 117 | bool tipc_nametbl_lookup_anycast(struct net *net, struct tipc_uaddr *ua,
|
| 118 | struct tipc_socket_addr *sk);
|
| 119 | void tipc_nametbl_lookup_mcast_sockets(struct net *net, struct tipc_uaddr *ua,
|
| 120 | struct list_head *dports);
|
| 121 | void tipc_nametbl_lookup_mcast_nodes(struct net *net, struct tipc_uaddr *ua,
|
| 122 | struct tipc_nlist *nodes);
|
| 123 | bool tipc_nametbl_lookup_group(struct net *net, struct tipc_uaddr *ua,
|
| 124 | struct list_head *dsts, int *dstcnt,
|
| 125 | u32 exclude, bool mcast);
|
| 126 | void tipc_nametbl_build_group(struct net *net, struct tipc_group *grp,
|
| 127 | struct tipc_uaddr *ua);
|
| 128 | struct publication *tipc_nametbl_publish(struct net *net, struct tipc_uaddr *ua,
|
| 129 | struct tipc_socket_addr *sk, u32 key);
|
| 130 | void tipc_nametbl_withdraw(struct net *net, struct tipc_uaddr *ua,
|
| 131 | struct tipc_socket_addr *sk, u32 key);
|
| 132 | struct publication *tipc_nametbl_insert_publ(struct net *net,
|
| 133 | struct tipc_uaddr *ua,
|
| 134 | struct tipc_socket_addr *sk,
|
| 135 | u32 key);
|
| 136 | struct publication *tipc_nametbl_remove_publ(struct net *net,
|
| 137 | struct tipc_uaddr *ua,
|
| 138 | struct tipc_socket_addr *sk,
|
| 139 | u32 key);
|
| 140 | bool tipc_nametbl_subscribe(struct tipc_subscription *s);
|
| 141 | void tipc_nametbl_unsubscribe(struct tipc_subscription *s);
|
| 142 | int tipc_nametbl_init(struct net *net);
|
| 143 | void tipc_nametbl_stop(struct net *net);
|
| 144 |
|
| 145 | struct tipc_dest {
|
| 146 | struct list_head list;
|
| 147 | u32 port;
|
| 148 | u32 node;
|
| 149 | };
|
| 150 |
|
| 151 | struct tipc_dest *tipc_dest_find(struct list_head *l, u32 node, u32 port);
|
| 152 | bool tipc_dest_push(struct list_head *l, u32 node, u32 port);
|
| 153 | bool tipc_dest_pop(struct list_head *l, u32 *node, u32 *port);
|
| 154 | bool tipc_dest_del(struct list_head *l, u32 node, u32 port);
|
| 155 | void tipc_dest_list_purge(struct list_head *l);
|
| 156 |
|
| 157 | #endif
|