blob: 9df7fa4d3bdd3f7a38e1f5ff6225f79ac74a6534 [file] [log] [blame]
Per Lidenb97bf3f2006-01-02 19:04:38 +01001/*
2 * net/tipc/link.h: Include file for TIPC link code
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +09003 *
Jon Paul Maloy50100a52014-08-22 18:09:07 -04004 * Copyright (c) 1995-2006, 2013-2014, Ericsson AB
Allan Stephens23dd4cc2011-01-07 11:43:40 -05005 * Copyright (c) 2004-2005, 2010-2011, Wind River Systems
Per Lidenb97bf3f2006-01-02 19:04:38 +01006 * All rights reserved.
7 *
Per Liden9ea1fd32006-01-11 13:30:43 +01008 * Redistribution and use in source and binary forms, with or without
Per Lidenb97bf3f2006-01-02 19:04:38 +01009 * modification, are permitted provided that the following conditions are met:
10 *
Per Liden9ea1fd32006-01-11 13:30:43 +010011 * 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.
Per Lidenb97bf3f2006-01-02 19:04:38 +010019 *
Per Liden9ea1fd32006-01-11 13:30:43 +010020 * 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
Per Lidenb97bf3f2006-01-02 19:04:38 +010034 * POSSIBILITY OF SUCH DAMAGE.
35 */
36
37#ifndef _TIPC_LINK_H
38#define _TIPC_LINK_H
39
Richard Alpe0655f6a2014-11-20 10:29:07 +010040#include <net/genetlink.h>
Per Lidenb97bf3f2006-01-02 19:04:38 +010041#include "msg.h"
Per Lidenb97bf3f2006-01-02 19:04:38 +010042#include "node.h"
43
Ying Xue859fc7c2015-01-09 15:27:01 +080044/* TIPC-specific error codes
45*/
46#define ELINKCONG EAGAIN /* link congestion <=> resource unavailable */
47
Ying Xue135daee2014-02-13 17:29:08 -050048/* Out-of-range value for link sequence numbers
Allan Stephens365595912011-10-24 15:26:24 -040049 */
Allan Stephens365595912011-10-24 15:26:24 -040050#define INVALID_LINK_SEQ 0x10000
51
Ying Xue135daee2014-02-13 17:29:08 -050052/* Link working states
Per Lidenb97bf3f2006-01-02 19:04:38 +010053 */
Per Lidenb97bf3f2006-01-02 19:04:38 +010054#define WORKING_WORKING 560810u
55#define WORKING_UNKNOWN 560811u
56#define RESET_UNKNOWN 560812u
57#define RESET_RESET 560813u
58
Ying Xue135daee2014-02-13 17:29:08 -050059/* Link endpoint execution states
60 */
61#define LINK_STARTED 0x0001
Ying Xuec61dd612014-02-13 17:29:09 -050062#define LINK_STOPPED 0x0002
Ying Xue135daee2014-02-13 17:29:08 -050063
64/* Starting value for maximum packet size negotiation on unicast links
Per Lidenb97bf3f2006-01-02 19:04:38 +010065 * (unless bearer MTU is less)
66 */
Per Lidenb97bf3f2006-01-02 19:04:38 +010067#define MAX_PKT_DEFAULT 1500
68
Paul Gortmaker7e9cab52012-07-11 09:40:43 -040069struct 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 */
Paul Gortmaker7e9cab52012-07-11 09:40:43 -040089 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
Per Lidenb97bf3f2006-01-02 19:04:38 +010099/**
Paul Gortmakera18c4bc2011-12-29 20:58:42 -0500100 * struct tipc_link - TIPC link data structure
Per Lidenb97bf3f2006-01-02 19:04:38 +0100101 * @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
Ying Xue135daee2014-02-13 17:29:08 -0500106 * @flags: execution state flags for link endpoint instance
Per Lidenb97bf3f2006-01-02 19:04:38 +0100107 * @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
Ying Xue7a2f7d12014-04-21 10:55:46 +0800110 * @bearer_id: local bearer id used by link
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900111 * @tolerance: minimum link continuity loss needed to reset link [in ms]
Ying Xue2f55c432015-01-09 15:27:00 +0800112 * @cont_intv: link continuity testing interval
Per Lidenb97bf3f2006-01-02 19:04:38 +0100113 * @abort_limit: # of unacknowledged continuity probes needed to reset link
114 * @state: current state of link FSM
Per Lidenb97bf3f2006-01-02 19:04:38 +0100115 * @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
Ying Xue7a2f7d12014-04-21 10:55:46 +0800119 * @net_plane: current link network plane ('A' through 'H')
Per Lidenb97bf3f2006-01-02 19:04:38 +0100120 * @queue_limit: outbound message queue congestion thresholds (indexed by user)
121 * @exp_msg_count: # of tunnelled messages expected during link changeover
122 * @reset_checkpoint: seq # of last acknowledged message at time of link reset
123 * @max_pkt: current maximum packet size for this link
124 * @max_pkt_target: desired maximum packet size for this link
125 * @max_pkt_probes: # of probes based on current (max_pkt, max_pkt_target)
Ying Xue58dc55f2014-11-26 11:41:52 +0800126 * @outqueue: outbound message queue
Per Lidenb97bf3f2006-01-02 19:04:38 +0100127 * @next_out_no: next sequence number to use for outbound messages
128 * @last_retransmitted: sequence number of most recently retransmitted message
129 * @stale_count: # of identical retransmit requests made by peer
130 * @next_in_no: next sequence number to expect for inbound messages
Ying Xuebc6fecd2014-11-26 11:41:53 +0800131 * @deferred_queue: deferred queue saved OOS b'cast message received from node
Per Lidenb97bf3f2006-01-02 19:04:38 +0100132 * @unacked_window: # of inbound messages rx'd without ack'ing back to peer
Per Lidenb97bf3f2006-01-02 19:04:38 +0100133 * @next_out: ptr to first unsent outbound message in queue
Jon Paul Maloy50100a52014-08-22 18:09:07 -0400134 * @waiting_sks: linked list of sockets waiting for link congestion to abate
Per Lidenb97bf3f2006-01-02 19:04:38 +0100135 * @long_msg_seq_no: next identifier to use for outbound fragmented messages
Jon Paul Maloy37e22162014-05-14 05:39:12 -0400136 * @reasm_buf: head of partially reassembled inbound message fragments
Per Lidenb97bf3f2006-01-02 19:04:38 +0100137 * @stats: collects statistics regarding link activity
Per Lidenb97bf3f2006-01-02 19:04:38 +0100138 */
Paul Gortmakera18c4bc2011-12-29 20:58:42 -0500139struct tipc_link {
Per Lidenb97bf3f2006-01-02 19:04:38 +0100140 u32 addr;
141 char name[TIPC_MAX_LINK_NAME];
142 struct tipc_media_addr media_addr;
143 struct timer_list timer;
David S. Miller6c000552008-09-02 23:38:32 -0700144 struct tipc_node *owner;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100145
146 /* Management and link supervision data */
Ying Xue135daee2014-02-13 17:29:08 -0500147 unsigned int flags;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100148 u32 checkpoint;
149 u32 peer_session;
150 u32 peer_bearer_id;
Ying Xue7a2f7d12014-04-21 10:55:46 +0800151 u32 bearer_id;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100152 u32 tolerance;
Ying Xue2f55c432015-01-09 15:27:00 +0800153 unsigned long cont_intv;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100154 u32 abort_limit;
155 int state;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100156 u32 fsm_msg_cnt;
157 struct {
158 unchar hdr[INT_H_SIZE];
159 unchar body[TIPC_MAX_IF_NAME];
160 } proto_msg;
161 struct tipc_msg *pmsg;
162 u32 priority;
Ying Xue7a2f7d12014-04-21 10:55:46 +0800163 char net_plane;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100164 u32 queue_limit[15]; /* queue_limit[0]==window limit */
165
166 /* Changeover */
167 u32 exp_msg_count;
168 u32 reset_checkpoint;
169
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900170 /* Max packet negotiation */
171 u32 max_pkt;
172 u32 max_pkt_target;
173 u32 max_pkt_probes;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100174
175 /* Sending */
Ying Xue58dc55f2014-11-26 11:41:52 +0800176 struct sk_buff_head outqueue;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100177 u32 next_out_no;
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900178 u32 last_retransmitted;
179 u32 stale_count;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100180
181 /* Reception */
182 u32 next_in_no;
Ying Xuebc6fecd2014-11-26 11:41:53 +0800183 struct sk_buff_head deferred_queue;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100184 u32 unacked_window;
185
186 /* Congestion handling */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100187 struct sk_buff *next_out;
Jon Paul Maloy50100a52014-08-22 18:09:07 -0400188 struct sk_buff_head waiting_sks;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100189
Erik Hugne40ba3cd2013-11-06 09:28:06 +0100190 /* Fragmentation/reassembly */
Per Lidenb97bf3f2006-01-02 19:04:38 +0100191 u32 long_msg_seq_no;
Jon Paul Maloy37e22162014-05-14 05:39:12 -0400192 struct sk_buff *reasm_buf;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100193
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +0900194 /* Statistics */
Paul Gortmaker7e9cab52012-07-11 09:40:43 -0400195 struct tipc_stats stats;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100196};
197
Allan Stephens23dd4cc2011-01-07 11:43:40 -0500198struct tipc_port;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100199
Paul Gortmakera18c4bc2011-12-29 20:58:42 -0500200struct tipc_link *tipc_link_create(struct tipc_node *n_ptr,
Allan Stephens37b9c082011-02-28 11:32:27 -0500201 struct tipc_bearer *b_ptr,
Per Liden4323add2006-01-18 00:38:21 +0100202 const struct tipc_media_addr *media_addr);
Ying Xuef2f98002015-01-09 15:27:05 +0800203void tipc_link_delete_list(struct net *net, unsigned int bearer_id,
204 bool shutting_down);
Jon Paul Maloy170b3922014-01-07 17:02:41 -0500205void tipc_link_failover_send_queue(struct tipc_link *l_ptr);
Ying Xue247f0f32014-02-18 16:06:46 +0800206void tipc_link_dup_queue_xmit(struct tipc_link *l_ptr, struct tipc_link *dest);
Paul Gortmakera18c4bc2011-12-29 20:58:42 -0500207void tipc_link_reset_fragments(struct tipc_link *l_ptr);
208int tipc_link_is_up(struct tipc_link *l_ptr);
209int tipc_link_is_active(struct tipc_link *l_ptr);
Jon Paul Maloy581465f2014-01-07 17:02:44 -0500210void tipc_link_purge_queues(struct tipc_link *l_ptr);
Ying Xuef2f98002015-01-09 15:27:05 +0800211struct sk_buff *tipc_link_cmd_config(struct net *net, const void *req_tlv_area,
212 int req_tlv_space, u16 cmd);
213struct sk_buff *tipc_link_cmd_show_stats(struct net *net,
214 const void *req_tlv_area,
Jon Paul Maloy170b3922014-01-07 17:02:41 -0500215 int req_tlv_space);
Ying Xuef2f98002015-01-09 15:27:05 +0800216struct sk_buff *tipc_link_cmd_reset_stats(struct net *net,
217 const void *req_tlv_area,
Jon Paul Maloy170b3922014-01-07 17:02:41 -0500218 int req_tlv_space);
Ying Xue3f5a12b2014-05-05 08:56:17 +0800219void tipc_link_reset_all(struct tipc_node *node);
Paul Gortmakera18c4bc2011-12-29 20:58:42 -0500220void tipc_link_reset(struct tipc_link *l_ptr);
Ying Xuef2f98002015-01-09 15:27:05 +0800221void tipc_link_reset_list(struct net *net, unsigned int bearer_id);
222int tipc_link_xmit_skb(struct net *net, struct sk_buff *skb, u32 dest,
223 u32 selector);
224int tipc_link_xmit(struct net *net, struct sk_buff_head *list, u32 dest,
225 u32 selector);
Ying Xue7f9f95d2015-01-09 15:27:06 +0800226int __tipc_link_xmit(struct net *net, struct tipc_link *link,
227 struct sk_buff_head *list);
Ying Xuef2f98002015-01-09 15:27:05 +0800228void tipc_link_bundle_rcv(struct net *net, struct sk_buff *buf);
Ying Xue247f0f32014-02-18 16:06:46 +0800229void tipc_link_proto_xmit(struct tipc_link *l_ptr, u32 msg_typ, int prob,
230 u32 gap, u32 tolerance, u32 priority, u32 acked_mtu);
Ying Xue47b4c9a2014-11-26 11:41:48 +0800231void tipc_link_push_packets(struct tipc_link *l_ptr);
Ying Xuebc6fecd2014-11-26 11:41:53 +0800232u32 tipc_link_defer_pkt(struct sk_buff_head *list, struct sk_buff *buf);
Paul Gortmakera18c4bc2011-12-29 20:58:42 -0500233void tipc_link_set_queue_limits(struct tipc_link *l_ptr, u32 window);
234void tipc_link_retransmit(struct tipc_link *l_ptr,
235 struct sk_buff *start, u32 retransmits);
Ying Xue58dc55f2014-11-26 11:41:52 +0800236struct sk_buff *tipc_skb_queue_next(const struct sk_buff_head *list,
237 const struct sk_buff *skb);
Per Lidenb97bf3f2006-01-02 19:04:38 +0100238
Richard Alpe7be57fc2014-11-20 10:29:12 +0100239int tipc_nl_link_dump(struct sk_buff *skb, struct netlink_callback *cb);
240int tipc_nl_link_get(struct sk_buff *skb, struct genl_info *info);
Richard Alpef96ce7a2014-11-20 10:29:13 +0100241int tipc_nl_link_set(struct sk_buff *skb, struct genl_info *info);
Richard Alpeae363422014-11-20 10:29:14 +0100242int tipc_nl_link_reset_stats(struct sk_buff *skb, struct genl_info *info);
Richard Alpe0655f6a2014-11-20 10:29:07 +0100243int tipc_nl_parse_link_prop(struct nlattr *prop, struct nlattr *props[]);
244
Per Lidenb97bf3f2006-01-02 19:04:38 +0100245/*
246 * Link sequence number manipulation routines (uses modulo 2**16 arithmetic)
247 */
Allan Stephensf9057302011-10-24 16:03:12 -0400248static inline u32 buf_seqno(struct sk_buff *buf)
249{
250 return msg_seqno(buf_msg(buf));
251}
252
Per Lidenb97bf3f2006-01-02 19:04:38 +0100253static inline u32 mod(u32 x)
254{
255 return x & 0xffffu;
256}
257
Per Lidenb97bf3f2006-01-02 19:04:38 +0100258static inline int less_eq(u32 left, u32 right)
259{
Eric Dumazeta02cec22010-09-22 20:43:57 +0000260 return mod(right - left) < 32768u;
Per Lidenb97bf3f2006-01-02 19:04:38 +0100261}
262
Ying Xue58dc55f2014-11-26 11:41:52 +0800263static inline int more(u32 left, u32 right)
264{
265 return !less_eq(left, right);
266}
267
Per Lidenb97bf3f2006-01-02 19:04:38 +0100268static inline int less(u32 left, u32 right)
269{
Eric Dumazeta02cec22010-09-22 20:43:57 +0000270 return less_eq(left, right) && (mod(right) != mod(left));
Per Lidenb97bf3f2006-01-02 19:04:38 +0100271}
272
273static inline u32 lesser(u32 left, u32 right)
274{
275 return less_eq(left, right) ? left : right;
276}
277
Allan Stephens01fee252010-05-11 14:30:11 +0000278
279/*
280 * Link status checking routines
281 */
Paul Gortmakera18c4bc2011-12-29 20:58:42 -0500282static inline int link_working_working(struct tipc_link *l_ptr)
Allan Stephens01fee252010-05-11 14:30:11 +0000283{
Eric Dumazeta02cec22010-09-22 20:43:57 +0000284 return l_ptr->state == WORKING_WORKING;
Allan Stephens01fee252010-05-11 14:30:11 +0000285}
286
Paul Gortmakera18c4bc2011-12-29 20:58:42 -0500287static inline int link_working_unknown(struct tipc_link *l_ptr)
Allan Stephens01fee252010-05-11 14:30:11 +0000288{
Eric Dumazeta02cec22010-09-22 20:43:57 +0000289 return l_ptr->state == WORKING_UNKNOWN;
Allan Stephens01fee252010-05-11 14:30:11 +0000290}
291
Paul Gortmakera18c4bc2011-12-29 20:58:42 -0500292static inline int link_reset_unknown(struct tipc_link *l_ptr)
Allan Stephens01fee252010-05-11 14:30:11 +0000293{
Eric Dumazeta02cec22010-09-22 20:43:57 +0000294 return l_ptr->state == RESET_UNKNOWN;
Allan Stephens01fee252010-05-11 14:30:11 +0000295}
296
Paul Gortmakera18c4bc2011-12-29 20:58:42 -0500297static inline int link_reset_reset(struct tipc_link *l_ptr)
Allan Stephens01fee252010-05-11 14:30:11 +0000298{
Eric Dumazeta02cec22010-09-22 20:43:57 +0000299 return l_ptr->state == RESET_RESET;
Allan Stephens01fee252010-05-11 14:30:11 +0000300}
301
Paul Gortmakera18c4bc2011-12-29 20:58:42 -0500302static inline int link_congested(struct tipc_link *l_ptr)
Allan Stephens01fee252010-05-11 14:30:11 +0000303{
Ying Xue58dc55f2014-11-26 11:41:52 +0800304 return skb_queue_len(&l_ptr->outqueue) >= l_ptr->queue_limit[0];
Allan Stephens01fee252010-05-11 14:30:11 +0000305}
306
Per Lidenb97bf3f2006-01-02 19:04:38 +0100307#endif