bearer.h 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170
  1. /*
  2. * net/tipc/bearer.h: Include file for TIPC bearer code
  3. *
  4. * Copyright (c) 1996-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. #ifndef _TIPC_BEARER_H
  37. #define _TIPC_BEARER_H
  38. #include "core.h"
  39. #include "bcast.h"
  40. #define MAX_BEARERS 8
  41. #define MAX_MEDIA 4
  42. /**
  43. * struct media - TIPC media information available to internal users
  44. * @send_msg: routine which handles buffer transmission
  45. * @enable_bearer: routine which enables a bearer
  46. * @disable_bearer: routine which disables a bearer
  47. * @addr2str: routine which converts bearer's address to string form
  48. * @bcast_addr: media address used in broadcasting
  49. * @bcast: non-zero if media supports broadcasting [currently mandatory]
  50. * @priority: default link (and bearer) priority
  51. * @tolerance: default time (in ms) before declaring link failure
  52. * @window: default window (in packets) before declaring link congestion
  53. * @type_id: TIPC media identifier [defined in tipc_bearer.h]
  54. * @name: media name
  55. */
  56. struct media {
  57. int (*send_msg)(struct sk_buff *buf,
  58. struct tipc_bearer *b_ptr,
  59. struct tipc_media_addr *dest);
  60. int (*enable_bearer)(struct tipc_bearer *b_ptr);
  61. void (*disable_bearer)(struct tipc_bearer *b_ptr);
  62. char *(*addr2str)(struct tipc_media_addr *a,
  63. char *str_buf, int str_size);
  64. struct tipc_media_addr bcast_addr;
  65. int bcast;
  66. u32 priority;
  67. u32 tolerance;
  68. u32 window;
  69. u32 type_id;
  70. char name[TIPC_MAX_MEDIA_NAME];
  71. };
  72. /**
  73. * struct bearer - TIPC bearer information available to internal users
  74. * @publ: bearer information available to privileged users
  75. * @media: ptr to media structure associated with bearer
  76. * @priority: default link priority for bearer
  77. * @detect_scope: network address mask used during automatic link creation
  78. * @identity: array index of this bearer within TIPC bearer array
  79. * @link_req: ptr to (optional) structure making periodic link setup requests
  80. * @links: list of non-congested links associated with bearer
  81. * @cong_links: list of congested links associated with bearer
  82. * @continue_count: # of times bearer has resumed after congestion or blocking
  83. * @active: non-zero if bearer structure is represents a bearer
  84. * @net_plane: network plane ('A' through 'H') currently associated with bearer
  85. * @nodes: indicates which nodes in cluster can be reached through bearer
  86. */
  87. struct bearer {
  88. struct tipc_bearer publ;
  89. struct media *media;
  90. u32 priority;
  91. u32 detect_scope;
  92. u32 identity;
  93. struct link_req *link_req;
  94. struct list_head links;
  95. struct list_head cong_links;
  96. u32 continue_count;
  97. int active;
  98. char net_plane;
  99. struct node_map nodes;
  100. };
  101. struct bearer_name {
  102. char media_name[TIPC_MAX_MEDIA_NAME];
  103. char if_name[TIPC_MAX_IF_NAME];
  104. };
  105. struct link;
  106. extern struct bearer *tipc_bearers;
  107. void tipc_media_addr_printf(struct print_buf *pb, struct tipc_media_addr *a);
  108. struct sk_buff *tipc_media_get_names(void);
  109. struct sk_buff *tipc_bearer_get_names(void);
  110. void tipc_bearer_add_dest(struct bearer *b_ptr, u32 dest);
  111. void tipc_bearer_remove_dest(struct bearer *b_ptr, u32 dest);
  112. void tipc_bearer_schedule(struct bearer *b_ptr, struct link *l_ptr);
  113. struct bearer *tipc_bearer_find_interface(const char *if_name);
  114. int tipc_bearer_resolve_congestion(struct bearer *b_ptr, struct link *l_ptr);
  115. int tipc_bearer_init(void);
  116. void tipc_bearer_stop(void);
  117. void tipc_bearer_lock_push(struct bearer *b_ptr);
  118. /**
  119. * tipc_bearer_send- sends buffer to destination over bearer
  120. *
  121. * Returns true (1) if successful, or false (0) if unable to send
  122. *
  123. * IMPORTANT:
  124. * The media send routine must not alter the buffer being passed in
  125. * as it may be needed for later retransmission!
  126. *
  127. * If the media send routine returns a non-zero value (indicating that
  128. * it was unable to send the buffer), it must:
  129. * 1) mark the bearer as blocked,
  130. * 2) call tipc_continue() once the bearer is able to send again.
  131. * Media types that are unable to meet these two critera must ensure their
  132. * send routine always returns success -- even if the buffer was not sent --
  133. * and let TIPC's link code deal with the undelivered message.
  134. */
  135. static inline int tipc_bearer_send(struct bearer *b_ptr, struct sk_buff *buf,
  136. struct tipc_media_addr *dest)
  137. {
  138. return !b_ptr->media->send_msg(buf, &b_ptr->publ, dest);
  139. }
  140. /**
  141. * tipc_bearer_congested - determines if bearer is currently congested
  142. */
  143. static inline int tipc_bearer_congested(struct bearer *b_ptr, struct link *l_ptr)
  144. {
  145. if (unlikely(b_ptr->publ.blocked))
  146. return 1;
  147. if (likely(list_empty(&b_ptr->cong_links)))
  148. return 0;
  149. return !tipc_bearer_resolve_congestion(b_ptr, l_ptr);
  150. }
  151. #endif