2 * net/tipc/link.h: Include file for TIPC link code
4 * Copyright (c) 2003-2005, Ericsson Research Canada
5 * Copyright (c) 2004-2005, Wind River Systems
6 * Copyright (c) 2005-2006, Ericsson AB
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions are met:
12 * Redistributions of source code must retain the above copyright notice, this
13 * list of conditions and the following disclaimer.
14 * Redistributions in binary form must reproduce the above copyright notice,
15 * this list of conditions and the following disclaimer in the documentation
16 * and/or other materials provided with the distribution.
17 * Neither the names of the copyright holders nor the names of its
18 * contributors may be used to endorse or promote products derived from this
19 * software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
25 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 * POSSIBILITY OF SUCH DAMAGE.
43 #define PUSH_FINISHED 2
49 #define WORKING_WORKING 560810u
50 #define WORKING_UNKNOWN 560811u
51 #define RESET_UNKNOWN 560812u
52 #define RESET_RESET 560813u
55 * Starting value for maximum packet size negotiation on unicast links
56 * (unless bearer MTU is less)
59 #define MAX_PKT_DEFAULT 1500
62 * struct link - TIPC link data structure
63 * @addr: network address of link's peer node
64 * @name: link name character string
65 * @media_addr: media address to use when sending messages over link
67 * @owner: pointer to peer node
68 * @link_list: adjacent links in bearer's list of links
69 * @started: indicates if link has been started
70 * @checkpoint: reference point for triggering link continuity checking
71 * @peer_session: link session # being used by peer end of link
72 * @peer_bearer_id: bearer id used by link's peer endpoint
73 * @b_ptr: pointer to bearer used by link
74 * @tolerance: minimum link continuity loss needed to reset link [in ms]
75 * @continuity_interval: link continuity testing interval [in ms]
76 * @abort_limit: # of unacknowledged continuity probes needed to reset link
77 * @state: current state of link FSM
78 * @blocked: indicates if link has been administratively blocked
79 * @fsm_msg_cnt: # of protocol messages link FSM has sent in current state
80 * @proto_msg: template for control messages generated by link
81 * @pmsg: convenience pointer to "proto_msg" field
82 * @priority: current link priority
83 * @queue_limit: outbound message queue congestion thresholds (indexed by user)
84 * @exp_msg_count: # of tunnelled messages expected during link changeover
85 * @reset_checkpoint: seq # of last acknowledged message at time of link reset
86 * @max_pkt: current maximum packet size for this link
87 * @max_pkt_target: desired maximum packet size for this link
88 * @max_pkt_probes: # of probes based on current (max_pkt, max_pkt_target)
89 * @out_queue_size: # of messages in outbound message queue
90 * @first_out: ptr to first outbound message in queue
91 * @last_out: ptr to last outbound message in queue
92 * @next_out_no: next sequence number to use for outbound messages
93 * @last_retransmitted: sequence number of most recently retransmitted message
94 * @stale_count: # of identical retransmit requests made by peer
95 * @next_in_no: next sequence number to expect for inbound messages
96 * @deferred_inqueue_sz: # of messages in inbound message queue
97 * @oldest_deferred_in: ptr to first inbound message in queue
98 * @newest_deferred_in: ptr to last inbound message in queue
99 * @unacked_window: # of inbound messages rx'd without ack'ing back to peer
100 * @proto_msg_queue: ptr to (single) outbound control message
101 * @retransm_queue_size: number of messages to retransmit
102 * @retransm_queue_head: sequence number of first message to retransmit
103 * @next_out: ptr to first unsent outbound message in queue
104 * @waiting_ports: linked list of ports waiting for link congestion to abate
105 * @long_msg_seq_no: next identifier to use for outbound fragmented messages
106 * @defragm_buf: list of partially reassembled inbound message fragments
107 * @stats: collects statistics regarding link activity
108 * @print_buf: print buffer used to log link activity
113 char name
[TIPC_MAX_LINK_NAME
];
114 struct tipc_media_addr media_addr
;
115 struct timer_list timer
;
117 struct list_head link_list
;
119 /* Management and link supervision data */
124 struct bearer
*b_ptr
;
126 u32 continuity_interval
;
132 unchar hdr
[INT_H_SIZE
];
133 unchar body
[TIPC_MAX_IF_NAME
];
135 struct tipc_msg
*pmsg
;
137 u32 queue_limit
[15]; /* queue_limit[0]==window limit */
141 u32 reset_checkpoint
;
143 /* Max packet negotiation */
150 struct sk_buff
*first_out
;
151 struct sk_buff
*last_out
;
153 u32 last_retransmitted
;
158 u32 deferred_inqueue_sz
;
159 struct sk_buff
*oldest_deferred_in
;
160 struct sk_buff
*newest_deferred_in
;
163 /* Congestion handling */
164 struct sk_buff
*proto_msg_queue
;
165 u32 retransm_queue_size
;
166 u32 retransm_queue_head
;
167 struct sk_buff
*next_out
;
168 struct list_head waiting_ports
;
170 /* Fragmentation/defragmentation */
172 struct sk_buff
*defragm_buf
;
176 u32 sent_info
; /* used in counting # sent packets */
177 u32 recv_info
; /* used in counting # recv'd packets */
194 u32 link_congs
; /* # port sends blocked by congestion */
199 /* for statistical profiling of send queue size */
205 /* for statistical profiling of message lengths */
207 u32 msg_length_counts
;
208 u32 msg_lengths_total
;
209 u32 msg_length_profile
[7];
216 struct print_buf print_buf
;
221 struct link
*link_create(struct bearer
*b_ptr
, const u32 peer
,
222 const struct tipc_media_addr
*media_addr
);
223 void link_delete(struct link
*l_ptr
);
224 void link_changeover(struct link
*l_ptr
);
225 void link_send_duplicate(struct link
*l_ptr
, struct link
*dest
);
226 void link_reset_fragments(struct link
*l_ptr
);
227 int link_is_up(struct link
*l_ptr
);
228 int link_is_active(struct link
*l_ptr
);
229 void link_start(struct link
*l_ptr
);
230 u32
link_push_packet(struct link
*l_ptr
);
231 void link_stop(struct link
*l_ptr
);
232 struct sk_buff
*link_cmd_config(const void *req_tlv_area
, int req_tlv_space
, u16 cmd
);
233 struct sk_buff
*link_cmd_show_stats(const void *req_tlv_area
, int req_tlv_space
);
234 struct sk_buff
*link_cmd_reset_stats(const void *req_tlv_area
, int req_tlv_space
);
235 void link_reset(struct link
*l_ptr
);
236 int link_send(struct sk_buff
*buf
, u32 dest
, u32 selector
);
237 int link_send_buf(struct link
*l_ptr
, struct sk_buff
*buf
);
238 u32
link_get_max_pkt(u32 dest
,u32 selector
);
239 int link_send_sections_fast(struct port
* sender
,
240 struct iovec
const *msg_sect
,
244 int link_send_long_buf(struct link
*l_ptr
, struct sk_buff
*buf
);
245 void link_tunnel(struct link
*l_ptr
, struct tipc_msg
*tnl_hdr
,
246 struct tipc_msg
*msg
, u32 selector
);
247 void link_recv_bundle(struct sk_buff
*buf
);
248 int link_recv_fragment(struct sk_buff
**pending
,
250 struct tipc_msg
**msg
);
251 void link_send_proto_msg(struct link
*l_ptr
, u32 msg_typ
, int prob
, u32 gap
,
252 u32 tolerance
, u32 priority
, u32 acked_mtu
);
253 void link_push_queue(struct link
*l_ptr
);
254 u32
link_defer_pkt(struct sk_buff
**head
, struct sk_buff
**tail
,
255 struct sk_buff
*buf
);
256 void link_wakeup_ports(struct link
*l_ptr
, int all
);
257 void link_set_queue_limits(struct link
*l_ptr
, u32 window
);
258 void link_retransmit(struct link
*l_ptr
, struct sk_buff
*start
, u32 retransmits
);
261 * Link sequence number manipulation routines (uses modulo 2**16 arithmetic)
264 static inline u32
mod(u32 x
)
269 static inline int between(u32 lower
, u32 upper
, u32 n
)
271 if ((lower
< n
) && (n
< upper
))
273 if ((upper
< lower
) && ((n
> lower
) || (n
< upper
)))
278 static inline int less_eq(u32 left
, u32 right
)
280 return (mod(right
- left
) < 32768u);
283 static inline int less(u32 left
, u32 right
)
285 return (less_eq(left
, right
) && (mod(right
) != mod(left
)));
288 static inline u32
lesser(u32 left
, u32 right
)
290 return less_eq(left
, right
) ? left
: right
;