[linux.git] / net / tipc / name_table.h

/*
 * net/tipc/name_table.h: Include file for TIPC name table code
 *
 * Copyright (c) 2000-2006, 2014-2018, Ericsson AB
 * Copyright (c) 2004-2005, 2010-2011, Wind River Systems
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the names of the copyright holders nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2 as published by the Free
 * Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _TIPC_NAME_TABLE_H
#define _TIPC_NAME_TABLE_H

struct tipc_subscription;
struct tipc_plist;
struct tipc_nlist;
struct tipc_group;

/*
 * TIPC name types reserved for internal TIPC use (both current and planned)
 */
#define TIPC_ZM_SRV		3	/* zone master service name type */
#define TIPC_PUBL_SCOPE_NUM	(TIPC_NODE_SCOPE + 1)
#define TIPC_NAMETBL_SIZE	1024	/* must be a power of 2 */

/**
 * struct publication - info about a published (name or) name sequence
 * @type: name sequence type
 * @lower: name sequence lower bound
 * @upper: name sequence upper bound
 * @scope: scope of publication, TIPC_NODE_SCOPE or TIPC_CLUSTER_SCOPE
 * @node: network address of publishing socket's node
 * @port: publishing port
 * @key: publication key, unique across the cluster
 * @binding_node: all publications from the same node which bound this one
 * - Remote publications: in node->publ_list
 *   Used by node/name distr to withdraw publications when node is lost
 * - Local/node scope publications: in name_table->node_scope list
 * - Local/cluster scope publications: in name_table->cluster_scope list
 * @binding_sock: all publications from the same socket which bound this one
 *   Used by socket to withdraw publications when socket is unbound/released
 * @local_publ: list of identical publications made from this node
 *   Used by closest_first and multicast receive lookup algorithms
 * @all_publ: all publications identical to this one, whatever node and scope
 *   Used by round-robin lookup algorithm
 * @rcu: RCU callback head used for deferred freeing
 */
struct publication {
	u32 type;
	u32 lower;
	u32 upper;
	u32 scope;
	u32 node;
	u32 port;
	u32 key;
	struct list_head binding_node;
	struct list_head binding_sock;
	struct list_head local_publ;
	struct list_head all_publ;
	struct rcu_head rcu;
};

/**
 * struct name_table - table containing all existing port name publications
 * @seq_hlist: name sequence hash lists
 * @node_scope: all local publications with node scope
 *               - used by name_distr during re-init of name table
 * @cluster_scope: all local publications with cluster scope
 *               - used by name_distr to send bulk updates to new nodes
 *               - used by name_distr during re-init of name table
 * @local_publ_count: number of publications issued by this node
 */
struct name_table {
	struct hlist_head services[TIPC_NAMETBL_SIZE];
	struct list_head node_scope;
	struct list_head cluster_scope;
	u32 local_publ_count;
};

int tipc_nl_name_table_dump(struct sk_buff *skb, struct netlink_callback *cb);

u32 tipc_nametbl_translate(struct net *net, u32 type, u32 instance, u32 *node);
void tipc_nametbl_mc_lookup(struct net *net, u32 type, u32 lower, u32 upper,
			    u32 scope, bool exact, struct list_head *dports);
void tipc_nametbl_build_group(struct net *net, struct tipc_group *grp,
			      u32 type, u32 domain);
void tipc_nametbl_lookup_dst_nodes(struct net *net, u32 type, u32 lower,
				   u32 upper, struct tipc_nlist *nodes);
bool tipc_nametbl_lookup(struct net *net, u32 type, u32 instance, u32 domain,
			 struct list_head *dsts, int *dstcnt, u32 exclude,
			 bool all);
struct publication *tipc_nametbl_publish(struct net *net, u32 type, u32 lower,
					 u32 upper, u32 scope, u32 port,
					 u32 key);
int tipc_nametbl_withdraw(struct net *net, u32 type, u32 lower, u32 upper,
			  u32 key);
