link.h 10.4 KB
Newer Older
Per Liden's avatar
Per Liden committed
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
Per Liden's avatar
Per Liden committed
6 7
 * All rights reserved.
 *
Per Liden's avatar
Per Liden committed
8
 * Redistribution and use in source and binary forms, with or without
Per Liden's avatar
Per Liden committed
9 10
 * modification, are permitted provided that the following conditions are met:
 *
Per Liden's avatar
Per Liden committed
11 12 13 14 15 16 17 18
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the names of the copyright holders nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
Per Liden's avatar
Per Liden committed
19
 *
Per Liden's avatar
Per Liden committed
20 21 22 23 24 25 26 27 28 29 30 31 32 33
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2 as published by the Free
 * Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
Per Liden's avatar
Per Liden committed
34 35 36 37 38 39
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _TIPC_LINK_H
#define _TIPC_LINK_H

40
#include <net/genetlink.h>
Per Liden's avatar
Per Liden committed
41 42 43
#include "msg.h"
#include "node.h"

44 45 46 47
/* TIPC-specific error codes
*/
#define ELINKCONG EAGAIN	/* link congestion <=> resource unavailable */

48
/* Out-of-range value for link sequence numbers
49 50 51
 */
#define INVALID_LINK_SEQ 0x10000

52
/* Link working states
Per Liden's avatar
Per Liden committed
53 54 55 56 57 58
 */
#define WORKING_WORKING 560810u
#define WORKING_UNKNOWN 560811u
#define RESET_UNKNOWN   560812u
#define RESET_RESET     560813u

59 60 61
/* Link endpoint execution states
 */
#define LINK_STARTED    0x0001
62
#define LINK_STOPPED    0x0002
63 64

/* Starting value for maximum packet size negotiation on unicast links
Per Liden's avatar
Per Liden committed
65 66 67 68
 * (unless bearer MTU is less)
 */
#define MAX_PKT_DEFAULT 1500

69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
struct tipc_stats {
	u32 sent_info;		/* used in counting # sent packets */
	u32 recv_info;		/* used in counting # recv'd packets */
	u32 sent_states;
	u32 recv_states;
	u32 sent_probes;
	u32 recv_probes;
	u32 sent_nacks;
	u32 recv_nacks;
	u32 sent_acks;
	u32 sent_bundled;
	u32 sent_bundles;
	u32 recv_bundled;
	u32 recv_bundles;
	u32 retransmitted;
	u32 sent_fragmented;
	u32 sent_fragments;
	u32 recv_fragmented;
	u32 recv_fragments;
	u32 link_congs;		/* # port sends blocked by congestion */
	u32 deferred_recv;
	u32 duplicates;
	u32 max_queue_sz;	/* send queue size high water mark */
	u32 accu_queue_sz;	/* used for send queue size profiling */
	u32 queue_sz_counts;	/* used for send queue size profiling */
	u32 msg_length_counts;	/* used for message length profiling */
	u32 msg_lengths_total;	/* used for message length profiling */
	u32 msg_length_profile[7]; /* used for msg. length profiling */
};

Per Liden's avatar
Per Liden committed
99
/**
100
 * struct tipc_link - TIPC link data structure
Per Liden's avatar
Per Liden committed
101 102 103 104 105
 * @addr: network address of link's peer node
 * @name: link name character string
 * @media_addr: media address to use when sending messages over link
 * @timer: link timer
 * @owner: pointer to peer node
106
 * @refcnt: reference counter for permanent references (owner node & timer)
107
 * @flags: execution state flags for link endpoint instance
Per Liden's avatar
Per Liden committed
108 109 110
 * @checkpoint: reference point for triggering link continuity checking
 * @peer_session: link session # being used by peer end of link
 * @peer_bearer_id: bearer id used by link's peer endpoint
111
 * @bearer_id: local bearer id used by link
112
 * @tolerance: minimum link continuity loss needed to reset link [in ms]
113
 * @cont_intv: link continuity testing interval
Per Liden's avatar
Per Liden committed
114 115 116 117 118 119
 * @abort_limit: # of unacknowledged continuity probes needed to reset link
 * @state: current state of link FSM
 * @fsm_msg_cnt: # of protocol messages link FSM has sent in current state
 * @proto_msg: template for control messages generated by link
 * @pmsg: convenience pointer to "proto_msg" field
 * @priority: current link priority
120
 * @net_plane: current link network plane ('A' through 'H')
Per Liden's avatar
Per Liden committed
121 122 123 124 125 126
 * @queue_limit: outbound message queue congestion thresholds (indexed by user)
 * @exp_msg_count: # of tunnelled messages expected during link changeover
 * @reset_checkpoint: seq # of last acknowledged message at time of link reset
 * @max_pkt: current maximum packet size for this link
 * @max_pkt_target: desired maximum packet size for this link
 * @max_pkt_probes: # of probes based on current (max_pkt, max_pkt_target)
127
 * @outqueue: outbound message queue
Per Liden's avatar
Per Liden committed
128 129 130 131
 * @next_out_no: next sequence number to use for outbound messages
 * @last_retransmitted: sequence number of most recently retransmitted message
 * @stale_count: # of identical retransmit requests made by peer
 * @next_in_no: next sequence number to expect for inbound messages
132
 * @deferred_queue: deferred queue saved OOS b'cast message received from node
Per Liden's avatar
Per Liden committed
133 134
 * @unacked_window: # of inbound messages rx'd without ack'ing back to peer
 * @next_out: ptr to first unsent outbound message in queue
135
 * @waiting_sks: linked list of sockets waiting for link congestion to abate
Per Liden's avatar
Per Liden committed
136
 * @long_msg_seq_no: next identifier to use for outbound fragmented messages
137
 * @reasm_buf: head of partially reassembled inbound message fragments
Per Liden's avatar
Per Liden committed
138 139
 * @stats: collects statistics regarding link activity
 */
