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

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

#include "node_subscr.h"

struct subscription;
struct port_list;

/*
 * TIPC name types reserved for internal TIPC use (both current and planned)
 */

#define TIPC_ZM_SRV 3  		/* zone master service name type */


/**
 * 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
 * @subscr: subscription to "node down" event (for off-node publications 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: next matching name seq publication with >= node scope
 * @cluster_list: next matching name seq publication with >= cluster scope
 * @zone_list: next matching name seq publication with >= zone scope
 *
 * 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 tipc_node_subscr subscr;
	struct list_head local_list;
	struct list_head pport_list;
	struct publication *node_list_next;
	struct publication *cluster_list_next;
	struct publication *zone_list_next;
};


extern rwlock_t tipc_nametbl_lock;

struct sk_buff *tipc_nametbl_get(const void *req_tlv_area, int req_tlv_space);
u32 tipc_nametbl_translate(u32 type, u32 instance, u32 *node);
int tipc_nametbl_mc_translate(u32 type, u32 lower, u32 upper, u32 limit,
			 struct port_list *dports);
int tipc_nametbl_publish_rsv(u32 ref, unsigned int scope,
			struct tipc_name_seq const *seq);
struct publication *tipc_nametbl_publish(u32 type, u32 lower, u32 upper,
				    u32 scope, u32 port_ref, u32 key);
int tipc_nametbl_withdraw(u32 type, u32 lower, u32 ref, u32 key);
struct publication *tipc_nametbl_insert_publ(u32 type, u32 lower, u32 upper,
					u32 scope, u32 node, u32 ref, u32 key);
struct publication *tipc_nametbl_remove_publ(u32 type, u32 lower,
					u32 node, u32 ref, u32 key);
void tipc_nametbl_subscribe(struct subscription *s);
void tipc_nametbl_unsubscribe(struct subscription *s);
int tipc_nametbl_init(void);
void tipc_nametbl_stop(void);

#endif
Commit	Line	Data
b97bf3fd PL	1	/*
b97bf3fd PL	2	* net/tipc/name_table.h: Include file for TIPC name table code
c4307285	3	*
593a5f22	4	* Copyright (c) 2000-2006, Ericsson AB
b97bf3fd	5	* Copyright (c) 2004-2005, 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
	40	#include "node_subscr.h"
	41
	42	struct subscription;
	43	struct port_list;
	44
	45	/*
	46	* TIPC name types reserved for internal TIPC use (both current and planned)
	47	*/
	48
	49	#define TIPC_ZM_SRV 3 /* zone master service name type */
	50
	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	* @subscr: subscription to "node down" event (for off-node publications 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: next matching name seq publication with >= node scope
	65	* @cluster_list: next matching name seq publication with >= cluster scope
	66	* @zone_list: next matching name seq publication with >= zone scope
c4307285	67	*
b97bf3fd PL	68	* Note that the node list, cluster list, and zone list are circular lists.
	69	*/
	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;
6c00055a	79	struct tipc_node_subscr subscr;
b97bf3fd PL	80	struct list_head local_list;
	81	struct list_head pport_list;
	82	struct publication *node_list_next;
	83	struct publication *cluster_list_next;
	84	struct publication *zone_list_next;
	85	};
	86
	87
4323add6	88	extern rwlock_t tipc_nametbl_lock;
b97bf3fd	89
4323add6 PL	90	struct sk_buff tipc_nametbl_get(const void req_tlv_area, int req_tlv_space);
4323add6 PL	91	u32 tipc_nametbl_translate(u32 type, u32 instance, u32 *node);
c4307285	92	int tipc_nametbl_mc_translate(u32 type, u32 lower, u32 upper, u32 limit,
b97bf3fd	93	struct port_list *dports);
c4307285	94	int tipc_nametbl_publish_rsv(u32 ref, unsigned int scope,
b97bf3fd	95	struct tipc_name_seq const *seq);
4323add6	96	struct publication *tipc_nametbl_publish(u32 type, u32 lower, u32 upper,
b97bf3fd	97	u32 scope, u32 port_ref, u32 key);
4323add6 PL	98	int tipc_nametbl_withdraw(u32 type, u32 lower, u32 ref, u32 key);
4323add6 PL	99	struct publication *tipc_nametbl_insert_publ(u32 type, u32 lower, u32 upper,
b97bf3fd	100	u32 scope, u32 node, u32 ref, u32 key);
c4307285	101	struct publication *tipc_nametbl_remove_publ(u32 type, u32 lower,
b97bf3fd	102	u32 node, u32 ref, u32 key);
4323add6 PL	103	void tipc_nametbl_subscribe(struct subscription *s);
	104	void tipc_nametbl_unsubscribe(struct subscription *s);
	105	int tipc_nametbl_init(void);
	106	void tipc_nametbl_stop(void);
b97bf3fd PL	107
b97bf3fd PL	108	#endif