link.h 10.2 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 FSM events:
53
 */
54
enum {
55
56
57
58
59
60
61
62
	LINK_ESTABLISH_EVT       = 0xec1ab1e,
	LINK_PEER_RESET_EVT      = 0x9eed0e,
	LINK_FAILURE_EVT         = 0xfa110e,
	LINK_RESET_EVT           = 0x10ca1d0e,
	LINK_FAILOVER_BEGIN_EVT  = 0xfa110bee,
	LINK_FAILOVER_END_EVT    = 0xfa110ede,
	LINK_SYNCH_BEGIN_EVT     = 0xc1ccbee,
	LINK_SYNCH_END_EVT       = 0xc1ccede
63
};
64

65
/* Events returned from link at packet reception or at timeout
66
67
68
69
70
71
 */
enum {
	TIPC_LINK_UP_EVT       = 1,
	TIPC_LINK_DOWN_EVT     = (1 << 1)
};

72
/* Starting value for maximum packet size negotiation on unicast links
Per Liden's avatar
Per Liden committed
73
74
75
76
 * (unless bearer MTU is less)
 */
#define MAX_PKT_DEFAULT 1500

77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
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
107
/**
108
 * struct tipc_link - TIPC link data structure
Per Liden's avatar
Per Liden committed
109
110
111
112
113
 * @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
114
 * @refcnt: reference counter for permanent references (owner node & timer)
Per Liden's avatar
Per Liden committed
115
116
 * @peer_session: link session # being used by peer end of link
 * @peer_bearer_id: bearer id used by link's peer endpoint
117
 * @bearer_id: local bearer id used by link
118
 * @tolerance: minimum link continuity loss needed to reset link [in ms]
119
 * @keepalive_intv: link keepalive timer interval
Per Liden's avatar
Per Liden committed
120
121
 * @abort_limit: # of unacknowledged continuity probes needed to reset link
 * @state: current state of link FSM
122
 * @peer_caps: bitmap describing capabilities of peer node
123
 * @silent_intv_cnt: # of timer intervals without any reception from peer
Per Liden's avatar
Per Liden committed
124
125
126
 * @proto_msg: template for control messages generated by link
 * @pmsg: convenience pointer to "proto_msg" field
 * @priority: current link priority
127
 * @net_plane: current link network plane ('A' through 'H')
128
 * @backlog_limit: backlog queue congestion thresholds (indexed by importance)
Per Liden's avatar
Per Liden committed
129
 * @exp_msg_count: # of tunnelled messages expected during link changeover
130
 * @reset_rcv_checkpt: seq # of last acknowledged message at time of link reset
131
132
 * @mtu: current maximum packet size for this link
 * @advertised_mtu: advertised own mtu when link is being established
Jon Paul Maloy's avatar
Jon Paul Maloy committed
133
134
 * @transmitq: queue for sent, non-acked messages
 * @backlogq: queue for messages waiting to be sent
135
 * @snt_nxt: next sequence number to use for outbound messages
Per Liden's avatar
Per Liden committed
136
137
 * @last_retransmitted: sequence number of most recently retransmitted message
 * @stale_count: # of identical retransmit requests made by peer
138
139
 * @ackers: # of peers that needs to ack each packet before it can be released
 * @acked: # last packet acked by a certain peer. Used for broadcast.
140
 * @rcv_nxt: next sequence number to expect for inbound messages
141
 * @deferred_queue: deferred queue saved OOS b'cast message received from node
Per Liden's avatar
Per Liden committed
142
 * @unacked_window: # of inbound messages rx'd without ack'ing back to peer
143
144
 * @inputq: buffer queue for messages to be delivered upwards
 * @namedq: buffer queue for name table messages to be delivered upwards
Per Liden's avatar
Per Liden committed
145
 * @next_out: ptr to first unsent outbound message in queue
146
 * @wakeupq: linked list of wakeup msgs waiting for link congestion to abate
Per Liden's avatar
Per Liden committed
147
 * @long_msg_seq_no: next identifier to use for outbound fragmented messages
148
 * @reasm_buf: head of partially reassembled inbound message fragments
149
 * @bc_rcvr: marks that this is a broadcast receiver link
Per Liden's avatar
Per Liden committed
150
151
 * @stats: collects statistics regarding link activity
 */
152
struct tipc_link {
Per Liden's avatar
Per Liden committed
153
154
	u32 addr;
	char name[TIPC_MAX_LINK_NAME];
Jon Paul Maloy's avatar
Jon Paul Maloy committed
155
	struct tipc_media_addr *media_addr;
156
	struct tipc_node *owner;
Per Liden's avatar
Per Liden committed
157
158
159
160

	/* Management and link supervision data */
	u32 peer_session;
	u32 peer_bearer_id;
161
	u32 bearer_id;
Per Liden's avatar
Per Liden committed
162
	u32 tolerance;
163
	unsigned long keepalive_intv;
Per Liden's avatar
Per Liden committed
164
	u32 abort_limit;
165
	u32 state;
166
	u16 peer_caps;
167
	u32 silent_intv_cnt;
Per Liden's avatar
Per Liden committed
168
169
170
171
172
173
	struct {
		unchar hdr[INT_H_SIZE];
		unchar body[TIPC_MAX_IF_NAME];
	} proto_msg;
	struct tipc_msg *pmsg;
	u32 priority;
174
	char net_plane;
Per Liden's avatar
Per Liden committed
175

176
177
178
	/* Failover/synch */
	u16 drop_point;
	struct sk_buff *failover_reasm_skb;
Per Liden's avatar
Per Liden committed
179

180
	/* Max packet negotiation */
181
182
	u16 mtu;
	u16 advertised_mtu;
Per Liden's avatar
Per Liden committed
183
184

