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