struct publication *tipc_nametbl_insert_publ(struct net *net, u32 type,
					     u32 lower, u32 upper, u32 scope,
					     u32 node, u32 ref, u32 key);
struct publication *tipc_nametbl_remove_publ(struct net *net, u32 type,
					     u32 lower, u32 upper,
					     u32 node, u32 key);
bool tipc_nametbl_subscribe(struct tipc_subscription *s);
void tipc_nametbl_unsubscribe(struct tipc_subscription *s);
int tipc_nametbl_init(struct net *net);
void tipc_nametbl_stop(struct net *net);

struct tipc_dest {
	struct list_head list;
	union {
		struct {
			u32 port;
			u32 node;
		};
		u64 value;
	};
};

struct tipc_dest *tipc_dest_find(struct list_head *l, u32 node, u32 port);
bool tipc_dest_push(struct list_head *l, u32 node, u32 port);
bool tipc_dest_pop(struct list_head *l, u32 *node, u32 *port);
bool tipc_dest_del(struct list_head *l, u32 node, u32 port);
void tipc_dest_list_purge(struct list_head *l);
int tipc_dest_list_len(struct list_head *l);

#endif
Commit	Line	Data
b97bf3fd PL	1	/*
b97bf3fd PL	2	* net/tipc/name_table.h: Include file for TIPC name table code
c4307285	3	*
935439cc	4	* Copyright (c) 2000-2006, 2014-2018, Ericsson AB
f6f0a4d2	5	* Copyright (c) 2004-2005, 2010-2011, Wind River Systems
b97bf3fd PL	6	* All rights reserved.
b97bf3fd PL	7	*
9ea1fd3c	8	* Redistribution and use in source and binary forms, with or without
b97bf3fd PL	9	* modification, are permitted provided that the following conditions are met:
b97bf3fd PL	10	*
9ea1fd3c PL	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.
b97bf3fd	19	*
9ea1fd3c PL	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
b97bf3fd PL	34	* POSSIBILITY OF SUCH DAMAGE.
	35	*/
	36
	37	#ifndef _TIPC_NAME_TABLE_H
	38	#define _TIPC_NAME_TABLE_H
	39
fead3909	40	struct tipc_subscription;
3c724acd	41	struct tipc_plist;
2ae0b8af	42	struct tipc_nlist;
75da2163	43	struct tipc_group;
b97bf3fd PL	44
	45	/*
	46	* TIPC name types reserved for internal TIPC use (both current and planned)
	47	*/
993bfe5d YX	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 */
b97bf3fd	51
b97bf3fd PL	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
e50e73e1 JM	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
	60	* @key: publication key, unique across the cluster
	61	* @binding_node: all publications from the same node which bound this one
	62	* - Remote publications: in node->publ_list
	63	* Used by node/name distr to withdraw publications when node is lost
	64	* - Local/node scope publications: in name_table->node_scope list
	65	* - Local/cluster scope publications: in name_table->cluster_scope list
	66	* @binding_sock: all publications from the same socket which bound this one
	67	* Used by socket to withdraw publications when socket is unbound/released
	68	* @local_publ: list of identical publications made from this node
	69	* Used by closest_first and multicast receive lookup algorithms
	70	* @all_publ: all publications identical to this one, whatever node and scope
	71	* Used by round-robin lookup algorithm
