tipc: Remove prototype code for supporting multiple zones
[linux-2.6.git] / net / tipc / cluster.c
1 /*
2  * net/tipc/cluster.c: TIPC cluster 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 #include "core.h"
38 #include "cluster.h"
39 #include "link.h"
40
41 static void tipc_cltr_multicast(struct cluster *c_ptr, struct sk_buff *buf,
42                                 u32 lower, u32 upper);
43
44 struct tipc_node **tipc_local_nodes = NULL;
45 struct tipc_node_map tipc_cltr_bcast_nodes = {0,{0,}};
46 u32 tipc_highest_allowed_slave = 0;
47
48 struct cluster *tipc_cltr_create(u32 addr)
49 {
50         struct cluster *c_ptr;
51         int max_nodes;
52
53         c_ptr = kzalloc(sizeof(*c_ptr), GFP_ATOMIC);
54         if (c_ptr == NULL) {
55                 warn("Cluster creation failure, no memory\n");
56                 return NULL;
57         }
58
59         c_ptr->addr = tipc_addr(tipc_zone(addr), tipc_cluster(addr), 0);
60         if (in_own_cluster(addr))
61                 max_nodes = LOWEST_SLAVE + tipc_max_slaves;
62         else
63                 max_nodes = tipc_max_nodes + 1;
64
65         c_ptr->nodes = kcalloc(max_nodes + 1, sizeof(void*), GFP_ATOMIC);
66         if (c_ptr->nodes == NULL) {
67                 warn("Cluster creation failure, no memory for node area\n");
68                 kfree(c_ptr);
69                 return NULL;
70         }
71
72         if (in_own_cluster(addr))
73                 tipc_local_nodes = c_ptr->nodes;
74         c_ptr->highest_slave = LOWEST_SLAVE - 1;
75         c_ptr->highest_node = 0;
76
77         tipc_net.clusters[1] = c_ptr;
78         return c_ptr;
79 }
80
81 void tipc_cltr_delete(struct cluster *c_ptr)
82 {
83         u32 n_num;
84
85         if (!c_ptr)
86                 return;
87         for (n_num = 1; n_num <= c_ptr->highest_node; n_num++) {
88                 tipc_node_delete(c_ptr->nodes[n_num]);
89         }
90         for (n_num = LOWEST_SLAVE; n_num <= c_ptr->highest_slave; n_num++) {
91                 tipc_node_delete(c_ptr->nodes[n_num]);
92         }
93         kfree(c_ptr->nodes);
94         kfree(c_ptr);
95 }
96
97
98 void tipc_cltr_attach_node(struct cluster *c_ptr, struct tipc_node *n_ptr)
99 {
100         u32 n_num = tipc_node(n_ptr->addr);
101         u32 max_n_num = tipc_max_nodes;
102
103         if (in_own_cluster(n_ptr->addr))
104                 max_n_num = tipc_highest_allowed_slave;
105         assert(n_num > 0);
106         assert(n_num <= max_n_num);
107         assert(c_ptr->nodes[n_num] == NULL);
108         c_ptr->nodes[n_num] = n_ptr;
109         if (n_num > c_ptr->highest_node)
110                 c_ptr->highest_node = n_num;
111 }
112
113 /**
114  * tipc_cltr_select_router - select router to a cluster
115  *
116  * Uses deterministic and fair algorithm.
117  */
118
119 u32 tipc_cltr_select_router(struct cluster *c_ptr, u32 ref)
120 {
121         u32 n_num;
122         u32 ulim = c_ptr->highest_node;
123         u32 mask;
124         u32 tstart;
125
126         assert(!in_own_cluster(c_ptr->addr));
127         if (!ulim)
128                 return 0;
129
130         /* Start entry must be random */
131         mask = tipc_max_nodes;
132         while (mask > ulim)
133                 mask >>= 1;
134         tstart = ref & mask;
135         n_num = tstart;
136
137         /* Lookup upwards with wrap-around */
138         do {
139                 if (tipc_node_is_up(c_ptr->nodes[n_num]))
140                         break;
141         } while (++n_num <= ulim);
142         if (n_num > ulim) {
143                 n_num = 1;
144                 do {
145                         if (tipc_node_is_up(c_ptr->nodes[n_num]))
146                                 break;
147                 } while (++n_num < tstart);
148                 if (n_num == tstart)
149                         return 0;
150         }
151         assert(n_num <= ulim);
152         return tipc_node_select_router(c_ptr->nodes[n_num], ref);
153 }
154
155 /**
156  * tipc_cltr_select_node - select destination node within a remote cluster
157  *
158  * Uses deterministic and fair algorithm.
159  */
160
161 struct tipc_node *tipc_cltr_select_node(struct cluster *c_ptr, u32 selector)
162 {
163         u32 n_num;
164         u32 mask = tipc_max_nodes;
165         u32 start_entry;
166
167         assert(!in_own_cluster(c_ptr->addr));
168         if (!c_ptr->highest_node)
169                 return NULL;
170
171         /* Start entry must be random */
172         while (mask > c_ptr->highest_node) {
173                 mask >>= 1;
174         }
175         start_entry = (selector & mask) ? selector & mask : 1u;
176         assert(start_entry <= c_ptr->highest_node);
177
178         /* Lookup upwards with wrap-around */
179         for (n_num = start_entry; n_num <= c_ptr->highest_node; n_num++) {
180                 if (tipc_node_has_active_links(c_ptr->nodes[n_num]))
181                         return c_ptr->nodes[n_num];
182         }
183         for (n_num = 1; n_num < start_entry; n_num++) {
184                 if (tipc_node_has_active_links(c_ptr->nodes[n_num]))
185                         return c_ptr->nodes[n_num];
186         }
187         return NULL;
188 }
189
190 /*
191  *    Routing table management: See description in node.c
192  */
193
194 static struct sk_buff *tipc_cltr_prepare_routing_msg(u32 data_size, u32 dest)
195 {
196         u32 size = INT_H_SIZE + data_size;
197         struct sk_buff *buf = tipc_buf_acquire(size);
198         struct tipc_msg *msg;
199
200         if (buf) {
201                 msg = buf_msg(buf);
202                 memset((char *)msg, 0, size);
203                 tipc_msg_init(msg, ROUTE_DISTRIBUTOR, 0, INT_H_SIZE, dest);
204         }
205         return buf;
206 }
207
208 void tipc_cltr_bcast_new_route(struct cluster *c_ptr, u32 dest,
209                              u32 lower, u32 upper)
210 {
211         struct sk_buff *buf = tipc_cltr_prepare_routing_msg(0, c_ptr->addr);
212         struct tipc_msg *msg;
213
214         if (buf) {
215                 msg = buf_msg(buf);
216                 msg_set_remote_node(msg, dest);
217                 msg_set_type(msg, ROUTE_ADDITION);
218                 tipc_cltr_multicast(c_ptr, buf, lower, upper);
219         } else {
220                 warn("Memory squeeze: broadcast of new route failed\n");
221         }
222 }
223
224 void tipc_cltr_bcast_lost_route(struct cluster *c_ptr, u32 dest,
225                                 u32 lower, u32 upper)
226 {
227         struct sk_buff *buf = tipc_cltr_prepare_routing_msg(0, c_ptr->addr);
228         struct tipc_msg *msg;
229
230         if (buf) {
231                 msg = buf_msg(buf);
232                 msg_set_remote_node(msg, dest);
233                 msg_set_type(msg, ROUTE_REMOVAL);
234                 tipc_cltr_multicast(c_ptr, buf, lower, upper);
235         } else {
236                 warn("Memory squeeze: broadcast of lost route failed\n");
237         }
238 }
239
240 void tipc_cltr_send_slave_routes(struct cluster *c_ptr, u32 dest)
241 {
242         struct sk_buff *buf;
243         struct tipc_msg *msg;
244         u32 highest = c_ptr->highest_slave;
245         u32 n_num;
246         int send = 0;
247
248         assert(!is_slave(dest));
249         assert(in_own_cluster(dest));
250         assert(in_own_cluster(c_ptr->addr));
251         if (highest <= LOWEST_SLAVE)
252                 return;
253         buf = tipc_cltr_prepare_routing_msg(highest - LOWEST_SLAVE + 1,
254                                             c_ptr->addr);
255         if (buf) {
256                 msg = buf_msg(buf);
257                 msg_set_remote_node(msg, c_ptr->addr);
258                 msg_set_type(msg, SLAVE_ROUTING_TABLE);
259                 for (n_num = LOWEST_SLAVE; n_num <= highest; n_num++) {
260                         if (c_ptr->nodes[n_num] &&
261                             tipc_node_has_active_links(c_ptr->nodes[n_num])) {
262                                 send = 1;
263                                 msg_set_dataoctet(msg, n_num);
264                         }
265                 }
266                 if (send)
267                         tipc_link_send(buf, dest, dest);
268                 else
269                         buf_discard(buf);
270         } else {
271                 warn("Memory squeeze: broadcast of lost route failed\n");
272         }
273 }
274
275 void tipc_cltr_send_ext_routes(struct cluster *c_ptr, u32 dest)
276 {
277         struct sk_buff *buf;
278         struct tipc_msg *msg;
279         u32 highest = c_ptr->highest_node;
280         u32 n_num;
281         int send = 0;
282
283         if (in_own_cluster(c_ptr->addr))
284                 return;
285         assert(!is_slave(dest));
286         assert(in_own_cluster(dest));
287         highest = c_ptr->highest_node;
288         buf = tipc_cltr_prepare_routing_msg(highest + 1, c_ptr->addr);
289         if (buf) {
290                 msg = buf_msg(buf);
291                 msg_set_remote_node(msg, c_ptr->addr);
292                 msg_set_type(msg, EXT_ROUTING_TABLE);
293                 for (n_num = 1; n_num <= highest; n_num++) {
294                         if (c_ptr->nodes[n_num] &&
295                             tipc_node_has_active_links(c_ptr->nodes[n_num])) {
296                                 send = 1;
297                                 msg_set_dataoctet(msg, n_num);
298                         }
299                 }
300                 if (send)
301                         tipc_link_send(buf, dest, dest);
302                 else
303                         buf_discard(buf);
304         } else {
305                 warn("Memory squeeze: broadcast of external route failed\n");
306         }
307 }
308
309 void tipc_cltr_send_local_routes(struct cluster *c_ptr, u32 dest)
310 {
311         struct sk_buff *buf;
312         struct tipc_msg *msg;
313         u32 highest = c_ptr->highest_node;
314         u32 n_num;
315         int send = 0;
316
317         assert(is_slave(dest));
318         assert(in_own_cluster(c_ptr->addr));
319         buf = tipc_cltr_prepare_routing_msg(highest, c_ptr->addr);
320         if (buf) {
321                 msg = buf_msg(buf);
322                 msg_set_remote_node(msg, c_ptr->addr);
323                 msg_set_type(msg, LOCAL_ROUTING_TABLE);
324                 for (n_num = 1; n_num <= highest; n_num++) {
325                         if (c_ptr->nodes[n_num] &&
326                             tipc_node_has_active_links(c_ptr->nodes[n_num])) {
327                                 send = 1;
328                                 msg_set_dataoctet(msg, n_num);
329                         }
330                 }
331                 if (send)
332                         tipc_link_send(buf, dest, dest);
333                 else
334                         buf_discard(buf);
335         } else {
336                 warn("Memory squeeze: broadcast of local route failed\n");
337         }
338 }
339
340 void tipc_cltr_recv_routing_table(struct sk_buff *buf)
341 {
342         struct tipc_msg *msg = buf_msg(buf);
343         struct cluster *c_ptr;
344         struct tipc_node *n_ptr;
345         unchar *node_table;
346         u32 table_size;
347         u32 router;
348         u32 rem_node = msg_remote_node(msg);
349         u32 z_num;
350         u32 c_num;
351         u32 n_num;
352
353         c_ptr = tipc_cltr_find(rem_node);
354         if (!c_ptr) {
355                 c_ptr = tipc_cltr_create(rem_node);
356                 if (!c_ptr) {
357                         buf_discard(buf);
358                         return;
359                 }
360         }
361
362         node_table = buf->data + msg_hdr_sz(msg);
363         table_size = msg_size(msg) - msg_hdr_sz(msg);
364         router = msg_prevnode(msg);
365         z_num = tipc_zone(rem_node);
366         c_num = tipc_cluster(rem_node);
367
368         switch (msg_type(msg)) {
369         case LOCAL_ROUTING_TABLE:
370                 assert(is_slave(tipc_own_addr));
371         case EXT_ROUTING_TABLE:
372                 for (n_num = 1; n_num < table_size; n_num++) {
373                         if (node_table[n_num]) {
374                                 u32 addr = tipc_addr(z_num, c_num, n_num);
375                                 n_ptr = c_ptr->nodes[n_num];
376                                 if (!n_ptr) {
377                                         n_ptr = tipc_node_create(addr);
378                                 }
379                                 if (n_ptr)
380                                         tipc_node_add_router(n_ptr, router);
381                         }
382                 }
383                 break;
384         case SLAVE_ROUTING_TABLE:
385                 assert(!is_slave(tipc_own_addr));
386                 assert(in_own_cluster(c_ptr->addr));
387                 for (n_num = 1; n_num < table_size; n_num++) {
388                         if (node_table[n_num]) {
389                                 u32 slave_num = n_num + LOWEST_SLAVE;
390                                 u32 addr = tipc_addr(z_num, c_num, slave_num);
391                                 n_ptr = c_ptr->nodes[slave_num];
392                                 if (!n_ptr) {
393                                         n_ptr = tipc_node_create(addr);
394                                 }
395                                 if (n_ptr)
396                                         tipc_node_add_router(n_ptr, router);
397                         }
398                 }
399                 break;
400         case ROUTE_ADDITION:
401                 if (!is_slave(tipc_own_addr)) {
402                         assert(!in_own_cluster(c_ptr->addr) ||
403                                is_slave(rem_node));
404                 } else {
405                         assert(in_own_cluster(c_ptr->addr) &&
406                                !is_slave(rem_node));
407                 }
408                 n_ptr = c_ptr->nodes[tipc_node(rem_node)];
409                 if (!n_ptr)
410                         n_ptr = tipc_node_create(rem_node);
411                 if (n_ptr)
412                         tipc_node_add_router(n_ptr, router);
413                 break;
414         case ROUTE_REMOVAL:
415                 if (!is_slave(tipc_own_addr)) {
416                         assert(!in_own_cluster(c_ptr->addr) ||
417                                is_slave(rem_node));
418                 } else {
419                         assert(in_own_cluster(c_ptr->addr) &&
420                                !is_slave(rem_node));
421                 }
422                 n_ptr = c_ptr->nodes[tipc_node(rem_node)];
423                 if (n_ptr)
424                         tipc_node_remove_router(n_ptr, router);
425                 break;
426         default:
427                 assert(!"Illegal routing manager message received\n");
428         }
429         buf_discard(buf);
430 }
431
432 void tipc_cltr_remove_as_router(struct cluster *c_ptr, u32 router)
433 {
434         u32 start_entry;
435         u32 tstop;
436         u32 n_num;
437
438         if (is_slave(router))
439                 return; /* Slave nodes can not be routers */
440
441         if (in_own_cluster(c_ptr->addr)) {
442                 start_entry = LOWEST_SLAVE;
443                 tstop = c_ptr->highest_slave;
444         } else {
445                 start_entry = 1;
446                 tstop = c_ptr->highest_node;
447         }
448
449         for (n_num = start_entry; n_num <= tstop; n_num++) {
450                 if (c_ptr->nodes[n_num]) {
451                         tipc_node_remove_router(c_ptr->nodes[n_num], router);
452                 }
453         }
454 }
455
456 /**
457  * tipc_cltr_multicast - multicast message to local nodes
458  */
459
460 static void tipc_cltr_multicast(struct cluster *c_ptr, struct sk_buff *buf,
461                          u32 lower, u32 upper)
462 {
463         struct sk_buff *buf_copy;
464         struct tipc_node *n_ptr;
465         u32 n_num;
466         u32 tstop;
467
468         assert(lower <= upper);
469         assert(((lower >= 1) && (lower <= tipc_max_nodes)) ||
470                ((lower >= LOWEST_SLAVE) && (lower <= tipc_highest_allowed_slave)));
471         assert(((upper >= 1) && (upper <= tipc_max_nodes)) ||
472                ((upper >= LOWEST_SLAVE) && (upper <= tipc_highest_allowed_slave)));
473         assert(in_own_cluster(c_ptr->addr));
474
475         tstop = is_slave(upper) ? c_ptr->highest_slave : c_ptr->highest_node;
476         if (tstop > upper)
477                 tstop = upper;
478         for (n_num = lower; n_num <= tstop; n_num++) {
479                 n_ptr = c_ptr->nodes[n_num];
480                 if (n_ptr && tipc_node_has_active_links(n_ptr)) {
481                         buf_copy = skb_copy(buf, GFP_ATOMIC);
482                         if (buf_copy == NULL)
483                                 break;
484                         msg_set_destnode(buf_msg(buf_copy), n_ptr->addr);
485                         tipc_link_send(buf_copy, n_ptr->addr, n_ptr->addr);
486                 }
487         }
488         buf_discard(buf);
489 }
490
491 /**
492  * tipc_cltr_broadcast - broadcast message to all nodes within cluster
493  */
494
495 void tipc_cltr_broadcast(struct sk_buff *buf)
496 {
497         struct sk_buff *buf_copy;
498         struct cluster *c_ptr;
499         struct tipc_node *n_ptr;
500         u32 n_num;
501         u32 tstart;
502         u32 tstop;
503         u32 node_type;
504
505         if (tipc_mode == TIPC_NET_MODE) {
506                 c_ptr = tipc_cltr_find(tipc_own_addr);
507                 assert(in_own_cluster(c_ptr->addr));    /* For now */
508
509                 /* Send to standard nodes, then repeat loop sending to slaves */
510                 tstart = 1;
511                 tstop = c_ptr->highest_node;
512                 for (node_type = 1; node_type <= 2; node_type++) {
513                         for (n_num = tstart; n_num <= tstop; n_num++) {
514                                 n_ptr = c_ptr->nodes[n_num];
515                                 if (n_ptr && tipc_node_has_active_links(n_ptr)) {
516                                         buf_copy = skb_copy(buf, GFP_ATOMIC);
517                                         if (buf_copy == NULL)
518                                                 goto exit;
519                                         msg_set_destnode(buf_msg(buf_copy),
520                                                          n_ptr->addr);
521                                         tipc_link_send(buf_copy, n_ptr->addr,
522                                                        n_ptr->addr);
523                                 }
524                         }
525                         tstart = LOWEST_SLAVE;
526                         tstop = c_ptr->highest_slave;
527                 }
528         }
529 exit:
530         buf_discard(buf);
531 }
532
533 int tipc_cltr_init(void)
534 {
535         tipc_highest_allowed_slave = LOWEST_SLAVE + tipc_max_slaves;
536         return tipc_cltr_create(tipc_own_addr) ? 0 : -ENOMEM;
537 }
538