140
struct tipc_link {
Per Liden's avatar
Per Liden committed
141 142 143 144
	u32 addr;
	char name[TIPC_MAX_LINK_NAME];
	struct tipc_media_addr media_addr;
	struct timer_list timer;
145
	struct tipc_node *owner;
146
	struct kref ref;
Per Liden's avatar
Per Liden committed
147 148

	/* Management and link supervision data */
149
	unsigned int flags;
Per Liden's avatar
Per Liden committed
150 151 152
	u32 checkpoint;
	u32 peer_session;
	u32 peer_bearer_id;
153
	u32 bearer_id;
Per Liden's avatar
Per Liden committed
154
	u32 tolerance;
155
	unsigned long cont_intv;
Per Liden's avatar
Per Liden committed
156 157 158 159 160 161 162 163 164
	u32 abort_limit;
	int state;
	u32 fsm_msg_cnt;
	struct {
		unchar hdr[INT_H_SIZE];
		unchar body[TIPC_MAX_IF_NAME];
	} proto_msg;
	struct tipc_msg *pmsg;
	u32 priority;
165
	char net_plane;
Per Liden's avatar
Per Liden committed
166 167 168 169 170 171
	u32 queue_limit[15];	/* queue_limit[0]==window limit */

	/* Changeover */
	u32 exp_msg_count;
	u32 reset_checkpoint;

172 173 174 175
	/* Max packet negotiation */
	u32 max_pkt;
	u32 max_pkt_target;
	u32 max_pkt_probes;
Per Liden's avatar
Per Liden committed
176 177

	/* Sending */
178
	struct sk_buff_head outqueue;
Per Liden's avatar
Per Liden committed
179
	u32 next_out_no;
180 181
	u32 last_retransmitted;
	u32 stale_count;
Per Liden's avatar
Per Liden committed
182 183 184

	/* Reception */
	u32 next_in_no;
185
	struct sk_buff_head deferred_queue;
Per Liden's avatar
Per Liden committed
186 187 188 189
	u32 unacked_window;

	/* Congestion handling */
	struct sk_buff *next_out;
190
	struct sk_buff_head waiting_sks;
Per Liden's avatar
Per Liden committed
191

192
	/* Fragmentation/reassembly */
Per Liden's avatar
Per Liden committed
193
	u32 long_msg_seq_no;
194
	struct sk_buff *reasm_buf;
Per Liden's avatar
Per Liden committed
195

196
	/* Statistics */
197
	struct tipc_stats stats;
Per Liden's avatar
Per Liden committed
198 199
};

200
struct tipc_port;
Per Liden's avatar
Per Liden committed
201

202
struct tipc_link *tipc_link_create(struct tipc_node *n_ptr,
203
			      struct tipc_bearer *b_ptr,
204
			      const struct tipc_media_addr *media_addr);
205 206
void tipc_link_delete_list(struct net *net, unsigned int bearer_id,
			   bool shutting_down);
207
void tipc_link_failover_send_queue(struct tipc_link *l_ptr);
208
void tipc_link_dup_queue_xmit(struct tipc_link *l_ptr, struct tipc_link *dest);
209 210 211
void tipc_link_reset_fragments(struct tipc_link *l_ptr);
int tipc_link_is_up(struct tipc_link *l_ptr);
int tipc_link_is_active(struct tipc_link *l_ptr);
212
void tipc_link_purge_queues(struct tipc_link *l_ptr);
213 214 215 216
struct sk_buff *tipc_link_cmd_config(struct net *net, const void *req_tlv_area,
				     int req_tlv_space, u16 cmd);
