Commit | Line | Data |
---|---|---|
b97bf3fd PL |
1 | /* |
2 | * net/tipc/link.h: Include file for TIPC link code | |
c4307285 | 3 | * |
50100a5e | 4 | * Copyright (c) 1995-2006, 2013-2014, Ericsson AB |
23dd4cce | 5 | * Copyright (c) 2004-2005, 2010-2011, Wind River Systems |
b97bf3fd PL |
6 | * All rights reserved. |
7 | * | |
9ea1fd3c | 8 | * Redistribution and use in source and binary forms, with or without |
b97bf3fd PL |
9 | * modification, are permitted provided that the following conditions are met: |
10 | * | |
9ea1fd3c PL |
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. | |
b97bf3fd | 19 | * |
9ea1fd3c PL |
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 | |
b97bf3fd PL |
34 | * POSSIBILITY OF SUCH DAMAGE. |
35 | */ | |
36 | ||
37 | #ifndef _TIPC_LINK_H | |
38 | #define _TIPC_LINK_H | |
39 | ||
b97bf3fd | 40 | #include "msg.h" |
b97bf3fd PL |
41 | #include "node.h" |
42 | ||
135daee6 | 43 | /* Out-of-range value for link sequence numbers |
36559591 | 44 | */ |
36559591 AS |
45 | #define INVALID_LINK_SEQ 0x10000 |
46 | ||
135daee6 | 47 | /* Link working states |
b97bf3fd | 48 | */ |
b97bf3fd PL |
49 | #define WORKING_WORKING 560810u |
50 | #define WORKING_UNKNOWN 560811u | |
51 | #define RESET_UNKNOWN 560812u | |
52 | #define RESET_RESET 560813u | |
53 | ||
135daee6 YX |
54 | /* Link endpoint execution states |
55 | */ | |
56 | #define LINK_STARTED 0x0001 | |
c61dd61d | 57 | #define LINK_STOPPED 0x0002 |
135daee6 YX |
58 | |
59 | /* Starting value for maximum packet size negotiation on unicast links | |
b97bf3fd PL |
60 | * (unless bearer MTU is less) |
61 | */ | |
b97bf3fd PL |
62 | #define MAX_PKT_DEFAULT 1500 |
63 | ||
7e9cab58 PG |
64 | struct tipc_stats { |
65 | u32 sent_info; /* used in counting # sent packets */ | |
66 | u32 recv_info; /* used in counting # recv'd packets */ | |
67 | u32 sent_states; | |
68 | u32 recv_states; | |
69 | u32 sent_probes; | |
70 | u32 recv_probes; | |
71 | u32 sent_nacks; | |
72 | u32 recv_nacks; | |
73 | u32 sent_acks; | |
74 | u32 sent_bundled; | |
75 | u32 sent_bundles; | |
76 | u32 recv_bundled; | |
77 | u32 recv_bundles; | |
78 | u32 retransmitted; | |
79 | u32 sent_fragmented; | |
80 | u32 sent_fragments; | |
81 | u32 recv_fragmented; | |
82 | u32 recv_fragments; | |
83 | u32 link_congs; /* # port sends blocked by congestion */ | |
7e9cab58 PG |
84 | u32 deferred_recv; |
85 | u32 duplicates; | |
86 | u32 max_queue_sz; /* send queue size high water mark */ | |
87 | u32 accu_queue_sz; /* used for send queue size profiling */ | |
88 | u32 queue_sz_counts; /* used for send queue size profiling */ | |
89 | u32 msg_length_counts; /* used for message length profiling */ | |
90 | u32 msg_lengths_total; /* used for message length profiling */ | |
91 | u32 msg_length_profile[7]; /* used for msg. length profiling */ | |
92 | }; | |
93 | ||
b97bf3fd | 94 | /** |
a18c4bc3 | 95 | * struct tipc_link - TIPC link data structure |
b97bf3fd PL |
96 | * @addr: network address of link's peer node |
97 | * @name: link name character string | |
98 | * @media_addr: media address to use when sending messages over link | |
99 | * @timer: link timer | |
100 | * @owner: pointer to peer node | |
135daee6 | 101 | * @flags: execution state flags for link endpoint instance |
b97bf3fd PL |
102 | * @checkpoint: reference point for triggering link continuity checking |
103 | * @peer_session: link session # being used by peer end of link | |
104 | * @peer_bearer_id: bearer id used by link's peer endpoint | |
7a2f7d18 | 105 | * @bearer_id: local bearer id used by link |
c4307285 | 106 | * @tolerance: minimum link continuity loss needed to reset link [in ms] |
b97bf3fd PL |
107 | * @continuity_interval: link continuity testing interval [in ms] |
108 | * @abort_limit: # of unacknowledged continuity probes needed to reset link | |
109 | * @state: current state of link FSM | |
b97bf3fd PL |
110 | * @fsm_msg_cnt: # of protocol messages link FSM has sent in current state |
111 | * @proto_msg: template for control messages generated by link | |
112 | * @pmsg: convenience pointer to "proto_msg" field | |
113 | * @priority: current link priority | |
7a2f7d18 | 114 | * @net_plane: current link network plane ('A' through 'H') |
b97bf3fd PL |
115 | * @queue_limit: outbound message queue congestion thresholds (indexed by user) |
116 | * @exp_msg_count: # of tunnelled messages expected during link changeover | |
117 | * @reset_checkpoint: seq # of last acknowledged message at time of link reset | |
118 | * @max_pkt: current maximum packet size for this link | |
119 | * @max_pkt_target: desired maximum packet size for this link | |
120 | * @max_pkt_probes: # of probes based on current (max_pkt, max_pkt_target) | |
121 | * @out_queue_size: # of messages in outbound message queue | |
122 | * @first_out: ptr to first outbound message in queue | |
123 | * @last_out: ptr to last outbound message in queue | |
124 | * @next_out_no: next sequence number to use for outbound messages | |
125 | * @last_retransmitted: sequence number of most recently retransmitted message | |
126 | * @stale_count: # of identical retransmit requests made by peer | |
127 | * @next_in_no: next sequence number to expect for inbound messages | |
128 | * @deferred_inqueue_sz: # of messages in inbound message queue | |
129 | * @oldest_deferred_in: ptr to first inbound message in queue | |
130 | * @newest_deferred_in: ptr to last inbound message in queue | |
131 | * @unacked_window: # of inbound messages rx'd without ack'ing back to peer | |
132 | * @proto_msg_queue: ptr to (single) outbound control message | |
133 | * @retransm_queue_size: number of messages to retransmit | |
134 | * @retransm_queue_head: sequence number of first message to retransmit | |
135 | * @next_out: ptr to first unsent outbound message in queue | |
50100a5e | 136 | * @waiting_sks: linked list of sockets waiting for link congestion to abate |
b97bf3fd | 137 | * @long_msg_seq_no: next identifier to use for outbound fragmented messages |
37e22164 | 138 | * @reasm_buf: head of partially reassembled inbound message fragments |
b97bf3fd | 139 | * @stats: collects statistics regarding link activity |
b97bf3fd | 140 | */ |
a18c4bc3 | 141 | struct tipc_link { |
b97bf3fd PL |
142 | u32 addr; |
143 | char name[TIPC_MAX_LINK_NAME]; | |
144 | struct tipc_media_addr media_addr; | |
145 | struct timer_list timer; | |
6c00055a | 146 | struct tipc_node *owner; |
b97bf3fd PL |
147 | |
148 | /* Management and link supervision data */ | |
135daee6 | 149 | unsigned int flags; |
b97bf3fd PL |
150 | u32 checkpoint; |
151 | u32 peer_session; | |
152 | u32 peer_bearer_id; | |
7a2f7d18 | 153 | u32 bearer_id; |
b97bf3fd PL |
154 | u32 tolerance; |
155 | u32 continuity_interval; | |
156 | u32 abort_limit; | |
157 | int state; | |
b97bf3fd PL |
158 | u32 fsm_msg_cnt; |
159 | struct { | |
160 | unchar hdr[INT_H_SIZE]; | |
161 | unchar body[TIPC_MAX_IF_NAME]; | |
162 | } proto_msg; | |
163 | struct tipc_msg *pmsg; | |
164 | u32 priority; | |
7a2f7d18 | 165 | char net_plane; |
b97bf3fd PL |
166 | u32 queue_limit[15]; /* queue_limit[0]==window limit */ |
167 | ||
168 | /* Changeover */ | |
169 | u32 exp_msg_count; | |
170 | u32 reset_checkpoint; | |
171 | ||
c4307285 YH |
172 | /* Max packet negotiation */ |
173 | u32 max_pkt; | |
174 | u32 max_pkt_target; | |
175 | u32 max_pkt_probes; | |
b97bf3fd PL |
176 | |
177 | /* Sending */ | |
178 | u32 out_queue_size; | |
179 | struct sk_buff *first_out; | |
180 | struct sk_buff *last_out; | |
181 | u32 next_out_no; | |
c4307285 YH |
182 | u32 last_retransmitted; |
183 | u32 stale_count; | |
b97bf3fd PL |
184 | |
185 | /* Reception */ | |
186 | u32 next_in_no; | |
187 | u32 deferred_inqueue_sz; | |
188 | struct sk_buff *oldest_deferred_in; | |
189 | struct sk_buff *newest_deferred_in; | |
190 | u32 unacked_window; | |
191 | ||
192 | /* Congestion handling */ | |
193 | struct sk_buff *proto_msg_queue; | |
194 | u32 retransm_queue_size; | |
195 | u32 retransm_queue_head; | |
196 | struct sk_buff *next_out; | |
50100a5e | 197 | struct sk_buff_head waiting_sks; |
b97bf3fd | 198 | |
40ba3cdf | 199 | /* Fragmentation/reassembly */ |
b97bf3fd | 200 | u32 long_msg_seq_no; |
37e22164 | 201 | struct sk_buff *reasm_buf; |
b97bf3fd | 202 | |
c4307285 | 203 | /* Statistics */ |
7e9cab58 | 204 | struct tipc_stats stats; |
b97bf3fd PL |
205 | }; |
206 | ||
23dd4cce | 207 | struct tipc_port; |
b97bf3fd | 208 | |
a18c4bc3 | 209 | struct tipc_link *tipc_link_create(struct tipc_node *n_ptr, |
37b9c08a | 210 | struct tipc_bearer *b_ptr, |
4323add6 | 211 | const struct tipc_media_addr *media_addr); |
7d33939f | 212 | void tipc_link_delete_list(unsigned int bearer_id, bool shutting_down); |
170b3927 | 213 | void tipc_link_failover_send_queue(struct tipc_link *l_ptr); |
247f0f3c | 214 | void tipc_link_dup_queue_xmit(struct tipc_link *l_ptr, struct tipc_link *dest); |
a18c4bc3 PG |
215 | void tipc_link_reset_fragments(struct tipc_link *l_ptr); |
216 | int tipc_link_is_up(struct tipc_link *l_ptr); | |
217 | int tipc_link_is_active(struct tipc_link *l_ptr); | |
581465fa | 218 | void tipc_link_purge_queues(struct tipc_link *l_ptr); |
170b3927 JPM |
219 | struct sk_buff *tipc_link_cmd_config(const void *req_tlv_area, |
220 | int req_tlv_space, | |
221 | u16 cmd); | |
222 | struct sk_buff *tipc_link_cmd_show_stats(const void *req_tlv_area, | |
223 | int req_tlv_space); | |
224 | struct sk_buff *tipc_link_cmd_reset_stats(const void *req_tlv_area, | |
225 | int req_tlv_space); | |
3f5a12bd | 226 | void tipc_link_reset_all(struct tipc_node *node); |
a18c4bc3 | 227 | void tipc_link_reset(struct tipc_link *l_ptr); |
c61dd61d | 228 | void tipc_link_reset_list(unsigned int bearer_id); |
9fbfb8b1 JPM |
229 | int tipc_link_xmit(struct sk_buff *buf, u32 dest, u32 selector); |
230 | int __tipc_link_xmit(struct tipc_link *link, struct sk_buff *buf); | |
0e65967e | 231 | u32 tipc_link_get_max_pkt(u32 dest, u32 selector); |
247f0f3c | 232 | void tipc_link_bundle_rcv(struct sk_buff *buf); |
247f0f3c YX |
233 | void tipc_link_proto_xmit(struct tipc_link *l_ptr, u32 msg_typ, int prob, |
234 | u32 gap, u32 tolerance, u32 priority, u32 acked_mtu); | |
a18c4bc3 | 235 | void tipc_link_push_queue(struct tipc_link *l_ptr); |
4323add6 | 236 | u32 tipc_link_defer_pkt(struct sk_buff **head, struct sk_buff **tail, |
247f0f3c | 237 | struct sk_buff *buf); |
a18c4bc3 PG |
238 | void tipc_link_set_queue_limits(struct tipc_link *l_ptr, u32 window); |
239 | void tipc_link_retransmit(struct tipc_link *l_ptr, | |
240 | struct sk_buff *start, u32 retransmits); | |
b97bf3fd PL |
241 | |
242 | /* | |
243 | * Link sequence number manipulation routines (uses modulo 2**16 arithmetic) | |
244 | */ | |
f905730c AS |
245 | static inline u32 buf_seqno(struct sk_buff *buf) |
246 | { | |
247 | return msg_seqno(buf_msg(buf)); | |
248 | } | |
249 | ||
b97bf3fd PL |
250 | static inline u32 mod(u32 x) |
251 | { | |
252 | return x & 0xffffu; | |
253 | } | |
254 | ||
255 | static inline int between(u32 lower, u32 upper, u32 n) | |
256 | { | |
257 | if ((lower < n) && (n < upper)) | |
258 | return 1; | |
259 | if ((upper < lower) && ((n > lower) || (n < upper))) | |
260 | return 1; | |
261 | return 0; | |
262 | } | |
263 | ||
264 | static inline int less_eq(u32 left, u32 right) | |
265 | { | |
a02cec21 | 266 | return mod(right - left) < 32768u; |
b97bf3fd PL |
267 | } |
268 | ||
269 | static inline int less(u32 left, u32 right) | |
270 | { | |
a02cec21 | 271 | return less_eq(left, right) && (mod(right) != mod(left)); |
b97bf3fd PL |
272 | } |
273 | ||
274 | static inline u32 lesser(u32 left, u32 right) | |
275 | { | |
276 | return less_eq(left, right) ? left : right; | |
277 | } | |
278 | ||
01fee256 AS |
279 | |
280 | /* | |
281 | * Link status checking routines | |
282 | */ | |
a18c4bc3 | 283 | static inline int link_working_working(struct tipc_link *l_ptr) |
01fee256 | 284 | { |
a02cec21 | 285 | return l_ptr->state == WORKING_WORKING; |
01fee256 AS |
286 | } |
287 | ||
a18c4bc3 | 288 | static inline int link_working_unknown(struct tipc_link *l_ptr) |
01fee256 | 289 | { |
a02cec21 | 290 | return l_ptr->state == WORKING_UNKNOWN; |
01fee256 AS |
291 | } |
292 | ||
a18c4bc3 | 293 | static inline int link_reset_unknown(struct tipc_link *l_ptr) |
01fee256 | 294 | { |
a02cec21 | 295 | return l_ptr->state == RESET_UNKNOWN; |
01fee256 AS |
296 | } |
297 | ||
a18c4bc3 | 298 | static inline int link_reset_reset(struct tipc_link *l_ptr) |
01fee256 | 299 | { |
a02cec21 | 300 | return l_ptr->state == RESET_RESET; |
01fee256 AS |
301 | } |
302 | ||
a18c4bc3 | 303 | static inline int link_congested(struct tipc_link *l_ptr) |
01fee256 | 304 | { |
a02cec21 | 305 | return l_ptr->out_queue_size >= l_ptr->queue_limit[0]; |
01fee256 AS |
306 | } |
307 | ||
b97bf3fd | 308 | #endif |