Loading...
1/*
2 * net/tipc/link.h: Include file for TIPC link code
3 *
4 * Copyright (c) 1995-2006, 2013, Ericsson AB
5 * Copyright (c) 2004-2005, 2010-2011, 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
37#ifndef _TIPC_LINK_H
38#define _TIPC_LINK_H
39
40#include "msg.h"
41#include "node.h"
42
43/* Link reassembly status codes
44 */
45#define LINK_REASM_ERROR -1
46#define LINK_REASM_COMPLETE 1
47
48/* Out-of-range value for link sequence numbers
49 */
50#define INVALID_LINK_SEQ 0x10000
51
52/* Link working states
53 */
54#define WORKING_WORKING 560810u
55#define WORKING_UNKNOWN 560811u
56#define RESET_UNKNOWN 560812u
57#define RESET_RESET 560813u
58
59/* Link endpoint execution states
60 */
61#define LINK_STARTED 0x0001
62#define LINK_STOPPED 0x0002
63
64/* Starting value for maximum packet size negotiation on unicast links
65 * (unless bearer MTU is less)
66 */
67#define MAX_PKT_DEFAULT 1500
68
69struct 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 */
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
99/**
100 * struct tipc_link - TIPC link data structure
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
106 * @flags: execution state flags for link endpoint instance
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
110 * @b_ptr: pointer to bearer used by link
111 * @tolerance: minimum link continuity loss needed to reset link [in ms]
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
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
119 * @queue_limit: outbound message queue congestion thresholds (indexed by user)
120 * @exp_msg_count: # of tunnelled messages expected during link changeover
121 * @reset_checkpoint: seq # of last acknowledged message at time of link reset
122 * @max_pkt: current maximum packet size for this link
123 * @max_pkt_target: desired maximum packet size for this link
124 * @max_pkt_probes: # of probes based on current (max_pkt, max_pkt_target)
125 * @out_queue_size: # of messages in outbound message queue
126 * @first_out: ptr to first outbound message in queue
127 * @last_out: ptr to last outbound message in queue
128 * @next_out_no: next sequence number to use for outbound messages
129 * @last_retransmitted: sequence number of most recently retransmitted message
130 * @stale_count: # of identical retransmit requests made by peer
131 * @next_in_no: next sequence number to expect for inbound messages
132 * @deferred_inqueue_sz: # of messages in inbound message queue
133 * @oldest_deferred_in: ptr to first inbound message in queue
134 * @newest_deferred_in: ptr to last inbound message in queue
135 * @unacked_window: # of inbound messages rx'd without ack'ing back to peer
136 * @proto_msg_queue: ptr to (single) outbound control message
137 * @retransm_queue_size: number of messages to retransmit
138 * @retransm_queue_head: sequence number of first message to retransmit
139 * @next_out: ptr to first unsent outbound message in queue
140 * @waiting_ports: linked list of ports waiting for link congestion to abate
141 * @long_msg_seq_no: next identifier to use for outbound fragmented messages
142 * @reasm_head: list head of partially reassembled inbound message fragments
143 * @reasm_tail: last fragment received
144 * @stats: collects statistics regarding link activity
145 */
146struct tipc_link {
147 u32 addr;
148 char name[TIPC_MAX_LINK_NAME];
149 struct tipc_media_addr media_addr;
150 struct timer_list timer;
151 struct tipc_node *owner;
152
153 /* Management and link supervision data */
154 unsigned int flags;
155 u32 checkpoint;
156 u32 peer_session;
157 u32 peer_bearer_id;
158 struct tipc_bearer *b_ptr;
159 u32 tolerance;
160 u32 continuity_interval;
161 u32 abort_limit;
162 int state;
163 u32 fsm_msg_cnt;
164 struct {
165 unchar hdr[INT_H_SIZE];
166 unchar body[TIPC_MAX_IF_NAME];
167 } proto_msg;
168 struct tipc_msg *pmsg;
169 u32 priority;
170 u32 queue_limit[15]; /* queue_limit[0]==window limit */
171
172 /* Changeover */
173 u32 exp_msg_count;
174 u32 reset_checkpoint;
175
176 /* Max packet negotiation */
177 u32 max_pkt;
178 u32 max_pkt_target;
179 u32 max_pkt_probes;
180
181 /* Sending */
182 u32 out_queue_size;
183 struct sk_buff *first_out;
184 struct sk_buff *last_out;
185 u32 next_out_no;
186 u32 last_retransmitted;
187 u32 stale_count;
188
189 /* Reception */
190 u32 next_in_no;
191 u32 deferred_inqueue_sz;
192 struct sk_buff *oldest_deferred_in;
193 struct sk_buff *newest_deferred_in;
194 u32 unacked_window;
195
196 /* Congestion handling */
197 struct sk_buff *proto_msg_queue;
198 u32 retransm_queue_size;
199 u32 retransm_queue_head;
200 struct sk_buff *next_out;
201 struct list_head waiting_ports;
202
203 /* Fragmentation/reassembly */
204 u32 long_msg_seq_no;
205 struct sk_buff *reasm_head;
206 struct sk_buff *reasm_tail;
207
208 /* Statistics */
209 struct tipc_stats stats;
210};
211
212struct tipc_port;
213
214struct tipc_link *tipc_link_create(struct tipc_node *n_ptr,
215 struct tipc_bearer *b_ptr,
216 const struct tipc_media_addr *media_addr);
217void tipc_link_delete_list(unsigned int bearer_id, bool shutting_down);
218void tipc_link_failover_send_queue(struct tipc_link *l_ptr);
219void tipc_link_dup_queue_xmit(struct tipc_link *l_ptr, struct tipc_link *dest);
220void tipc_link_reset_fragments(struct tipc_link *l_ptr);
221int tipc_link_is_up(struct tipc_link *l_ptr);
222int tipc_link_is_active(struct tipc_link *l_ptr);
223void tipc_link_purge_queues(struct tipc_link *l_ptr);
224struct sk_buff *tipc_link_cmd_config(const void *req_tlv_area,
225 int req_tlv_space,
226 u16 cmd);
227struct sk_buff *tipc_link_cmd_show_stats(const void *req_tlv_area,
228 int req_tlv_space);
229struct sk_buff *tipc_link_cmd_reset_stats(const void *req_tlv_area,
230 int req_tlv_space);
231void tipc_link_reset(struct tipc_link *l_ptr);
232void tipc_link_reset_list(unsigned int bearer_id);
233int tipc_link_xmit(struct sk_buff *buf, u32 dest, u32 selector);
234void tipc_link_names_xmit(struct list_head *message_list, u32 dest);
235int __tipc_link_xmit(struct tipc_link *l_ptr, struct sk_buff *buf);
236int tipc_link_send_buf(struct tipc_link *l_ptr, struct sk_buff *buf);
237u32 tipc_link_get_max_pkt(u32 dest, u32 selector);
238int tipc_link_iovec_xmit_fast(struct tipc_port *sender,
239 struct iovec const *msg_sect,
240 unsigned int len, u32 destnode);
241void tipc_link_bundle_rcv(struct sk_buff *buf);
242int tipc_link_frag_rcv(struct sk_buff **reasm_head,
243 struct sk_buff **reasm_tail,
244 struct sk_buff **fbuf);
245void tipc_link_proto_xmit(struct tipc_link *l_ptr, u32 msg_typ, int prob,
246 u32 gap, u32 tolerance, u32 priority, u32 acked_mtu);
247void tipc_link_push_queue(struct tipc_link *l_ptr);
248u32 tipc_link_defer_pkt(struct sk_buff **head, struct sk_buff **tail,
249 struct sk_buff *buf);
250void tipc_link_wakeup_ports(struct tipc_link *l_ptr, int all);
251void tipc_link_set_queue_limits(struct tipc_link *l_ptr, u32 window);
252void tipc_link_retransmit(struct tipc_link *l_ptr,
253 struct sk_buff *start, u32 retransmits);
254
255/*
256 * Link sequence number manipulation routines (uses modulo 2**16 arithmetic)
257 */
258static inline u32 buf_seqno(struct sk_buff *buf)
259{
260 return msg_seqno(buf_msg(buf));
261}
262
263static inline u32 mod(u32 x)
264{
265 return x & 0xffffu;
266}
267
268static inline int between(u32 lower, u32 upper, u32 n)
269{
270 if ((lower < n) && (n < upper))
271 return 1;
272 if ((upper < lower) && ((n > lower) || (n < upper)))
273 return 1;
274 return 0;
275}
276
277static inline int less_eq(u32 left, u32 right)
278{
279 return mod(right - left) < 32768u;
280}
281
282static inline int less(u32 left, u32 right)
283{
284 return less_eq(left, right) && (mod(right) != mod(left));
285}
286
287static inline u32 lesser(u32 left, u32 right)
288{
289 return less_eq(left, right) ? left : right;
290}
291
292
293/*
294 * Link status checking routines
295 */
296static inline int link_working_working(struct tipc_link *l_ptr)
297{
298 return l_ptr->state == WORKING_WORKING;
299}
300
301static inline int link_working_unknown(struct tipc_link *l_ptr)
302{
303 return l_ptr->state == WORKING_UNKNOWN;
304}
305
306static inline int link_reset_unknown(struct tipc_link *l_ptr)
307{
308 return l_ptr->state == RESET_UNKNOWN;
309}
310
311static inline int link_reset_reset(struct tipc_link *l_ptr)
312{
313 return l_ptr->state == RESET_RESET;
314}
315
316static inline int link_congested(struct tipc_link *l_ptr)
317{
318 return l_ptr->out_queue_size >= l_ptr->queue_limit[0];
319}
320
321#endif
1/*
2 * net/tipc/link.h: Include file for TIPC link code
3 *
4 * Copyright (c) 1995-2006, 2013-2014, Ericsson AB
5 * Copyright (c) 2004-2005, 2010-2011, 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
37#ifndef _TIPC_LINK_H
38#define _TIPC_LINK_H
39
40#include <net/genetlink.h>
41#include "msg.h"
42#include "node.h"
43
44/* TIPC-specific error codes
45*/
46#define ELINKCONG EAGAIN /* link congestion <=> resource unavailable */
47
48/* Link FSM events:
49 */
50enum {
51 LINK_ESTABLISH_EVT = 0xec1ab1e,
52 LINK_PEER_RESET_EVT = 0x9eed0e,
53 LINK_FAILURE_EVT = 0xfa110e,
54 LINK_RESET_EVT = 0x10ca1d0e,
55 LINK_FAILOVER_BEGIN_EVT = 0xfa110bee,
56 LINK_FAILOVER_END_EVT = 0xfa110ede,
57 LINK_SYNCH_BEGIN_EVT = 0xc1ccbee,
58 LINK_SYNCH_END_EVT = 0xc1ccede
59};
60
61/* Events returned from link at packet reception or at timeout
62 */
63enum {
64 TIPC_LINK_UP_EVT = 1,
65 TIPC_LINK_DOWN_EVT = (1 << 1),
66 TIPC_LINK_SND_BC_ACK = (1 << 2)
67};
68
69/* Starting value for maximum packet size negotiation on unicast links
70 * (unless bearer MTU is less)
71 */
72#define MAX_PKT_DEFAULT 1500
73
74bool tipc_link_create(struct net *net, char *if_name, int bearer_id,
75 int tolerance, char net_plane, u32 mtu, int priority,
76 int window, u32 session, u32 ownnode, u32 peer,
77 u16 peer_caps,
78 struct tipc_link *bc_sndlink,
79 struct tipc_link *bc_rcvlink,
80 struct sk_buff_head *inputq,
81 struct sk_buff_head *namedq,
82 struct tipc_link **link);
83bool tipc_link_bc_create(struct net *net, u32 ownnode, u32 peer,
84 int mtu, int window, u16 peer_caps,
85 struct sk_buff_head *inputq,
86 struct sk_buff_head *namedq,
87 struct tipc_link *bc_sndlink,
88 struct tipc_link **link);
89void tipc_link_tnl_prepare(struct tipc_link *l, struct tipc_link *tnl,
90 int mtyp, struct sk_buff_head *xmitq);
91void tipc_link_build_reset_msg(struct tipc_link *l, struct sk_buff_head *xmitq);
92int tipc_link_fsm_evt(struct tipc_link *l, int evt);
93bool tipc_link_is_up(struct tipc_link *l);
94bool tipc_link_peer_is_down(struct tipc_link *l);
95bool tipc_link_is_reset(struct tipc_link *l);
96bool tipc_link_is_establishing(struct tipc_link *l);
97bool tipc_link_is_synching(struct tipc_link *l);
98bool tipc_link_is_failingover(struct tipc_link *l);
99bool tipc_link_is_blocked(struct tipc_link *l);
100void tipc_link_set_active(struct tipc_link *l, bool active);
101void tipc_link_reset(struct tipc_link *l);
102void tipc_link_reset_stats(struct tipc_link *l);
103int tipc_link_xmit(struct tipc_link *link, struct sk_buff_head *list,
104 struct sk_buff_head *xmitq);
105struct sk_buff_head *tipc_link_inputq(struct tipc_link *l);
106u16 tipc_link_rcv_nxt(struct tipc_link *l);
107u16 tipc_link_acked(struct tipc_link *l);
108u32 tipc_link_id(struct tipc_link *l);
109char *tipc_link_name(struct tipc_link *l);
110char tipc_link_plane(struct tipc_link *l);
111int tipc_link_prio(struct tipc_link *l);
112int tipc_link_window(struct tipc_link *l);
113unsigned long tipc_link_tolerance(struct tipc_link *l);
114void tipc_link_set_tolerance(struct tipc_link *l, u32 tol,
115 struct sk_buff_head *xmitq);
116void tipc_link_set_prio(struct tipc_link *l, u32 prio,
117 struct sk_buff_head *xmitq);
118void tipc_link_set_abort_limit(struct tipc_link *l, u32 limit);
119void tipc_link_set_queue_limits(struct tipc_link *l, u32 window);
120int __tipc_nl_add_link(struct net *net, struct tipc_nl_msg *msg,
121 struct tipc_link *link, int nlflags);
122int tipc_nl_parse_link_prop(struct nlattr *prop, struct nlattr *props[]);
123int tipc_link_timeout(struct tipc_link *l, struct sk_buff_head *xmitq);
124int tipc_link_rcv(struct tipc_link *l, struct sk_buff *skb,
125 struct sk_buff_head *xmitq);
126int tipc_link_build_ack_msg(struct tipc_link *l, struct sk_buff_head *xmitq);
127void tipc_link_add_bc_peer(struct tipc_link *snd_l,
128 struct tipc_link *uc_l,
129 struct sk_buff_head *xmitq);
130void tipc_link_remove_bc_peer(struct tipc_link *snd_l,
131 struct tipc_link *rcv_l,
132 struct sk_buff_head *xmitq);
133int tipc_link_bc_peers(struct tipc_link *l);
134void tipc_link_set_mtu(struct tipc_link *l, int mtu);
135int tipc_link_mtu(struct tipc_link *l);
136void tipc_link_bc_ack_rcv(struct tipc_link *l, u16 acked,
137 struct sk_buff_head *xmitq);
138void tipc_link_build_bc_sync_msg(struct tipc_link *l,
139 struct sk_buff_head *xmitq);
140void tipc_link_bc_init_rcv(struct tipc_link *l, struct tipc_msg *hdr);
141void tipc_link_bc_sync_rcv(struct tipc_link *l, struct tipc_msg *hdr,
142 struct sk_buff_head *xmitq);
143int tipc_link_bc_nack_rcv(struct tipc_link *l, struct sk_buff *skb,
144 struct sk_buff_head *xmitq);
145#endif