link.h 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295
  1. /*
  2. * net/tipc/link.h: Include file for TIPC link code
  3. *
  4. * Copyright (c) 1995-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. #ifndef _TIPC_LINK_H
  37. #define _TIPC_LINK_H
  38. #include "dbg.h"
  39. #include "msg.h"
  40. #include "bearer.h"
  41. #include "node.h"
  42. #define PUSH_FAILED 1
  43. #define PUSH_FINISHED 2
  44. /*
  45. * Link states
  46. */
  47. #define WORKING_WORKING 560810u
  48. #define WORKING_UNKNOWN 560811u
  49. #define RESET_UNKNOWN 560812u
  50. #define RESET_RESET 560813u
  51. /*
  52. * Starting value for maximum packet size negotiation on unicast links
  53. * (unless bearer MTU is less)
  54. */
  55. #define MAX_PKT_DEFAULT 1500
  56. /**
  57. * struct link - TIPC link data structure
  58. * @addr: network address of link's peer node
  59. * @name: link name character string
  60. * @media_addr: media address to use when sending messages over link
  61. * @timer: link timer
  62. * @owner: pointer to peer node
  63. * @link_list: adjacent links in bearer's list of links
  64. * @started: indicates if link has been started
  65. * @checkpoint: reference point for triggering link continuity checking
  66. * @peer_session: link session # being used by peer end of link
  67. * @peer_bearer_id: bearer id used by link's peer endpoint
  68. * @b_ptr: pointer to bearer used by link
  69. * @tolerance: minimum link continuity loss needed to reset link [in ms]
  70. * @continuity_interval: link continuity testing interval [in ms]
  71. * @abort_limit: # of unacknowledged continuity probes needed to reset link
  72. * @state: current state of link FSM
  73. * @blocked: indicates if link has been administratively blocked
  74. * @fsm_msg_cnt: # of protocol messages link FSM has sent in current state
  75. * @proto_msg: template for control messages generated by link
  76. * @pmsg: convenience pointer to "proto_msg" field
  77. * @priority: current link priority
  78. * @queue_limit: outbound message queue congestion thresholds (indexed by user)
  79. * @exp_msg_count: # of tunnelled messages expected during link changeover
  80. * @reset_checkpoint: seq # of last acknowledged message at time of link reset
  81. * @max_pkt: current maximum packet size for this link
  82. * @max_pkt_target: desired maximum packet size for this link
  83. * @max_pkt_probes: # of probes based on current (max_pkt, max_pkt_target)
  84. * @out_queue_size: # of messages in outbound message queue
  85. * @first_out: ptr to first outbound message in queue
  86. * @last_out: ptr to last outbound message in queue
  87. * @next_out_no: next sequence number to use for outbound messages
  88. * @last_retransmitted: sequence number of most recently retransmitted message
  89. * @stale_count: # of identical retransmit requests made by peer
  90. * @next_in_no: next sequence number to expect for inbound messages
  91. * @deferred_inqueue_sz: # of messages in inbound message queue
  92. * @oldest_deferred_in: ptr to first inbound message in queue
  93. * @newest_deferred_in: ptr to last inbound message in queue
  94. * @unacked_window: # of inbound messages rx'd without ack'ing back to peer
  95. * @proto_msg_queue: ptr to (single) outbound control message
  96. * @retransm_queue_size: number of messages to retransmit
  97. * @retransm_queue_head: sequence number of first message to retransmit
  98. * @next_out: ptr to first unsent outbound message in queue
  99. * @waiting_ports: linked list of ports waiting for link congestion to abate
  100. * @long_msg_seq_no: next identifier to use for outbound fragmented messages
  101. * @defragm_buf: list of partially reassembled inbound message fragments
  102. * @stats: collects statistics regarding link activity
  103. * @print_buf: print buffer used to log link activity
  104. */
  105. struct link {
  106. u32 addr;
  107. char name[TIPC_MAX_LINK_NAME];
  108. struct tipc_media_addr media_addr;
  109. struct timer_list timer;
  110. struct node *owner;
  111. struct list_head link_list;
  112. /* Management and link supervision data */
  113. int started;
  114. u32 checkpoint;
  115. u32 peer_session;
  116. u32 peer_bearer_id;
  117. struct bearer *b_ptr;
  118. u32 tolerance;
  119. u32 continuity_interval;
  120. u32 abort_limit;
  121. int state;
  122. int blocked;
  123. u32 fsm_msg_cnt;
  124. struct {
  125. unchar hdr[INT_H_SIZE];
  126. unchar body[TIPC_MAX_IF_NAME];
  127. } proto_msg;
  128. struct tipc_msg *pmsg;
  129. u32 priority;
  130. u32 queue_limit[15]; /* queue_limit[0]==window limit */
  131. /* Changeover */
  132. u32 exp_msg_count;
  133. u32 reset_checkpoint;
  134. /* Max packet negotiation */
  135. u32 max_pkt;
  136. u32 max_pkt_target;
  137. u32 max_pkt_probes;
  138. /* Sending */
  139. u32 out_queue_size;
  140. struct sk_buff *first_out;
  141. struct sk_buff *last_out;
  142. u32 next_out_no;
  143. u32 last_retransmitted;
  144. u32 stale_count;
  145. /* Reception */
  146. u32 next_in_no;
  147. u32 deferred_inqueue_sz;
  148. struct sk_buff *oldest_deferred_in;
  149. struct sk_buff *newest_deferred_in;
  150. u32 unacked_window;
  151. /* Congestion handling */
  152. struct sk_buff *proto_msg_queue;
  153. u32 retransm_queue_size;
  154. u32 retransm_queue_head;
  155. struct sk_buff *next_out;
  156. struct list_head waiting_ports;
  157. /* Fragmentation/defragmentation */
  158. u32 long_msg_seq_no;
  159. struct sk_buff *defragm_buf;
  160. /* Statistics */
  161. struct {
  162. u32 sent_info; /* used in counting # sent packets */
  163. u32 recv_info; /* used in counting # recv'd packets */
  164. u32 sent_states;
  165. u32 recv_states;
  166. u32 sent_probes;
  167. u32 recv_probes;
  168. u32 sent_nacks;
  169. u32 recv_nacks;
  170. u32 sent_acks;
  171. u32 sent_bundled;
  172. u32 sent_bundles;
  173. u32 recv_bundled;
  174. u32 recv_bundles;
  175. u32 retransmitted;
  176. u32 sent_fragmented;
  177. u32 sent_fragments;
  178. u32 recv_fragmented;
  179. u32 recv_fragments;
  180. u32 link_congs; /* # port sends blocked by congestion */
  181. u32 bearer_congs;
  182. u32 deferred_recv;
  183. u32 duplicates;
  184. /* for statistical profiling of send queue size */
  185. u32 max_queue_sz;
  186. u32 accu_queue_sz;
  187. u32 queue_sz_counts;
  188. /* for statistical profiling of message lengths */
  189. u32 msg_length_counts;
  190. u32 msg_lengths_total;
  191. u32 msg_length_profile[7];
  192. #if 0
  193. u32 sent_tunneled;
  194. u32 recv_tunneled;
  195. #endif
  196. } stats;
  197. struct print_buf print_buf;
  198. };
  199. struct port;
  200. struct link *tipc_link_create(struct bearer *b_ptr, const u32 peer,
  201. const struct tipc_media_addr *media_addr);
  202. void tipc_link_delete(struct link *l_ptr);
  203. void tipc_link_changeover(struct link *l_ptr);
  204. void tipc_link_send_duplicate(struct link *l_ptr, struct link *dest);
  205. void tipc_link_reset_fragments(struct link *l_ptr);
  206. int tipc_link_is_up(struct link *l_ptr);
  207. int tipc_link_is_active(struct link *l_ptr);
  208. void tipc_link_start(struct link *l_ptr);
  209. u32 tipc_link_push_packet(struct link *l_ptr);
  210. void tipc_link_stop(struct link *l_ptr);
  211. struct sk_buff *tipc_link_cmd_config(const void *req_tlv_area, int req_tlv_space, u16 cmd);
  212. struct sk_buff *tipc_link_cmd_show_stats(const void *req_tlv_area, int req_tlv_space);
  213. struct sk_buff *tipc_link_cmd_reset_stats(const void *req_tlv_area, int req_tlv_space);
  214. void tipc_link_reset(struct link *l_ptr);
  215. int tipc_link_send(struct sk_buff *buf, u32 dest, u32 selector);
  216. int tipc_link_send_buf(struct link *l_ptr, struct sk_buff *buf);
  217. u32 tipc_link_get_max_pkt(u32 dest,u32 selector);
  218. int tipc_link_send_sections_fast(struct port* sender,
  219. struct iovec const *msg_sect,
  220. const u32 num_sect,
  221. u32 destnode);
  222. int tipc_link_send_long_buf(struct link *l_ptr, struct sk_buff *buf);
  223. void tipc_link_tunnel(struct link *l_ptr, struct tipc_msg *tnl_hdr,
  224. struct tipc_msg *msg, u32 selector);
  225. void tipc_link_recv_bundle(struct sk_buff *buf);
  226. int tipc_link_recv_fragment(struct sk_buff **pending,
  227. struct sk_buff **fb,
  228. struct tipc_msg **msg);
  229. void tipc_link_send_proto_msg(struct link *l_ptr, u32 msg_typ, int prob, u32 gap,
  230. u32 tolerance, u32 priority, u32 acked_mtu);
  231. void tipc_link_push_queue(struct link *l_ptr);
  232. u32 tipc_link_defer_pkt(struct sk_buff **head, struct sk_buff **tail,
  233. struct sk_buff *buf);
  234. void tipc_link_wakeup_ports(struct link *l_ptr, int all);
  235. void tipc_link_set_queue_limits(struct link *l_ptr, u32 window);
  236. void tipc_link_retransmit(struct link *l_ptr, struct sk_buff *start, u32 retransmits);
  237. /*
  238. * Link sequence number manipulation routines (uses modulo 2**16 arithmetic)
  239. */
  240. static inline u32 mod(u32 x)
  241. {
  242. return x & 0xffffu;
  243. }
  244. static inline int between(u32 lower, u32 upper, u32 n)
  245. {
  246. if ((lower < n) && (n < upper))
  247. return 1;
  248. if ((upper < lower) && ((n > lower) || (n < upper)))
  249. return 1;
  250. return 0;
  251. }
  252. static inline int less_eq(u32 left, u32 right)
  253. {
  254. return (mod(right - left) < 32768u);
  255. }
  256. static inline int less(u32 left, u32 right)
  257. {
  258. return (less_eq(left, right) && (mod(right) != mod(left)));
  259. }
  260. static inline u32 lesser(u32 left, u32 right)
  261. {
  262. return less_eq(left, right) ? left : right;
  263. }
  264. #endif