tipc: Remove prototype code for supporting inter-cluster routing
[linux-2.6.git] / net / tipc / node.h
1 /*
2  * net/tipc/node.h: Include file for TIPC node management routines
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_NODE_H
38 #define _TIPC_NODE_H
39
40 #include "node_subscr.h"
41 #include "cluster.h"
42 #include "bearer.h"
43
44 /**
45  * struct tipc_node - TIPC node structure
46  * @addr: network address of node
47  * @lock: spinlock governing access to structure
48  * @owner: pointer to cluster that node belongs to
49  * @next: pointer to next node in sorted list of cluster's nodes
50  * @nsub: list of "node down" subscriptions monitoring node
51  * @active_links: pointers to active links to node
52  * @links: pointers to all links to node
53  * @working_links: number of working links to node (both active and standby)
54  * @cleanup_required: non-zero if cleaning up after a prior loss of contact
55  * @link_cnt: number of links to node
56  * @permit_changeover: non-zero if node has redundant links to this system
57  * @bclink: broadcast-related info
58  *    @supported: non-zero if node supports TIPC b'cast capability
59  *    @acked: sequence # of last outbound b'cast message acknowledged by node
60  *    @last_in: sequence # of last in-sequence b'cast message received from node
61  *    @gap_after: sequence # of last message not requiring a NAK request
62  *    @gap_to: sequence # of last message requiring a NAK request
63  *    @nack_sync: counter that determines when NAK requests should be sent
64  *    @deferred_head: oldest OOS b'cast message received from node
65  *    @deferred_tail: newest OOS b'cast message received from node
66  *    @defragm: list of partially reassembled b'cast message fragments from node
67  */
68
69 struct tipc_node {
70         u32 addr;
71         spinlock_t lock;
72         struct cluster *owner;
73         struct tipc_node *next;
74         struct list_head nsub;
75         struct link *active_links[2];
76         struct link *links[MAX_BEARERS];
77         int link_cnt;
78         int working_links;
79         int cleanup_required;
80         int permit_changeover;
81         struct {
82                 int supported;
83                 u32 acked;
84                 u32 last_in;
85                 u32 gap_after;
86                 u32 gap_to;
87                 u32 nack_sync;
88                 struct sk_buff *deferred_head;
89                 struct sk_buff *deferred_tail;
90                 struct sk_buff *defragm;
91         } bclink;
92 };
93
94 extern u32 tipc_own_tag;
95
96 struct tipc_node *tipc_node_create(u32 addr);
97 void tipc_node_delete(struct tipc_node *n_ptr);
98 struct tipc_node *tipc_node_attach_link(struct link *l_ptr);
99 void tipc_node_detach_link(struct tipc_node *n_ptr, struct link *l_ptr);
100 void tipc_node_link_down(struct tipc_node *n_ptr, struct link *l_ptr);
101 void tipc_node_link_up(struct tipc_node *n_ptr, struct link *l_ptr);
102 int tipc_node_has_active_links(struct tipc_node *n_ptr);
103 int tipc_node_has_redundant_links(struct tipc_node *n_ptr);
104 int tipc_node_is_up(struct tipc_node *n_ptr);
105 struct sk_buff *tipc_node_get_links(const void *req_tlv_area, int req_tlv_space);
106 struct sk_buff *tipc_node_get_nodes(const void *req_tlv_area, int req_tlv_space);
107
108 static inline struct tipc_node *tipc_node_find(u32 addr)
109 {
110         if (likely(in_own_cluster(addr)))
111                 return tipc_local_nodes[tipc_node(addr)];
112         return NULL;
113 }
114
115 static inline void tipc_node_lock(struct tipc_node *n_ptr)
116 {
117         spin_lock_bh(&n_ptr->lock);
118 }
119
120 static inline void tipc_node_unlock(struct tipc_node *n_ptr)
121 {
122         spin_unlock_bh(&n_ptr->lock);
123 }
124
125 #endif