8e3749cf9b71e7b5e0240a6ea155a033e6d7c104
[linux-3.10.git] / net / tipc / name_table.h
1 /*
2  * net/tipc/name_table.h: Include file for TIPC name table code
3  * 
4  * Copyright (c) 2003-2005, Ericsson Research Canada
5  * Copyright (c) 2004-2005, Wind River Systems
6  * Copyright (c) 2005-2006, Ericsson AB
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 #include "node_subscr.h"
42
43 struct subscription;
44 struct port_list;
45
46 /*
47  * TIPC name types reserved for internal TIPC use (both current and planned)
48  */
49
50 #define TIPC_ZM_SRV 3           /* zone master service name type */
51
52
53 /**
54  * struct publication - info about a published (name or) name sequence
55  * @type: name sequence type
56  * @lower: name sequence lower bound
57  * @upper: name sequence upper bound
58  * @scope: scope of publication
59  * @node: network address of publishing port's node
60  * @ref: publishing port
61  * @key: publication key
62  * @subscr: subscription to "node down" event (for off-node publications only)
63  * @local_list: adjacent entries in list of publications made by this node
64  * @pport_list: adjacent entries in list of publications made by this port
65  * @node_list: next matching name seq publication with >= node scope
66  * @cluster_list: next matching name seq publication with >= cluster scope
67  * @zone_list: next matching name seq publication with >= zone scope
68  * 
69  * Note that the node list, cluster list, and zone list are circular lists.
70  */
71
72 struct publication {
73         u32 type;
74         u32 lower;
75         u32 upper;
76         u32 scope;
77         u32 node;
78         u32 ref;
79         u32 key;
80         struct node_subscr subscr;
81         struct list_head local_list;
82         struct list_head pport_list;
83         struct publication *node_list_next;
84         struct publication *cluster_list_next;
85         struct publication *zone_list_next;
86 };
87
88
89 extern rwlock_t nametbl_lock;
90
91 struct sk_buff *nametbl_get(const void *req_tlv_area, int req_tlv_space);
92 u32 nametbl_translate(u32 type, u32 instance, u32 *node);
93 int nametbl_mc_translate(u32 type, u32 lower, u32 upper, u32 limit, 
94                          struct port_list *dports);
95 int nametbl_publish_rsv(u32 ref, unsigned int scope, 
96                         struct tipc_name_seq const *seq);
97 struct publication *nametbl_publish(u32 type, u32 lower, u32 upper,
98                                     u32 scope, u32 port_ref, u32 key);
99 int nametbl_withdraw(u32 type, u32 lower, u32 ref, u32 key);
100 struct publication *nametbl_insert_publ(u32 type, u32 lower, u32 upper,
101                                         u32 scope, u32 node, u32 ref, u32 key);
102 struct publication *nametbl_remove_publ(u32 type, u32 lower, 
103                                         u32 node, u32 ref, u32 key);
104 void nametbl_subscribe(struct subscription *s);
105 void nametbl_unsubscribe(struct subscription *s);
106 int nametbl_init(void);
107 void nametbl_stop(void);
108
109 #endif