[TIPC] Update of file headers
[linux-3.10.git] / net / tipc / bearer.c
1 /*
2  * net/tipc/bearer.c: TIPC bearer code
3  * 
4  * Copyright (c) 2003-2006, Ericsson AB
5  * Copyright (c) 2004-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 "config.h"
39 #include "dbg.h"
40 #include "bearer.h"
41 #include "link.h"
42 #include "port.h"
43 #include "discover.h"
44 #include "bcast.h"
45
46 #define MAX_ADDR_STR 32
47
48 static struct media *media_list = 0;
49 static u32 media_count = 0;
50
51 struct bearer *bearers = 0;
52
53 /**
54  * media_name_valid - validate media name
55  * 
56  * Returns 1 if media name is valid, otherwise 0.
57  */
58
59 static int media_name_valid(const char *name)
60 {
61         u32 len;
62
63         len = strlen(name);
64         if ((len + 1) > TIPC_MAX_MEDIA_NAME)
65                 return 0;
66         return (strspn(name, tipc_alphabet) == len);
67 }
68
69 /**
70  * media_find - locates specified media object by name
71  */
72
73 static struct media *media_find(const char *name)
74 {
75         struct media *m_ptr;
76         u32 i;
77
78         for (i = 0, m_ptr = media_list; i < media_count; i++, m_ptr++) {
79                 if (!strcmp(m_ptr->name, name))
80                         return m_ptr;
81         }
82         return 0;
83 }
84
85 /**
86  * tipc_register_media - register a media type
87  * 
88  * Bearers for this media type must be activated separately at a later stage.
89  */
90
91 int  tipc_register_media(u32 media_type,
92                          char *name, 
93                          int (*enable)(struct tipc_bearer *), 
94                          void (*disable)(struct tipc_bearer *), 
95                          int (*send_msg)(struct sk_buff *, 
96                                          struct tipc_bearer *,
97                                          struct tipc_media_addr *), 
98                          char *(*addr2str)(struct tipc_media_addr *a,
99                                            char *str_buf, int str_size),
100                          struct tipc_media_addr *bcast_addr,
101                          const u32 bearer_priority,
102                          const u32 link_tolerance,  /* [ms] */
103                          const u32 send_window_limit)
104 {
105         struct media *m_ptr;
106         u32 media_id;
107         u32 i;
108         int res = -EINVAL;
109
110         write_lock_bh(&net_lock);
111         if (!media_list)
112                 goto exit;
113
114         if (!media_name_valid(name)) {
115                 warn("Media registration error: illegal name <%s>\n", name);
116                 goto exit;
117         }
118         if (!bcast_addr) {
119                 warn("Media registration error: no broadcast address supplied\n");
120                 goto exit;
121         }
122         if (bearer_priority >= TIPC_NUM_LINK_PRI) {
123                 warn("Media registration error: priority %u\n", bearer_priority);
124                 goto exit;
125         }
126         if ((link_tolerance < TIPC_MIN_LINK_TOL) || 
127             (link_tolerance > TIPC_MAX_LINK_TOL)) {
128                 warn("Media registration error: tolerance %u\n", link_tolerance);
129                 goto exit;
130         }
131
132         media_id = media_count++;
133         if (media_id >= MAX_MEDIA) {
134                 warn("Attempt to register more than %u media\n", MAX_MEDIA);
135                 media_count--;
136                 goto exit;
137         }
138         for (i = 0; i < media_id; i++) {
139                 if (media_list[i].type_id == media_type) {
140                         warn("Attempt to register second media with type %u\n", 
141                              media_type);
142                         media_count--;
143                         goto exit;
144                 }
145                 if (!strcmp(name, media_list[i].name)) {
146                         warn("Attempt to re-register media name <%s>\n", name);
147                         media_count--;
148                         goto exit;
149                 }
150         }
151
152         m_ptr = &media_list[media_id];
153         m_ptr->type_id = media_type;
154         m_ptr->send_msg = send_msg;
155         m_ptr->enable_bearer = enable;
156         m_ptr->disable_bearer = disable;
157         m_ptr->addr2str = addr2str;
158         memcpy(&m_ptr->bcast_addr, bcast_addr, sizeof(*bcast_addr));
159         m_ptr->bcast = 1;
160         strcpy(m_ptr->name, name);
161         m_ptr->priority = bearer_priority;
162         m_ptr->tolerance = link_tolerance;
163         m_ptr->window = send_window_limit;
164         dbg("Media <%s> registered\n", name);
165         res = 0;
166 exit:
167         write_unlock_bh(&net_lock);
168         return res;
169 }
170
171 /**
172  * media_addr_printf - record media address in print buffer
173  */
174
175 void media_addr_printf(struct print_buf *pb, struct tipc_media_addr *a)
176 {
177         struct media *m_ptr;
178         u32 media_type;
179         u32 i;
180
181         media_type = ntohl(a->type);
182         for (i = 0, m_ptr = media_list; i < media_count; i++, m_ptr++) {
183                 if (m_ptr->type_id == media_type)
184                         break;
185         }
186
187         if ((i < media_count) && (m_ptr->addr2str != NULL)) {
188                 char addr_str[MAX_ADDR_STR];
189
190                 tipc_printf(pb, "%s(%s) ", m_ptr->name, 
191                             m_ptr->addr2str(a, addr_str, sizeof(addr_str)));
192         } else {
193                 unchar *addr = (unchar *)&a->dev_addr;
194
195                 tipc_printf(pb, "UNKNOWN(%u):", media_type);
196                 for (i = 0; i < (sizeof(*a) - sizeof(a->type)); i++) {
197                         tipc_printf(pb, "%02x ", addr[i]);
198                 }
199         }
200 }
201
202 /**
203  * media_get_names - record names of registered media in buffer
204  */
205
206 struct sk_buff *media_get_names(void)
207 {
208         struct sk_buff *buf;
209         struct media *m_ptr;
210         int i;
211
212         buf = cfg_reply_alloc(MAX_MEDIA * TLV_SPACE(TIPC_MAX_MEDIA_NAME));
213         if (!buf)
214                 return NULL;
215
216         read_lock_bh(&net_lock);
217         for (i = 0, m_ptr = media_list; i < media_count; i++, m_ptr++) {
218                 cfg_append_tlv(buf, TIPC_TLV_MEDIA_NAME, m_ptr->name, 
219                                strlen(m_ptr->name) + 1);
220         }
221         read_unlock_bh(&net_lock);
222         return buf;
223 }
224
225 /**
226  * bearer_name_validate - validate & (optionally) deconstruct bearer name
227  * @name - ptr to bearer name string
228  * @name_parts - ptr to area for bearer name components (or NULL if not needed)
229  * 
230  * Returns 1 if bearer name is valid, otherwise 0.
231  */
232
233 static int bearer_name_validate(const char *name, 
234                                 struct bearer_name *name_parts)
235 {
236         char name_copy[TIPC_MAX_BEARER_NAME];
237         char *media_name;
238         char *if_name;
239         u32 media_len;
240         u32 if_len;
241
242         /* copy bearer name & ensure length is OK */
243
244         name_copy[TIPC_MAX_BEARER_NAME - 1] = 0;
245         /* need above in case non-Posix strncpy() doesn't pad with nulls */
246         strncpy(name_copy, name, TIPC_MAX_BEARER_NAME);
247         if (name_copy[TIPC_MAX_BEARER_NAME - 1] != 0)
248                 return 0;
249
250         /* ensure all component parts of bearer name are present */
251
252         media_name = name_copy;
253         if ((if_name = strchr(media_name, ':')) == NULL)
254                 return 0;
255         *(if_name++) = 0;
256         media_len = if_name - media_name;
257         if_len = strlen(if_name) + 1;
258
259         /* validate component parts of bearer name */
260
261         if ((media_len <= 1) || (media_len > TIPC_MAX_MEDIA_NAME) || 
262             (if_len <= 1) || (if_len > TIPC_MAX_IF_NAME) || 
263             (strspn(media_name, tipc_alphabet) != (media_len - 1)) ||
264             (strspn(if_name, tipc_alphabet) != (if_len - 1)))
265                 return 0;
266
267         /* return bearer name components, if necessary */
268
269         if (name_parts) {
270                 strcpy(name_parts->media_name, media_name);
271                 strcpy(name_parts->if_name, if_name);
272         }
273         return 1;
274 }
275
276 /**
277  * bearer_find - locates bearer object with matching bearer name
278  */
279
280 static struct bearer *bearer_find(const char *name)
281 {
282         struct bearer *b_ptr;
283         u32 i;
284
285         for (i = 0, b_ptr = bearers; i < MAX_BEARERS; i++, b_ptr++) {
286                 if (b_ptr->active && (!strcmp(b_ptr->publ.name, name)))
287                         return b_ptr;
288         }
289         return 0;
290 }
291
292 /**
293  * bearer_find - locates bearer object with matching interface name
294  */
295
296 struct bearer *bearer_find_interface(const char *if_name)
297 {
298         struct bearer *b_ptr;
299         char *b_if_name;
300         u32 i;
301
302         for (i = 0, b_ptr = bearers; i < MAX_BEARERS; i++, b_ptr++) {
303                 if (!b_ptr->active)
304                         continue;
305                 b_if_name = strchr(b_ptr->publ.name, ':') + 1;
306                 if (!strcmp(b_if_name, if_name))
307                         return b_ptr;
308         }
309         return 0;
310 }
311
312 /**
313  * bearer_get_names - record names of bearers in buffer
314  */
315
316 struct sk_buff *bearer_get_names(void)
317 {
318         struct sk_buff *buf;
319         struct media *m_ptr;
320         struct bearer *b_ptr;
321         int i, j;
322
323         buf = cfg_reply_alloc(MAX_BEARERS * TLV_SPACE(TIPC_MAX_BEARER_NAME));
324         if (!buf)
325                 return NULL;
326
327         read_lock_bh(&net_lock);
328         for (i = 0, m_ptr = media_list; i < media_count; i++, m_ptr++) {
329                 for (j = 0; j < MAX_BEARERS; j++) {
330                         b_ptr = &bearers[j];
331                         if (b_ptr->active && (b_ptr->media == m_ptr)) {
332                                 cfg_append_tlv(buf, TIPC_TLV_BEARER_NAME, 
333                                                b_ptr->publ.name, 
334                                                strlen(b_ptr->publ.name) + 1);
335                         }
336                 }
337         }
338         read_unlock_bh(&net_lock);
339         return buf;
340 }
341
342 void bearer_add_dest(struct bearer *b_ptr, u32 dest)
343 {
344         nmap_add(&b_ptr->nodes, dest);
345         disc_update_link_req(b_ptr->link_req);
346         bcbearer_sort();
347 }
348
349 void bearer_remove_dest(struct bearer *b_ptr, u32 dest)
350 {
351         nmap_remove(&b_ptr->nodes, dest);
352         disc_update_link_req(b_ptr->link_req);
353         bcbearer_sort();
354 }
355
356 /*
357  * bearer_push(): Resolve bearer congestion. Force the waiting
358  * links to push out their unsent packets, one packet per link
359  * per iteration, until all packets are gone or congestion reoccurs.
360  * 'net_lock' is read_locked when this function is called
361  * bearer.lock must be taken before calling
362  * Returns binary true(1) ore false(0)
363  */
364 static int bearer_push(struct bearer *b_ptr)
365 {
366         u32 res = TIPC_OK;
367         struct link *ln, *tln;
368
369         if (b_ptr->publ.blocked)
370                 return 0;
371
372         while (!list_empty(&b_ptr->cong_links) && (res != PUSH_FAILED)) {
373                 list_for_each_entry_safe(ln, tln, &b_ptr->cong_links, link_list) {
374                         res = link_push_packet(ln);
375                         if (res == PUSH_FAILED)
376                                 break;
377                         if (res == PUSH_FINISHED)
378                                 list_move_tail(&ln->link_list, &b_ptr->links);
379                 }
380         }
381         return list_empty(&b_ptr->cong_links);
382 }
383
384 void bearer_lock_push(struct bearer *b_ptr)
385 {
386         int res;
387
388         spin_lock_bh(&b_ptr->publ.lock);
389         res = bearer_push(b_ptr);
390         spin_unlock_bh(&b_ptr->publ.lock);
391         if (res)
392                 bcbearer_push();
393 }
394
395
396 /*
397  * Interrupt enabling new requests after bearer congestion or blocking:    
398  * See bearer_send().   
399  */
400 void tipc_continue(struct tipc_bearer *tb_ptr)
401 {
402         struct bearer *b_ptr = (struct bearer *)tb_ptr;
403
404         spin_lock_bh(&b_ptr->publ.lock);
405         b_ptr->continue_count++;
406         if (!list_empty(&b_ptr->cong_links))
407                 k_signal((Handler)bearer_lock_push, (unsigned long)b_ptr);
408         b_ptr->publ.blocked = 0;
409         spin_unlock_bh(&b_ptr->publ.lock);
410 }
411
412 /*
413  * Schedule link for sending of messages after the bearer 
414  * has been deblocked by 'continue()'. This method is called 
415  * when somebody tries to send a message via this link while 
416  * the bearer is congested. 'net_lock' is in read_lock here
417  * bearer.lock is busy
418  */
419
420 static void bearer_schedule_unlocked(struct bearer *b_ptr, struct link *l_ptr)
421 {
422         list_move_tail(&l_ptr->link_list, &b_ptr->cong_links);
423 }
424
425 /*
426  * Schedule link for sending of messages after the bearer 
427  * has been deblocked by 'continue()'. This method is called 
428  * when somebody tries to send a message via this link while 
429  * the bearer is congested. 'net_lock' is in read_lock here,
430  * bearer.lock is free
431  */
432
433 void bearer_schedule(struct bearer *b_ptr, struct link *l_ptr)
434 {
435         spin_lock_bh(&b_ptr->publ.lock);
436         bearer_schedule_unlocked(b_ptr, l_ptr);
437         spin_unlock_bh(&b_ptr->publ.lock);
438 }
439
440
441 /*
442  * bearer_resolve_congestion(): Check if there is bearer congestion,
443  * and if there is, try to resolve it before returning.
444  * 'net_lock' is read_locked when this function is called
445  */
446 int bearer_resolve_congestion(struct bearer *b_ptr, struct link *l_ptr)
447 {
448         int res = 1;
449
450         if (list_empty(&b_ptr->cong_links))
451                 return 1;
452         spin_lock_bh(&b_ptr->publ.lock);
453         if (!bearer_push(b_ptr)) {
454                 bearer_schedule_unlocked(b_ptr, l_ptr);
455                 res = 0;
456         }
457         spin_unlock_bh(&b_ptr->publ.lock);
458         return res;
459 }
460
461
462 /**
463  * tipc_enable_bearer - enable bearer with the given name
464  */              
465
466 int tipc_enable_bearer(const char *name, u32 bcast_scope, u32 priority)
467 {
468         struct bearer *b_ptr;
469         struct media *m_ptr;
470         struct bearer_name b_name;
471         char addr_string[16];
472         u32 bearer_id;
473         u32 with_this_prio;
474         u32 i;
475         int res = -EINVAL;
476
477         if (tipc_mode != TIPC_NET_MODE)
478                 return -ENOPROTOOPT;
479         if (!bearer_name_validate(name, &b_name) ||
480             !addr_domain_valid(bcast_scope) ||
481             !in_scope(bcast_scope, tipc_own_addr) ||
482             (priority > TIPC_NUM_LINK_PRI))
483                 return -EINVAL;
484
485         write_lock_bh(&net_lock);
486         if (!bearers)
487                 goto failed;
488
489         m_ptr = media_find(b_name.media_name);
490         if (!m_ptr) {
491                 warn("No media <%s>\n", b_name.media_name);
492                 goto failed;
493         }
494         if (priority == TIPC_NUM_LINK_PRI)
495                 priority = m_ptr->priority;
496
497 restart:
498         bearer_id = MAX_BEARERS;
499         with_this_prio = 1;
500         for (i = MAX_BEARERS; i-- != 0; ) {
501                 if (!bearers[i].active) {
502                         bearer_id = i;
503                         continue;
504                 }
505                 if (!strcmp(name, bearers[i].publ.name)) {
506                         warn("Bearer <%s> already enabled\n", name);
507                         goto failed;
508                 }
509                 if ((bearers[i].priority == priority) &&
510                     (++with_this_prio > 2)) {
511                         if (priority-- == 0) {
512                                 warn("Third bearer <%s> with priority %u, unable to lower to %u\n",
513                                      name, priority + 1, priority);
514                                 goto failed;
515                         }
516                         warn("Third bearer <%s> with priority %u, lowering to %u\n",
517                              name, priority + 1, priority);
518                         goto restart;
519                 }
520         }
521         if (bearer_id >= MAX_BEARERS) {
522                 warn("Attempt to enable more than %d bearers\n", MAX_BEARERS);
523                 goto failed;
524         }
525
526         b_ptr = &bearers[bearer_id];
527         memset(b_ptr, 0, sizeof(struct bearer));
528
529         strcpy(b_ptr->publ.name, name);
530         res = m_ptr->enable_bearer(&b_ptr->publ);
531         if (res) {
532                 warn("Failed to enable bearer <%s>\n", name);
533                 goto failed;
534         }
535
536         b_ptr->identity = bearer_id;
537         b_ptr->media = m_ptr;
538         b_ptr->net_plane = bearer_id + 'A';
539         b_ptr->active = 1;
540         b_ptr->detect_scope = bcast_scope;
541         b_ptr->priority = priority;
542         INIT_LIST_HEAD(&b_ptr->cong_links);
543         INIT_LIST_HEAD(&b_ptr->links);
544         if (m_ptr->bcast) {
545                 b_ptr->link_req = disc_init_link_req(b_ptr, &m_ptr->bcast_addr,
546                                                      bcast_scope, 2);
547         }
548         b_ptr->publ.lock = SPIN_LOCK_UNLOCKED;
549         write_unlock_bh(&net_lock);
550         info("Enabled bearer <%s>, discovery domain %s\n",
551              name, addr_string_fill(addr_string, bcast_scope));
552         return 0;
553 failed:
554         write_unlock_bh(&net_lock);
555         return res;
556 }
557
558 /**
559  * tipc_block_bearer(): Block the bearer with the given name,
560  *                      and reset all its links
561  */
562
563 int tipc_block_bearer(const char *name)
564 {
565         struct bearer *b_ptr = 0;
566         struct link *l_ptr;
567         struct link *temp_l_ptr;
568
569         if (tipc_mode != TIPC_NET_MODE)
570                 return -ENOPROTOOPT;
571
572         read_lock_bh(&net_lock);
573         b_ptr = bearer_find(name);
574         if (!b_ptr) {
575                 warn("Attempt to block unknown bearer <%s>\n", name);
576                 read_unlock_bh(&net_lock);
577                 return -EINVAL;
578         }
579
580         spin_lock_bh(&b_ptr->publ.lock);
581         b_ptr->publ.blocked = 1;
582         list_for_each_entry_safe(l_ptr, temp_l_ptr, &b_ptr->links, link_list) {
583                 struct node *n_ptr = l_ptr->owner;
584
585                 spin_lock_bh(&n_ptr->lock);
586                 link_reset(l_ptr);
587                 spin_unlock_bh(&n_ptr->lock);
588         }
589         spin_unlock_bh(&b_ptr->publ.lock);
590         read_unlock_bh(&net_lock);
591         info("Blocked bearer <%s>\n", name);
592         return TIPC_OK;
593 }
594
595 /**
596  * bearer_disable -
597  * 
598  * Note: This routine assumes caller holds net_lock.
599  */
600
601 static int bearer_disable(const char *name)
602 {
603         struct bearer *b_ptr;
604         struct link *l_ptr;
605         struct link *temp_l_ptr;
606
607         if (tipc_mode != TIPC_NET_MODE)
608                 return -ENOPROTOOPT;
609
610         b_ptr = bearer_find(name);
611         if (!b_ptr) {
612                 warn("Attempt to disable unknown bearer <%s>\n", name);
613                 return -EINVAL;
614         }
615
616         disc_stop_link_req(b_ptr->link_req);
617         spin_lock_bh(&b_ptr->publ.lock);
618         b_ptr->link_req = NULL;
619         b_ptr->publ.blocked = 1;
620         if (b_ptr->media->disable_bearer) {
621                 spin_unlock_bh(&b_ptr->publ.lock);
622                 write_unlock_bh(&net_lock);
623                 b_ptr->media->disable_bearer(&b_ptr->publ);
624                 write_lock_bh(&net_lock);
625                 spin_lock_bh(&b_ptr->publ.lock);
626         }
627         list_for_each_entry_safe(l_ptr, temp_l_ptr, &b_ptr->links, link_list) {
628                 link_delete(l_ptr);
629         }
630         spin_unlock_bh(&b_ptr->publ.lock);
631         info("Disabled bearer <%s>\n", name);
632         memset(b_ptr, 0, sizeof(struct bearer));
633         return TIPC_OK;
634 }
635
636 int tipc_disable_bearer(const char *name)
637 {
638         int res;
639
640         write_lock_bh(&net_lock);
641         res = bearer_disable(name);
642         write_unlock_bh(&net_lock);
643         return res;
644 }
645
646
647
648 int bearer_init(void)
649 {
650         int res;
651
652         write_lock_bh(&net_lock);
653         bearers = kmalloc(MAX_BEARERS * sizeof(struct bearer), GFP_ATOMIC);
654         media_list = kmalloc(MAX_MEDIA * sizeof(struct media), GFP_ATOMIC);
655         if (bearers && media_list) {
656                 memset(bearers, 0, MAX_BEARERS * sizeof(struct bearer));
657                 memset(media_list, 0, MAX_MEDIA * sizeof(struct media));
658                 res = TIPC_OK;
659         } else {
660                 kfree(bearers);
661                 kfree(media_list);
662                 bearers = 0;
663                 media_list = 0;
664                 res = -ENOMEM;
665         }
666         write_unlock_bh(&net_lock);
667         return res;
668 }
669
670 void bearer_stop(void)
671 {
672         u32 i;
673
674         if (!bearers)
675                 return;
676
677         for (i = 0; i < MAX_BEARERS; i++) {
678                 if (bearers[i].active)
679                         bearers[i].publ.blocked = 1;
680         }
681         for (i = 0; i < MAX_BEARERS; i++) {
682                 if (bearers[i].active)
683                         bearer_disable(bearers[i].publ.name);
684         }
685         kfree(bearers);
686         kfree(media_list);
687         bearers = 0;
688         media_list = 0;
689         media_count = 0;
690 }
691
692