tipc: Remove prototype code for supporting multiple zones
[linux-2.6.git] / net / tipc / discover.c
1 /*
2  * net/tipc/discover.c
3  *
4  * Copyright (c) 2003-2006, Ericsson AB
5  * Copyright (c) 2005-2006, 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 #include "core.h"
38 #include "link.h"
39 #include "discover.h"
40 #include "port.h"
41 #include "name_table.h"
42
43 #define TIPC_LINK_REQ_INIT      125     /* min delay during bearer start up */
44 #define TIPC_LINK_REQ_FAST      2000    /* normal delay if bearer has no links */
45 #define TIPC_LINK_REQ_SLOW      600000  /* normal delay if bearer has links */
46
47 /*
48  * TODO: Most of the inter-cluster setup stuff should be
49  * rewritten, and be made conformant with specification.
50  */
51
52
53 /**
54  * struct link_req - information about an ongoing link setup request
55  * @bearer: bearer issuing requests
56  * @dest: destination address for request messages
57  * @buf: request message to be (repeatedly) sent
58  * @timer: timer governing period between requests
59  * @timer_intv: current interval between requests (in ms)
60  */
61 struct link_req {
62         struct bearer *bearer;
63         struct tipc_media_addr dest;
64         struct sk_buff *buf;
65         struct timer_list timer;
66         unsigned int timer_intv;
67 };
68
69 /**
70  * tipc_disc_init_msg - initialize a link setup message
71  * @type: message type (request or response)
72  * @req_links: number of links associated with message
73  * @dest_domain: network domain of node(s) which should respond to message
74  * @b_ptr: ptr to bearer issuing message
75  */
76
77 static struct sk_buff *tipc_disc_init_msg(u32 type,
78                                           u32 req_links,
79                                           u32 dest_domain,
80                                           struct bearer *b_ptr)
81 {
82         struct sk_buff *buf = tipc_buf_acquire(DSC_H_SIZE);
83         struct tipc_msg *msg;
84
85         if (buf) {
86                 msg = buf_msg(buf);
87                 tipc_msg_init(msg, LINK_CONFIG, type, DSC_H_SIZE, dest_domain);
88                 msg_set_non_seq(msg, 1);
89                 msg_set_req_links(msg, req_links);
90                 msg_set_dest_domain(msg, dest_domain);
91                 msg_set_bc_netid(msg, tipc_net_id);
92                 msg_set_media_addr(msg, &b_ptr->publ.addr);
93         }
94         return buf;
95 }
96
97 /**
98  * disc_dupl_alert - issue node address duplication alert
99  * @b_ptr: pointer to bearer detecting duplication
100  * @node_addr: duplicated node address
101  * @media_addr: media address advertised by duplicated node
102  */
103
104 static void disc_dupl_alert(struct bearer *b_ptr, u32 node_addr,
105                             struct tipc_media_addr *media_addr)
106 {
107         char node_addr_str[16];
108         char media_addr_str[64];
109         struct print_buf pb;
110
111         tipc_addr_string_fill(node_addr_str, node_addr);
112         tipc_printbuf_init(&pb, media_addr_str, sizeof(media_addr_str));
113         tipc_media_addr_printf(&pb, media_addr);
114         tipc_printbuf_validate(&pb);
115         warn("Duplicate %s using %s seen on <%s>\n",
116              node_addr_str, media_addr_str, b_ptr->publ.name);
117 }
118
119 /**
120  * tipc_disc_recv_msg - handle incoming link setup message (request or response)
121  * @buf: buffer containing message
122  * @b_ptr: bearer that message arrived on
123  */
124
125 void tipc_disc_recv_msg(struct sk_buff *buf, struct bearer *b_ptr)
126 {
127         struct link *link;
128         struct tipc_media_addr media_addr;
129         struct tipc_msg *msg = buf_msg(buf);
130         u32 dest = msg_dest_domain(msg);
131         u32 orig = msg_prevnode(msg);
132         u32 net_id = msg_bc_netid(msg);
133         u32 type = msg_type(msg);
134
135         msg_get_media_addr(msg,&media_addr);
136         msg_dbg(msg, "RECV:");
137         buf_discard(buf);
138
139         if (net_id != tipc_net_id)
140                 return;
141         if (!tipc_addr_domain_valid(dest))
142                 return;
143         if (!tipc_addr_node_valid(orig))
144                 return;
145         if (orig == tipc_own_addr) {
146                 if (memcmp(&media_addr, &b_ptr->publ.addr, sizeof(media_addr)))
147                         disc_dupl_alert(b_ptr, tipc_own_addr, &media_addr);
148                 return;
149         }
150         if (!tipc_in_scope(dest, tipc_own_addr))
151                 return;
152         if (is_slave(tipc_own_addr) && is_slave(orig))
153                 return;
154         if (is_slave(orig) && !in_own_cluster(orig))
155                 return;
156         if (in_own_cluster(orig)) {
157                 /* Always accept link here */
158                 struct sk_buff *rbuf;
159                 struct tipc_media_addr *addr;
160                 struct tipc_node *n_ptr = tipc_node_find(orig);
161                 int link_fully_up;
162
163                 dbg(" in own cluster\n");
164                 if (n_ptr == NULL) {
165                         n_ptr = tipc_node_create(orig);
166                         if (!n_ptr)
167                                 return;
168                 }
169                 spin_lock_bh(&n_ptr->lock);
170
171                 /* Don't talk to neighbor during cleanup after last session */
172
173                 if (n_ptr->cleanup_required) {
174                         spin_unlock_bh(&n_ptr->lock);
175                         return;
176                 }
177
178                 link = n_ptr->links[b_ptr->identity];
179                 if (!link) {
180                         dbg("creating link\n");
181                         link = tipc_link_create(b_ptr, orig, &media_addr);
182                         if (!link) {
183                                 spin_unlock_bh(&n_ptr->lock);
184                                 return;
185                         }
186                 }
187                 addr = &link->media_addr;
188                 if (memcmp(addr, &media_addr, sizeof(*addr))) {
189                         if (tipc_link_is_up(link) || (!link->started)) {
190                                 disc_dupl_alert(b_ptr, orig, &media_addr);
191                                 spin_unlock_bh(&n_ptr->lock);
192                                 return;
193                         }
194                         warn("Resetting link <%s>, peer interface address changed\n",
195                              link->name);
196                         memcpy(addr, &media_addr, sizeof(*addr));
197                         tipc_link_reset(link);
198                 }
199                 link_fully_up = link_working_working(link);
200                 spin_unlock_bh(&n_ptr->lock);
201                 if ((type == DSC_RESP_MSG) || link_fully_up)
202                         return;
203                 rbuf = tipc_disc_init_msg(DSC_RESP_MSG, 1, orig, b_ptr);
204                 if (rbuf != NULL) {
205                         msg_dbg(buf_msg(rbuf),"SEND:");
206                         b_ptr->media->send_msg(rbuf, &b_ptr->publ, &media_addr);
207                         buf_discard(rbuf);
208                 }
209         }
210 }
211
212 /**
213  * tipc_disc_stop_link_req - stop sending periodic link setup requests
214  * @req: ptr to link request structure
215  */
216
217 void tipc_disc_stop_link_req(struct link_req *req)
218 {
219         if (!req)
220                 return;
221
222         k_cancel_timer(&req->timer);
223         k_term_timer(&req->timer);
224         buf_discard(req->buf);
225         kfree(req);
226 }
227
228 /**
229  * tipc_disc_update_link_req - update frequency of periodic link setup requests
230  * @req: ptr to link request structure
231  */
232
233 void tipc_disc_update_link_req(struct link_req *req)
234 {
235         if (!req)
236                 return;
237
238         if (req->timer_intv == TIPC_LINK_REQ_SLOW) {
239                 if (!req->bearer->nodes.count) {
240                         req->timer_intv = TIPC_LINK_REQ_FAST;
241                         k_start_timer(&req->timer, req->timer_intv);
242                 }
243         } else if (req->timer_intv == TIPC_LINK_REQ_FAST) {
244                 if (req->bearer->nodes.count) {
245                         req->timer_intv = TIPC_LINK_REQ_SLOW;
246                         k_start_timer(&req->timer, req->timer_intv);
247                 }
248         } else {
249                 /* leave timer "as is" if haven't yet reached a "normal" rate */
250         }
251 }
252
253 /**
254  * disc_timeout - send a periodic link setup request
255  * @req: ptr to link request structure
256  *
257  * Called whenever a link setup request timer associated with a bearer expires.
258  */
259
260 static void disc_timeout(struct link_req *req)
261 {
262         spin_lock_bh(&req->bearer->publ.lock);
263
264         req->bearer->media->send_msg(req->buf, &req->bearer->publ, &req->dest);
265
266         if ((req->timer_intv == TIPC_LINK_REQ_SLOW) ||
267             (req->timer_intv == TIPC_LINK_REQ_FAST)) {
268                 /* leave timer interval "as is" if already at a "normal" rate */
269         } else {
270                 req->timer_intv *= 2;
271                 if (req->timer_intv > TIPC_LINK_REQ_FAST)
272                         req->timer_intv = TIPC_LINK_REQ_FAST;
273                 if ((req->timer_intv == TIPC_LINK_REQ_FAST) &&
274                     (req->bearer->nodes.count))
275                         req->timer_intv = TIPC_LINK_REQ_SLOW;
276         }
277         k_start_timer(&req->timer, req->timer_intv);
278
279         spin_unlock_bh(&req->bearer->publ.lock);
280 }
281
282 /**
283  * tipc_disc_init_link_req - start sending periodic link setup requests
284  * @b_ptr: ptr to bearer issuing requests
285  * @dest: destination address for request messages
286  * @dest_domain: network domain of node(s) which should respond to message
287  * @req_links: max number of desired links
288  *
289  * Returns pointer to link request structure, or NULL if unable to create.
290  */
291
292 struct link_req *tipc_disc_init_link_req(struct bearer *b_ptr,
293                                          const struct tipc_media_addr *dest,
294                                          u32 dest_domain,
295                                          u32 req_links)
296 {
297         struct link_req *req;
298
299         req = kmalloc(sizeof(*req), GFP_ATOMIC);
300         if (!req)
301                 return NULL;
302
303         req->buf = tipc_disc_init_msg(DSC_REQ_MSG, req_links, dest_domain, b_ptr);
304         if (!req->buf) {
305                 kfree(req);
306                 return NULL;
307         }
308
309         memcpy(&req->dest, dest, sizeof(*dest));
310         req->bearer = b_ptr;
311         req->timer_intv = TIPC_LINK_REQ_INIT;
312         k_init_timer(&req->timer, (Handler)disc_timeout, (unsigned long)req);
313         k_start_timer(&req->timer, req->timer_intv);
314         return req;
315 }
316