net/tipc/bearer.c

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