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