]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - net/tipc/link.h
hso: Use static attribute groups for sysfs entry
[mirror_ubuntu-artful-kernel.git] / net / tipc / link.h
CommitLineData
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 */
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
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 */
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
2d72d495 106 * @refcnt: reference counter for permanent references (owner node & timer)
135daee6 107 * @flags: execution state flags for link endpoint instance
b97bf3fd
PL
108 * @checkpoint: reference point for triggering link continuity checking
109 * @peer_session: link session # being used by peer end of link
110 * @peer_bearer_id: bearer id used by link's peer endpoint
7a2f7d18 111 * @bearer_id: local bearer id used by link
c4307285 112 * @tolerance: minimum link continuity loss needed to reset link [in ms]
2f55c437 113 * @cont_intv: link continuity testing interval
b97bf3fd
PL
114 * @abort_limit: # of unacknowledged continuity probes needed to reset link
115 * @state: current state of link FSM
b97bf3fd
PL
116 * @fsm_msg_cnt: # of protocol messages link FSM has sent in current state
117 * @proto_msg: template for control messages generated by link
118 * @pmsg: convenience pointer to "proto_msg" field
119 * @priority: current link priority
7a2f7d18 120 * @net_plane: current link network plane ('A' through 'H')
b97bf3fd
PL
121 * @queue_limit: outbound message queue congestion thresholds (indexed by user)
122 * @exp_msg_count: # of tunnelled messages expected during link changeover
123 * @reset_checkpoint: seq # of last acknowledged message at time of link reset
124 * @max_pkt: current maximum packet size for this link
125 * @max_pkt_target: desired maximum packet size for this link
126 * @max_pkt_probes: # of probes based on current (max_pkt, max_pkt_target)
58dc55f2 127 * @outqueue: outbound message queue
b97bf3fd
PL
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
bc6fecd4 132 * @deferred_queue: deferred queue saved OOS b'cast message received from node
b97bf3fd 133 * @unacked_window: # of inbound messages rx'd without ack'ing back to peer
b97bf3fd 134 * @next_out: ptr to first unsent outbound message in queue
50100a5e 135 * @waiting_sks: linked list of sockets waiting for link congestion to abate
b97bf3fd 136 * @long_msg_seq_no: next identifier to use for outbound fragmented messages
37e22164 137 * @reasm_buf: head of partially reassembled inbound message fragments
b97bf3fd 138 * @stats: collects statistics regarding link activity
b97bf3fd 139 */
a18c4bc3 140struct tipc_link {
b97bf3fd
PL
141 u32 addr;
142 char name[TIPC_MAX_LINK_NAME];
143 struct tipc_media_addr media_addr;
144 struct timer_list timer;
6c00055a 145 struct tipc_node *owner;
2d72d495 146 struct kref ref;
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 154 u32 tolerance;
2f55c437 155 unsigned long cont_intv;
b97bf3fd
PL
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 */
58dc55f2 178 struct sk_buff_head outqueue;
b97bf3fd 179 u32 next_out_no;
c4307285
YH
180 u32 last_retransmitted;
181 u32 stale_count;
b97bf3fd
PL
182
183 /* Reception */
184 u32 next_in_no;
bc6fecd4 185 struct sk_buff_head deferred_queue;
b97bf3fd
PL
186 u32 unacked_window;
187
188 /* Congestion handling */
b97bf3fd 189 struct sk_buff *next_out;
50100a5e 190 struct sk_buff_head waiting_sks;
b97bf3fd 191
40ba3cdf 192 /* Fragmentation/reassembly */
b97bf3fd 193 u32 long_msg_seq_no;
37e22164 194 struct sk_buff *reasm_buf;
b97bf3fd 195
c4307285 196 /* Statistics */
7e9cab58 197 struct tipc_stats stats;
b97bf3fd
PL
198};
199
23dd4cce 200struct tipc_port;
b97bf3fd 201
a18c4bc3 202struct tipc_link *tipc_link_create(struct tipc_node *n_ptr,
37b9c08a 203 struct tipc_bearer *b_ptr,
4323add6 204 const struct tipc_media_addr *media_addr);
7d24dcdb 205void tipc_link_delete(struct tipc_link *link);
f2f9800d
YX
206void tipc_link_delete_list(struct net *net, unsigned int bearer_id,
207 bool shutting_down);
170b3927 208void tipc_link_failover_send_queue(struct tipc_link *l_ptr);
247f0f3c 209void tipc_link_dup_queue_xmit(struct tipc_link *l_ptr, struct tipc_link *dest);
a18c4bc3
PG
210void tipc_link_reset_fragments(struct tipc_link *l_ptr);
211int tipc_link_is_up(struct tipc_link *l_ptr);
212int tipc_link_is_active(struct tipc_link *l_ptr);
581465fa 213void tipc_link_purge_queues(struct tipc_link *l_ptr);
f2f9800d
YX
214struct sk_buff *tipc_link_cmd_config(struct net *net, const void *req_tlv_area,
215 int req_tlv_space, u16 cmd);
216struct sk_buff *tipc_link_cmd_show_stats(struct net *net,
217 const void *req_tlv_area,
170b3927 218 int req_tlv_space);
f2f9800d
YX
219struct sk_buff *tipc_link_cmd_reset_stats(struct net *net,
220 const void *req_tlv_area,
170b3927 221 int req_tlv_space);
3f5a12bd 222void tipc_link_reset_all(struct tipc_node *node);
a18c4bc3 223void tipc_link_reset(struct tipc_link *l_ptr);
f2f9800d
YX
224void tipc_link_reset_list(struct net *net, unsigned int bearer_id);
225int tipc_link_xmit_skb(struct net *net, struct sk_buff *skb, u32 dest,
226 u32 selector);
227int tipc_link_xmit(struct net *net, struct sk_buff_head *list, u32 dest,
228 u32 selector);
7f9f95d9
YX
229int __tipc_link_xmit(struct net *net, struct tipc_link *link,
230 struct sk_buff_head *list);
f2f9800d 231void tipc_link_bundle_rcv(struct net *net, struct sk_buff *buf);
247f0f3c
YX
232void tipc_link_proto_xmit(struct tipc_link *l_ptr, u32 msg_typ, int prob,
233 u32 gap, u32 tolerance, u32 priority, u32 acked_mtu);
47b4c9a8 234void tipc_link_push_packets(struct tipc_link *l_ptr);
bc6fecd4 235u32 tipc_link_defer_pkt(struct sk_buff_head *list, struct sk_buff *buf);
a18c4bc3
PG
236void tipc_link_set_queue_limits(struct tipc_link *l_ptr, u32 window);
237void tipc_link_retransmit(struct tipc_link *l_ptr,
238 struct sk_buff *start, u32 retransmits);
58dc55f2
YX
239struct sk_buff *tipc_skb_queue_next(const struct sk_buff_head *list,
240 const struct sk_buff *skb);
b97bf3fd 241
7be57fc6
RA
242int tipc_nl_link_dump(struct sk_buff *skb, struct netlink_callback *cb);
243int tipc_nl_link_get(struct sk_buff *skb, struct genl_info *info);
f96ce7a2 244int tipc_nl_link_set(struct sk_buff *skb, struct genl_info *info);
ae36342b 245int tipc_nl_link_reset_stats(struct sk_buff *skb, struct genl_info *info);
0655f6a8
RA
246int tipc_nl_parse_link_prop(struct nlattr *prop, struct nlattr *props[]);
247
b97bf3fd
PL
248/*
249 * Link sequence number manipulation routines (uses modulo 2**16 arithmetic)
250 */
f905730c
AS
251static inline u32 buf_seqno(struct sk_buff *buf)
252{
253 return msg_seqno(buf_msg(buf));
254}
255
b97bf3fd
PL
256static inline u32 mod(u32 x)
257{
258 return x & 0xffffu;
259}
260
b97bf3fd
PL
261static inline int less_eq(u32 left, u32 right)
262{
a02cec21 263 return mod(right - left) < 32768u;
b97bf3fd
PL
264}
265
58dc55f2
YX
266static inline int more(u32 left, u32 right)
267{
268 return !less_eq(left, right);
269}
270
b97bf3fd
PL
271static inline int less(u32 left, u32 right)
272{
a02cec21 273 return less_eq(left, right) && (mod(right) != mod(left));
b97bf3fd
PL
274}
275
276static inline u32 lesser(u32 left, u32 right)
277{
278 return less_eq(left, right) ? left : right;
279}
280
01fee256
AS
281
282/*
283 * Link status checking routines
284 */
a18c4bc3 285static inline int link_working_working(struct tipc_link *l_ptr)
01fee256 286{
a02cec21 287 return l_ptr->state == WORKING_WORKING;
01fee256
AS
288}
289
a18c4bc3 290static inline int link_working_unknown(struct tipc_link *l_ptr)
01fee256 291{
a02cec21 292 return l_ptr->state == WORKING_UNKNOWN;
01fee256
AS
293}
294
a18c4bc3 295static inline int link_reset_unknown(struct tipc_link *l_ptr)
01fee256 296{
a02cec21 297 return l_ptr->state == RESET_UNKNOWN;
01fee256
AS
298}
299
a18c4bc3 300static inline int link_reset_reset(struct tipc_link *l_ptr)
01fee256 301{
a02cec21 302 return l_ptr->state == RESET_RESET;
01fee256
AS
303}
304
a18c4bc3 305static inline int link_congested(struct tipc_link *l_ptr)
01fee256 306{
58dc55f2 307 return skb_queue_len(&l_ptr->outqueue) >= l_ptr->queue_limit[0];
01fee256
AS
308}
309
b97bf3fd 310#endif