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