struct sk_buff *tipc_link_cmd_show_stats(struct net *net,
					 const void *req_tlv_area,
217
					 int req_tlv_space);
218 219
struct sk_buff *tipc_link_cmd_reset_stats(struct net *net,
					  const void *req_tlv_area,
220
					  int req_tlv_space);
221
void tipc_link_reset_all(struct tipc_node *node);
222
void tipc_link_reset(struct tipc_link *l_ptr);
223 224 225 226 227
void tipc_link_reset_list(struct net *net, unsigned int bearer_id);
int tipc_link_xmit_skb(struct net *net, struct sk_buff *skb, u32 dest,
		       u32 selector);
int tipc_link_xmit(struct net *net, struct sk_buff_head *list, u32 dest,
		   u32 selector);
228 229
int __tipc_link_xmit(struct net *net, struct tipc_link *link,
		     struct sk_buff_head *list);
230
void tipc_link_bundle_rcv(struct net *net, struct sk_buff *buf);
231 232
void tipc_link_proto_xmit(struct tipc_link *l_ptr, u32 msg_typ, int prob,
			  u32 gap, u32 tolerance, u32 priority, u32 acked_mtu);
233
void tipc_link_push_packets(struct tipc_link *l_ptr);
234
u32 tipc_link_defer_pkt(struct sk_buff_head *list, struct sk_buff *buf);
235 236 237
void tipc_link_set_queue_limits(struct tipc_link *l_ptr, u32 window);
void tipc_link_retransmit(struct tipc_link *l_ptr,
			  struct sk_buff *start, u32 retransmits);
238 239
struct sk_buff *tipc_skb_queue_next(const struct sk_buff_head *list,
				    const struct sk_buff *skb);
Per Liden's avatar
Per Liden committed
240

241 242
int tipc_nl_link_dump(struct sk_buff *skb, struct netlink_callback *cb);
int tipc_nl_link_get(struct sk_buff *skb, struct genl_info *info);
243
int tipc_nl_link_set(struct sk_buff *skb, struct genl_info *info);
244
int tipc_nl_link_reset_stats(struct sk_buff *skb, struct genl_info *info);
245 246
int tipc_nl_parse_link_prop(struct nlattr *prop, struct nlattr *props[]);

Per Liden's avatar
Per Liden committed
247 248 249
/*
 * Link sequence number manipulation routines (uses modulo 2**16 arithmetic)
 */
250 251 252 253 254
static inline u32 buf_seqno(struct sk_buff *buf)
{
	return msg_seqno(buf_msg(buf));
}

Per Liden's avatar
Per Liden committed
255 256 257 258 259 260 261
static inline u32 mod(u32 x)
{
	return x & 0xffffu;
}

static inline int less_eq(u32 left, u32 right)
{
Eric Dumazet's avatar
Eric Dumazet committed
262
	return mod(right - left) < 32768u;
Per Liden's avatar
Per Liden committed
263 264
}

265 266 267 268 269
static inline int more(u32 left, u32 right)
{
	return !less_eq(left, right);
}

Per Liden's avatar
Per Liden committed
270 271
static inline int less(u32 left, u32 right)
{
Eric Dumazet's avatar
Eric Dumazet committed
272
	return less_eq(left, right) && (mod(right) != mod(left));
Per Liden's avatar
Per Liden committed
273 274 275 276 277 278 279
}

static inline u32 lesser(u32 left, u32 right)
{
	return less_eq(left, right) ? left : right;
}

280 281 282 283

/*
 * Link status checking routines
 */
284
static inline int link_working_working(struct tipc_link *l_ptr)
285
{
Eric Dumazet's avatar
Eric Dumazet committed
286
	return l_ptr->state == WORKING_WORKING;
287 288
}

289
static inline int link_working_unknown(struct tipc_link *l_ptr)
290
{
Eric Dumazet's avatar
Eric Dumazet committed
291
	return l_ptr->state == WORKING_UNKNOWN;
292 293
}

294
static inline int link_reset_unknown(struct tipc_link *l_ptr)
295
{
Eric Dumazet's avatar
Eric Dumazet committed
296
	return l_ptr->state == RESET_UNKNOWN;
297 298
}

299
static inline int link_reset_reset(struct tipc_link *l_ptr)
300
{
Eric Dumazet's avatar
Eric Dumazet committed
301
	return l_ptr->state == RESET_RESET;
302 303
}

304
static inline int link_congested(struct tipc_link *l_ptr)
305
{
306
	return skb_queue_len(&l_ptr->outqueue) >= l_ptr->queue_limit[0];
307 308
}

Per Liden's avatar
Per Liden committed
309
#endif