[mirror_ubuntu-artful-kernel.git] / net / tipc / name_table.h

/*
 * net/tipc/name_table.h: Include file for TIPC name table code
 *
 * Copyright (c) 2000-2006, 2014-2015, 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;

/*
 * 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
 * @node: network address of publishing port's node
 * @ref: publishing port
 * @key: publication key
 * @nodesub_list: subscription to "node down" event (off-node publication only)
 * @local_list: adjacent entries in list of publications made by this node
 * @pport_list: adjacent entries in list of publications made by this port
 * @node_list: adjacent matching name seq publications with >= node scope
 * @cluster_list: adjacent matching name seq publications with >= cluster scope
 * @zone_list: adjacent matching name seq publications with >= zone scope
 * @rcu: RCU callback head used for deferred freeing
 *
 * Note that the node list, cluster list, and zone list are circular lists.
 */
struct publication {
	u32 type;
	u32 lower;
	u32 upper;
	u32 scope;
	u32 node;
	u32 ref;
	u32 key;
	struct list_head nodesub_list;
	struct list_head local_list;
	struct list_head pport_list;
	struct list_head node_list;
	struct list_head cluster_list;
	struct list_head zone_list;
	struct rcu_head rcu;
};

/**
 * struct name_table - table containing all existing port name publications
 * @seq_hlist: name sequence hash lists
 * @publ_list: pulication lists
 * @local_publ_count: number of publications issued by this node
 */
struct name_table {
	struct hlist_head seq_hlist[TIPC_NAMETBL_SIZE];
	struct list_head publ_list[TIPC_PUBL_SCOPE_NUM];
	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);
int tipc_nametbl_mc_translate(struct net *net, u32 type, u32 lower, u32 upper,
			      u32 limit, struct list_head *dports);
void tipc_nametbl_lookup_dst_nodes(struct net *net, u32 type, u32 lower,
				   u32 upper, u32 domain,
				   struct tipc_nlist *nodes);
struct publication *tipc_nametbl_publish(struct net *net, u32 type, u32 lower,
					 u32 upper, u32 scope, u32 port_ref,
					 u32 key);
int tipc_nametbl_withdraw(struct net *net, u32 type, u32 lower, u32 ref,
			  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 node, u32 ref,
					     u32 key);
void 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 u32_item {
	struct list_head list;
	u32 value;
};

bool u32_push(struct list_head *l, u32 value);
u32 u32_pop(struct list_head *l);
bool u32_find(struct list_head *l, u32 value);
bool u32_del(struct list_head *l, u32 value);
void u32_list_purge(struct list_head *l);
int u32_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	*
cb1b7280	4	* Copyright (c) 2000-2006, 2014-2015, 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;
b97bf3fd PL	43
	44	/*
	45	* TIPC name types reserved for internal TIPC use (both current and planned)
	46	*/
993bfe5d YX	47	#define TIPC_ZM_SRV 3 /* zone master service name type */
	48	#define TIPC_PUBL_SCOPE_NUM (TIPC_NODE_SCOPE + 1)
	49	#define TIPC_NAMETBL_SIZE 1024 /* must be a power of 2 */
b97bf3fd	50
b97bf3fd PL	51	/**
	52	* struct publication - info about a published (name or) name sequence
	53	* @type: name sequence type
	54	* @lower: name sequence lower bound
	55	* @upper: name sequence upper bound
	56	* @scope: scope of publication
	57	* @node: network address of publishing port's node
	58	* @ref: publishing port
	59	* @key: publication key
a8f48af5	60	* @nodesub_list: subscription to "node down" event (off-node publication only)
b97bf3fd PL	61	* @local_list: adjacent entries in list of publications made by this node
b97bf3fd PL	62	* @pport_list: adjacent entries in list of publications made by this port
f6f0a4d2 AS	63	* @node_list: adjacent matching name seq publications with >= node scope
	64	* @cluster_list: adjacent matching name seq publications with >= cluster scope
	65	* @zone_list: adjacent matching name seq publications with >= zone scope
97ede29e	66	* @rcu: RCU callback head used for deferred freeing
c4307285	67	*
b97bf3fd PL	68	* Note that the node list, cluster list, and zone list are circular lists.
b97bf3fd PL	69	*/
b97bf3fd PL	70	struct publication {
	71	u32 type;
	72	u32 lower;
	73	u32 upper;
	74	u32 scope;
	75	u32 node;
	76	u32 ref;
	77	u32 key;
a8f48af5	78	struct list_head nodesub_list;
b97bf3fd PL	79	struct list_head local_list;
b97bf3fd PL	80	struct list_head pport_list;
f6f0a4d2 AS	81	struct list_head node_list;
	82	struct list_head cluster_list;
	83	struct list_head zone_list;
97ede29e	84	struct rcu_head rcu;
b97bf3fd PL	85	};
b97bf3fd PL	86
993bfe5d YX	87	/**
	88	* struct name_table - table containing all existing port name publications
	89	* @seq_hlist: name sequence hash lists
	90	* @publ_list: pulication lists
	91	* @local_publ_count: number of publications issued by this node
	92	*/
	93	struct name_table {
	94	struct hlist_head seq_hlist[TIPC_NAMETBL_SIZE];
	95	struct list_head publ_list[TIPC_PUBL_SCOPE_NUM];
	96	u32 local_publ_count;
	97	};
b97bf3fd	98
1593123a RA	99	int tipc_nl_name_table_dump(struct sk_buff skb, struct netlink_callback cb);
1593123a RA	100
4ac1c8d0 YX	101	u32 tipc_nametbl_translate(struct net net, u32 type, u32 instance, u32 node);
4ac1c8d0 YX	102	int tipc_nametbl_mc_translate(struct net *net, u32 type, u32 lower, u32 upper,
4d8642d8	103	u32 limit, struct list_head *dports);
2ae0b8af JPM	104	void tipc_nametbl_lookup_dst_nodes(struct net *net, u32 type, u32 lower,
	105	u32 upper, u32 domain,
	106	struct tipc_nlist *nodes);
f2f9800d YX	107	struct publication tipc_nametbl_publish(struct net net, u32 type, u32 lower,
	108	u32 upper, u32 scope, u32 port_ref,
	109	u32 key);
	110	int tipc_nametbl_withdraw(struct net *net, u32 type, u32 lower, u32 ref,
	111	u32 key);
4ac1c8d0 YX	112	struct publication tipc_nametbl_insert_publ(struct net net, u32 type,
	113	u32 lower, u32 upper, u32 scope,
	114	u32 node, u32 ref, u32 key);
	115	struct publication tipc_nametbl_remove_publ(struct net net, u32 type,
	116	u32 lower, u32 node, u32 ref,
ae8509c4	117	u32 key);
fead3909 PG	118	void tipc_nametbl_subscribe(struct tipc_subscription *s);
fead3909 PG	119	void tipc_nametbl_unsubscribe(struct tipc_subscription *s);
4ac1c8d0 YX	120	int tipc_nametbl_init(struct net *net);
4ac1c8d0 YX	121	void tipc_nametbl_stop(struct net *net);
b97bf3fd	122
2ae0b8af JPM	123	struct u32_item {
	124	struct list_head list;
	125	u32 value;
	126	};
	127
4d8642d8 JPM	128	bool u32_push(struct list_head *l, u32 value);
	129	u32 u32_pop(struct list_head *l);
	130	bool u32_find(struct list_head *l, u32 value);
	131	bool u32_del(struct list_head *l, u32 value);
	132	void u32_list_purge(struct list_head *l);
	133	int u32_list_len(struct list_head *l);
3c724acd	134
b97bf3fd	135	#endif