]>
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 | ||
0655f6a8 | 40 | #include <net/genetlink.h> |
b97bf3fd | 41 | #include "msg.h" |
b97bf3fd PL |
42 | #include "node.h" |
43 | ||
859fc7c0 YX |
44 | /* TIPC-specific error codes |
45 | */ | |
46 | #define ELINKCONG EAGAIN /* link congestion <=> resource unavailable */ | |
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 | */ | |
dff29b1a JPM |
61 | #define LINK_STARTED 0x0001 |
62 | #define LINK_STOPPED 0x0002 | |
63 | #define LINK_SYNCHING 0x0004 | |
64 | #define LINK_FAILINGOVER 0x0008 | |
135daee6 YX |
65 | |
66 | /* Starting value for maximum packet size negotiation on unicast links | |
b97bf3fd PL |
67 | * (unless bearer MTU is less) |
68 | */ | |
b97bf3fd PL |
69 | #define MAX_PKT_DEFAULT 1500 |
70 | ||
7e9cab58 PG |
71 | struct tipc_stats { |
72 | u32 sent_info; /* used in counting # sent packets */ | |
73 | u32 recv_info; /* used in counting # recv'd packets */ | |
74 | u32 sent_states; | |
75 | u32 recv_states; | |
76 | u32 sent_probes; | |
77 | u32 recv_probes; | |
78 | u32 sent_nacks; | |
79 | u32 recv_nacks; | |
80 | u32 sent_acks; | |
81 | u32 sent_bundled; | |
82 | u32 sent_bundles; | |
83 | u32 recv_bundled; | |
84 | u32 recv_bundles; | |
85 | u32 retransmitted; | |
86 | u32 sent_fragmented; | |
87 | u32 sent_fragments; | |
88 | u32 recv_fragmented; | |
89 | u32 recv_fragments; | |
90 | u32 link_congs; /* # port sends blocked by congestion */ | |
7e9cab58 PG |
91 | u32 deferred_recv; |
92 | u32 duplicates; | |
93 | u32 max_queue_sz; /* send queue size high water mark */ | |
94 | u32 accu_queue_sz; /* used for send queue size profiling */ | |
95 | u32 queue_sz_counts; /* used for send queue size profiling */ | |
96 | u32 msg_length_counts; /* used for message length profiling */ | |
97 | u32 msg_lengths_total; /* used for message length profiling */ | |
98 | u32 msg_length_profile[7]; /* used for msg. length profiling */ | |
99 | }; | |
100 | ||
b97bf3fd | 101 | /** |
a18c4bc3 | 102 | * struct tipc_link - TIPC link data structure |
b97bf3fd PL |
103 | * @addr: network address of link's peer node |
104 | * @name: link name character string | |
105 | * @media_addr: media address to use when sending messages over link | |
106 | * @timer: link timer | |
107 | * @owner: pointer to peer node | |
2d72d495 | 108 | * @refcnt: reference counter for permanent references (owner node & timer) |
135daee6 | 109 | * @flags: execution state flags for link endpoint instance |
b97bf3fd PL |
110 | * @checkpoint: reference point for triggering link continuity checking |
111 | * @peer_session: link session # being used by peer end of link | |
112 | * @peer_bearer_id: bearer id used by link's peer endpoint | |
7a2f7d18 | 113 | * @bearer_id: local bearer id used by link |
c4307285 | 114 | * @tolerance: minimum link continuity loss needed to reset link [in ms] |
2f55c437 | 115 | * @cont_intv: link continuity testing interval |
b97bf3fd PL |
116 | * @abort_limit: # of unacknowledged continuity probes needed to reset link |
117 | * @state: current state of link FSM | |
b97bf3fd PL |
118 | * @fsm_msg_cnt: # of protocol messages link FSM has sent in current state |
119 | * @proto_msg: template for control messages generated by link | |
120 | * @pmsg: convenience pointer to "proto_msg" field | |
121 | * @priority: current link priority | |
7a2f7d18 | 122 | * @net_plane: current link network plane ('A' through 'H') |
1f66d161 | 123 | * @backlog_limit: backlog queue congestion thresholds (indexed by importance) |
b97bf3fd PL |
124 | * @exp_msg_count: # of tunnelled messages expected during link changeover |
125 | * @reset_checkpoint: seq # of last acknowledged message at time of link reset | |
ed193ece JPM |
126 | * @mtu: current maximum packet size for this link |
127 | * @advertised_mtu: advertised own mtu when link is being established | |
05dcc5aa JPM |
128 | * @transmitq: queue for sent, non-acked messages |
129 | * @backlogq: queue for messages waiting to be sent | |
b97bf3fd PL |
130 | * @next_out_no: next sequence number to use for outbound messages |
131 | * @last_retransmitted: sequence number of most recently retransmitted message | |
132 | * @stale_count: # of identical retransmit requests made by peer | |
133 | * @next_in_no: next sequence number to expect for inbound messages | |
bc6fecd4 | 134 | * @deferred_queue: deferred queue saved OOS b'cast message received from node |
b97bf3fd | 135 | * @unacked_window: # of inbound messages rx'd without ack'ing back to peer |
c637c103 JPM |
136 | * @inputq: buffer queue for messages to be delivered upwards |
137 | * @namedq: buffer queue for name table messages to be delivered upwards | |
b97bf3fd | 138 | * @next_out: ptr to first unsent outbound message in queue |
c637c103 | 139 | * @wakeupq: linked list of wakeup msgs waiting for link congestion to abate |
b97bf3fd | 140 | * @long_msg_seq_no: next identifier to use for outbound fragmented messages |
37e22164 | 141 | * @reasm_buf: head of partially reassembled inbound message fragments |
b97bf3fd | 142 | * @stats: collects statistics regarding link activity |
b97bf3fd | 143 | */ |
a18c4bc3 | 144 | struct tipc_link { |
b97bf3fd PL |
145 | u32 addr; |
146 | char name[TIPC_MAX_LINK_NAME]; | |
147 | struct tipc_media_addr media_addr; | |
148 | struct timer_list timer; | |
6c00055a | 149 | struct tipc_node *owner; |
2d72d495 | 150 | struct kref ref; |
b97bf3fd PL |
151 | |
152 | /* Management and link supervision data */ | |
135daee6 | 153 | unsigned int flags; |
b97bf3fd PL |
154 | u32 checkpoint; |
155 | u32 peer_session; | |
156 | u32 peer_bearer_id; | |
7a2f7d18 | 157 | u32 bearer_id; |
b97bf3fd | 158 | u32 tolerance; |
2f55c437 | 159 | unsigned long cont_intv; |
b97bf3fd PL |
160 | u32 abort_limit; |
161 | int state; | |
b97bf3fd PL |
162 | u32 fsm_msg_cnt; |
163 | struct { | |
164 | unchar hdr[INT_H_SIZE]; | |
165 | unchar body[TIPC_MAX_IF_NAME]; | |
166 | } proto_msg; | |
167 | struct tipc_msg *pmsg; | |
168 | u32 priority; | |
7a2f7d18 | 169 | char net_plane; |
dff29b1a | 170 | u16 synch_point; |
b97bf3fd | 171 | |
dff29b1a JPM |
172 | /* Failover */ |
173 | u16 failover_pkts; | |
174 | u16 failover_checkpt; | |
175 | struct sk_buff *failover_skb; | |
b97bf3fd | 176 | |
c4307285 | 177 | /* Max packet negotiation */ |
ed193ece JPM |
178 | u16 mtu; |
179 | u16 advertised_mtu; | |
b97bf3fd PL |
180 | |
181 | /* Sending */ | |
05dcc5aa JPM |
182 | struct sk_buff_head transmq; |
183 | struct sk_buff_head backlogq; | |
1f66d161 JPM |
184 | struct { |
185 | u16 len; | |
186 | u16 limit; | |
187 | } backlog[5]; | |
b97bf3fd | 188 | u32 next_out_no; |
05dcc5aa | 189 | u32 window; |
c4307285 YH |
190 | u32 last_retransmitted; |
191 | u32 stale_count; | |
b97bf3fd PL |
192 | |
193 | /* Reception */ | |
194 | u32 next_in_no; | |
05dcc5aa JPM |
195 | u32 rcv_unacked; |
196 | struct sk_buff_head deferdq; | |
c637c103 JPM |
197 | struct sk_buff_head inputq; |
198 | struct sk_buff_head namedq; | |
b97bf3fd PL |
199 | |
200 | /* Congestion handling */ | |
c637c103 | 201 | struct sk_buff_head wakeupq; |
b97bf3fd | 202 | |
40ba3cdf | 203 | /* Fragmentation/reassembly */ |
37e22164 | 204 | struct sk_buff *reasm_buf; |
b97bf3fd | 205 | |
c4307285 | 206 | /* Statistics */ |
7e9cab58 | 207 | struct tipc_stats stats; |
b97bf3fd PL |
208 | }; |
209 | ||
23dd4cce | 210 | struct tipc_port; |
b97bf3fd | 211 | |
a18c4bc3 | 212 | struct tipc_link *tipc_link_create(struct tipc_node *n_ptr, |
37b9c08a | 213 | struct tipc_bearer *b_ptr, |
4323add6 | 214 | const struct tipc_media_addr *media_addr); |
7d24dcdb | 215 | void tipc_link_delete(struct tipc_link *link); |
f2f9800d YX |
216 | void tipc_link_delete_list(struct net *net, unsigned int bearer_id, |
217 | bool shutting_down); | |
170b3927 | 218 | void tipc_link_failover_send_queue(struct tipc_link *l_ptr); |
247f0f3c | 219 | void tipc_link_dup_queue_xmit(struct tipc_link *l_ptr, struct tipc_link *dest); |
a18c4bc3 PG |
220 | void tipc_link_reset_fragments(struct tipc_link *l_ptr); |
221 | int tipc_link_is_up(struct tipc_link *l_ptr); | |
222 | int tipc_link_is_active(struct tipc_link *l_ptr); | |
581465fa | 223 | void tipc_link_purge_queues(struct tipc_link *l_ptr); |
3f5a12bd | 224 | void tipc_link_reset_all(struct tipc_node *node); |
a18c4bc3 | 225 | void tipc_link_reset(struct tipc_link *l_ptr); |
f2f9800d YX |
226 | void tipc_link_reset_list(struct net *net, unsigned int bearer_id); |
227 | int tipc_link_xmit_skb(struct net *net, struct sk_buff *skb, u32 dest, | |
228 | u32 selector); | |
229 | int tipc_link_xmit(struct net *net, struct sk_buff_head *list, u32 dest, | |
230 | u32 selector); | |
7f9f95d9 YX |
231 | int __tipc_link_xmit(struct net *net, struct tipc_link *link, |
232 | struct sk_buff_head *list); | |
247f0f3c | 233 | void tipc_link_proto_xmit(struct tipc_link *l_ptr, u32 msg_typ, int prob, |
ed193ece | 234 | u32 gap, u32 tolerance, u32 priority); |
47b4c9a8 | 235 | void tipc_link_push_packets(struct tipc_link *l_ptr); |
bc6fecd4 | 236 | u32 tipc_link_defer_pkt(struct sk_buff_head *list, struct sk_buff *buf); |
a18c4bc3 PG |
237 | void tipc_link_set_queue_limits(struct tipc_link *l_ptr, u32 window); |
238 | void tipc_link_retransmit(struct tipc_link *l_ptr, | |
239 | struct sk_buff *start, u32 retransmits); | |
58dc55f2 YX |
240 | struct sk_buff *tipc_skb_queue_next(const struct sk_buff_head *list, |
241 | const struct sk_buff *skb); | |
b97bf3fd | 242 | |
7be57fc6 RA |
243 | int tipc_nl_link_dump(struct sk_buff *skb, struct netlink_callback *cb); |
244 | int tipc_nl_link_get(struct sk_buff *skb, struct genl_info *info); | |
f96ce7a2 | 245 | int tipc_nl_link_set(struct sk_buff *skb, struct genl_info *info); |
ae36342b | 246 | int tipc_nl_link_reset_stats(struct sk_buff *skb, struct genl_info *info); |
0655f6a8 | 247 | int tipc_nl_parse_link_prop(struct nlattr *prop, struct nlattr *props[]); |
c637c103 | 248 | void link_prepare_wakeup(struct tipc_link *l); |
0655f6a8 | 249 | |
b97bf3fd PL |
250 | /* |
251 | * Link sequence number manipulation routines (uses modulo 2**16 arithmetic) | |
252 | */ | |
f905730c AS |
253 | static inline u32 buf_seqno(struct sk_buff *buf) |
254 | { | |
255 | return msg_seqno(buf_msg(buf)); | |
256 | } | |
257 | ||
b97bf3fd PL |
258 | static inline u32 mod(u32 x) |
259 | { | |
260 | return x & 0xffffu; | |
261 | } | |
262 | ||
b97bf3fd PL |
263 | static inline int less_eq(u32 left, u32 right) |
264 | { | |
a02cec21 | 265 | return mod(right - left) < 32768u; |
b97bf3fd PL |
266 | } |
267 | ||
58dc55f2 YX |
268 | static inline int more(u32 left, u32 right) |
269 | { | |
270 | return !less_eq(left, right); | |
271 | } | |
272 | ||
b97bf3fd PL |
273 | static inline int less(u32 left, u32 right) |
274 | { | |
a02cec21 | 275 | return less_eq(left, right) && (mod(right) != mod(left)); |
b97bf3fd PL |
276 | } |
277 | ||
278 | static inline u32 lesser(u32 left, u32 right) | |
279 | { | |
280 | return less_eq(left, right) ? left : right; | |
281 | } | |
282 | ||
c5898636 JPM |
283 | static inline u32 link_own_addr(struct tipc_link *l) |
284 | { | |
285 | return msg_prevnode(l->pmsg); | |
286 | } | |
01fee256 AS |
287 | |
288 | /* | |
289 | * Link status checking routines | |
290 | */ | |
a18c4bc3 | 291 | static inline int link_working_working(struct tipc_link *l_ptr) |
01fee256 | 292 | { |
a02cec21 | 293 | return l_ptr->state == WORKING_WORKING; |
01fee256 AS |
294 | } |
295 | ||
a18c4bc3 | 296 | static inline int link_working_unknown(struct tipc_link *l_ptr) |
01fee256 | 297 | { |
a02cec21 | 298 | return l_ptr->state == WORKING_UNKNOWN; |
01fee256 AS |
299 | } |
300 | ||
a18c4bc3 | 301 | static inline int link_reset_unknown(struct tipc_link *l_ptr) |
01fee256 | 302 | { |
a02cec21 | 303 | return l_ptr->state == RESET_UNKNOWN; |
01fee256 AS |
304 | } |
305 | ||
a18c4bc3 | 306 | static inline int link_reset_reset(struct tipc_link *l_ptr) |
01fee256 | 307 | { |
a02cec21 | 308 | return l_ptr->state == RESET_RESET; |
01fee256 AS |
309 | } |
310 | ||
b97bf3fd | 311 | #endif |