xref: /linux/net/tipc/name_distr.h (revision 3d0fe49454652117522f60bfbefb978ba0e5300b)
1 /*
2  * net/tipc/name_distr.h: Include file for TIPC name distribution code
3  *
4  * Copyright (c) 2000-2006, Ericsson AB
5  * Copyright (c) 2005, Wind River Systems
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are met:
10  *
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.
19  *
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
34  * POSSIBILITY OF SUCH DAMAGE.
35  */
36 
37 #ifndef _TIPC_NAME_DISTR_H
38 #define _TIPC_NAME_DISTR_H
39 
40 #include "name_table.h"
41 
42 #define ITEM_SIZE sizeof(struct distr_item)
43 
44 /**
45  * struct distr_item - publication info distributed to other nodes
46  * @type: name sequence type
47  * @lower: name sequence lower bound
48  * @upper: name sequence upper bound
49  * @port: publishing port reference
50  * @key: publication key
51  *
52  * ===> All fields are stored in network byte order. <===
53  *
54  * First 3 fields identify (name or) name sequence being published.
55  * Reference field uniquely identifies port that published name sequence.
56  * Key field uniquely identifies publication, in the event a port has
57  * multiple publications of the same name sequence.
58  *
59  * Note: There is no field that identifies the publishing node because it is
60  * the same for all items contained within a publication message.
61  */
62 struct distr_item {
63 	__be32 type;
64 	__be32 lower;
65 	__be32 upper;
66 	__be32 port;
67 	__be32 key;
68 };
69 
70 struct sk_buff *tipc_named_publish(struct net *net, struct publication *publ);
71 struct sk_buff *tipc_named_withdraw(struct net *net, struct publication *publ);
72 void tipc_named_node_up(struct net *net, u32 dnode, u16 capabilities);
73 void tipc_named_rcv(struct net *net, struct sk_buff_head *namedq,
74 		    u16 *rcv_nxt, bool *open);
75 void tipc_named_reinit(struct net *net);
76 void tipc_publ_notify(struct net *net, struct list_head *nsub_list,
77 		      u32 addr, u16 capabilities);
78 
79 #endif
80