	/* Sending */
Jon Paul Maloy's avatar
Jon Paul Maloy committed
185
186
	struct sk_buff_head transmq;
	struct sk_buff_head backlogq;
187
188
189
190
	struct {
		u16 len;
		u16 limit;
	} backlog[5];
191
192
	u16 snd_nxt;
	u16 last_retransm;
193
	u16 window;
194
	u32 stale_count;
Per Liden's avatar
Per Liden committed
195
196

	/* Reception */
197
	u16 rcv_nxt;
Jon Paul Maloy's avatar
Jon Paul Maloy committed
198
199
	u32 rcv_unacked;
	struct sk_buff_head deferdq;
200
201
	struct sk_buff_head *inputq;
	struct sk_buff_head *namedq;
Per Liden's avatar
Per Liden committed
202
203

	/* Congestion handling */
204
	struct sk_buff_head wakeupq;
Per Liden's avatar
Per Liden committed
205

206
	/* Fragmentation/reassembly */
207
	struct sk_buff *reasm_buf;
Per Liden's avatar
Per Liden committed
208

209
210
211
212
	/* Broadcast */
	u16 ackers;
	u16 acked;

213
	/* Statistics */
214
	struct tipc_stats stats;
Per Liden's avatar
Per Liden committed
215
216
};

217
218
219
bool tipc_link_create(struct tipc_node *n, char *if_name, int bearer_id,
		      int tolerance, char net_plane, u32 mtu, int priority,
		      int window, u32 session, u32 ownnode, u32 peer,
220
		      u16 peer_caps, struct tipc_media_addr *maddr,
Jon Paul Maloy's avatar
Jon Paul Maloy committed
221
222
		      struct sk_buff_head *inputq, struct sk_buff_head *namedq,
		      struct tipc_link **link);
223
bool tipc_link_bc_create(struct tipc_node *n, int mtu, int window,
224
			 u16 peer_caps, struct sk_buff_head *inputq,
225
226
			 struct sk_buff_head *namedq,
			 struct tipc_link **link);
227
228
void tipc_link_tnl_prepare(struct tipc_link *l, struct tipc_link *tnl,
			   int mtyp, struct sk_buff_head *xmitq);
229
230
void tipc_link_build_bcast_sync_msg(struct tipc_link *l,
				    struct sk_buff_head *xmitq);
231
void tipc_link_build_reset_msg(struct tipc_link *l, struct sk_buff_head *xmitq);
232
int tipc_link_fsm_evt(struct tipc_link *l, int evt);
233
void tipc_link_reset_fragments(struct tipc_link *l_ptr);
234
bool tipc_link_is_up(struct tipc_link *l);
235
bool tipc_link_peer_is_down(struct tipc_link *l);
236
bool tipc_link_is_reset(struct tipc_link *l);
237
bool tipc_link_is_establishing(struct tipc_link *l);
238
239
240
bool tipc_link_is_synching(struct tipc_link *l);
bool tipc_link_is_failingover(struct tipc_link *l);
bool tipc_link_is_blocked(struct tipc_link *l);
241
int tipc_link_is_active(struct tipc_link *l_ptr);
242
void tipc_link_purge_queues(struct tipc_link *l_ptr);
243
void tipc_link_purge_backlog(struct tipc_link *l);
244
void tipc_link_reset(struct tipc_link *l_ptr);
245
246
int __tipc_link_xmit(struct net *net, struct tipc_link *link,
		     struct sk_buff_head *list);
247
248
int tipc_link_xmit(struct tipc_link *link,	struct sk_buff_head *list,
		   struct sk_buff_head *xmitq);
249
void tipc_link_proto_xmit(struct tipc_link *l_ptr, u32 msg_typ, int prob,
250
			  u32 gap, u32 tolerance, u32 priority);
251
void tipc_link_push_packets(struct tipc_link *l_ptr);
252
u32 tipc_link_defer_pkt(struct sk_buff_head *list, struct sk_buff *buf);
253
254
255
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);
256
257
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
258

259
260
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);
261
int tipc_nl_link_set(struct sk_buff *skb, struct genl_info *info);
262
int tipc_nl_link_reset_stats(struct sk_buff *skb, struct genl_info *info);
263
int tipc_nl_parse_link_prop(struct nlattr *prop, struct nlattr *props[]);
264
int tipc_link_timeout(struct tipc_link *l, struct sk_buff_head *xmitq);
265
266
int tipc_link_rcv(struct tipc_link *l, struct sk_buff *skb,
		  struct sk_buff_head *xmitq);
267
268
269
270
void tipc_link_build_ack_msg(struct tipc_link *l, struct sk_buff_head *xmitq);
void tipc_link_add_bc_peer(struct tipc_link *l);
void tipc_link_remove_bc_peer(struct tipc_link *l);
int tipc_link_bc_peers(struct tipc_link *l);
271

Per Liden's avatar
Per Liden committed
272
#endif