97ede29e	72	* @rcu: RCU callback head used for deferred freeing
b97bf3fd	73	*/
b97bf3fd PL	74	struct publication {
	75	u32 type;
	76	u32 lower;
	77	u32 upper;
	78	u32 scope;
	79	u32 node;
e50e73e1	80	u32 port;
b97bf3fd	81	u32 key;
935439cc	82	struct list_head binding_node;
e50e73e1 JM	83	struct list_head binding_sock;
	84	struct list_head local_publ;
	85	struct list_head all_publ;
97ede29e	86	struct rcu_head rcu;
b97bf3fd PL	87	};
b97bf3fd PL	88
993bfe5d YX	89	/**
	90	* struct name_table - table containing all existing port name publications
	91	* @seq_hlist: name sequence hash lists
64a52b26	92	* @node_scope: all local publications with node scope
e50e73e1	93	* - used by name_distr during re-init of name table
64a52b26	94	* @cluster_scope: all local publications with cluster scope
e50e73e1 JM	95	* - used by name_distr to send bulk updates to new nodes
e50e73e1 JM	96	* - used by name_distr during re-init of name table
993bfe5d YX	97	* @local_publ_count: number of publications issued by this node
	98	*/
	99	struct name_table {
218527fe	100	struct hlist_head services[TIPC_NAMETBL_SIZE];
64a52b26 JM	101	struct list_head node_scope;
64a52b26 JM	102	struct list_head cluster_scope;
993bfe5d YX	103	u32 local_publ_count;
993bfe5d YX	104	};
b97bf3fd	105
1593123a RA	106	int tipc_nl_name_table_dump(struct sk_buff skb, struct netlink_callback cb);
1593123a RA	107
4ac1c8d0	108	u32 tipc_nametbl_translate(struct net net, u32 type, u32 instance, u32 node);
ba765ec6 JM	109	void tipc_nametbl_mc_lookup(struct net *net, u32 type, u32 lower, u32 upper,
ba765ec6 JM	110	u32 scope, bool exact, struct list_head *dports);
75da2163 JM	111	void tipc_nametbl_build_group(struct net net, struct tipc_group grp,
75da2163 JM	112	u32 type, u32 domain);
2ae0b8af	113	void tipc_nametbl_lookup_dst_nodes(struct net *net, u32 type, u32 lower,
e9a03445	114	u32 upper, struct tipc_nlist *nodes);
ee106d7f JM	115	bool tipc_nametbl_lookup(struct net *net, u32 type, u32 instance, u32 domain,
	116	struct list_head dsts, int dstcnt, u32 exclude,
	117	bool all);
f2f9800d	118	struct publication tipc_nametbl_publish(struct net net, u32 type, u32 lower,
37922ea4	119	u32 upper, u32 scope, u32 port,
f2f9800d	120	u32 key);
37922ea4	121	int tipc_nametbl_withdraw(struct net *net, u32 type, u32 lower, u32 upper,
f2f9800d	122	u32 key);
4ac1c8d0 YX	123	struct publication tipc_nametbl_insert_publ(struct net net, u32 type,
	124	u32 lower, u32 upper, u32 scope,
	125	u32 node, u32 ref, u32 key);
	126	struct publication tipc_nametbl_remove_publ(struct net net, u32 type,
37922ea4 JM	127	u32 lower, u32 upper,
37922ea4 JM	128	u32 node, u32 key);
c3317f4d	129	bool tipc_nametbl_subscribe(struct tipc_subscription *s);
fead3909	130	void tipc_nametbl_unsubscribe(struct tipc_subscription *s);
4ac1c8d0 YX	131	int tipc_nametbl_init(struct net *net);
4ac1c8d0 YX	132	void tipc_nametbl_stop(struct net *net);
b97bf3fd	133
a80ae530	134	struct tipc_dest {
2ae0b8af	135	struct list_head list;
a80ae530 JM	136	union {
	137	struct {
	138	u32 port;
	139	u32 node;
	140	};
	141	u64 value;
	142	};
2ae0b8af JPM	143	};
2ae0b8af JPM	144
a80ae530 JM	145	struct tipc_dest tipc_dest_find(struct list_head l, u32 node, u32 port);
	146	bool tipc_dest_push(struct list_head *l, u32 node, u32 port);
	147	bool tipc_dest_pop(struct list_head l, u32 node, u32 *port);
	148	bool tipc_dest_del(struct list_head *l, u32 node, u32 port);
	149	void tipc_dest_list_purge(struct list_head *l);
	150	int tipc_dest_list_len(struct list_head *l);
3c724acd	151
b97bf3fd	152	#endif