blob: 597f8e27aaf6dfccffa354ae4219c164a1bd078e [file] [log] [blame]
Vlad Yasevich60c778b2008-01-11 09:57:09 -05001/* SCTP kernel implementation
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 * (C) Copyright IBM Corp. 2001, 2004
3 * Copyright (c) 1999-2000 Cisco, Inc.
4 * Copyright (c) 1999-2001 Motorola, Inc.
5 * Copyright (c) 2001 Intel Corp.
6 *
Vlad Yasevich60c778b2008-01-11 09:57:09 -05007 * This file is part of the SCTP kernel implementation
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 *
Vlad Yasevich60c778b2008-01-11 09:57:09 -05009 * This SCTP implementation is free software;
Linus Torvalds1da177e2005-04-16 15:20:36 -070010 * you can redistribute it and/or modify it under the terms of
11 * the GNU General Public License as published by
12 * the Free Software Foundation; either version 2, or (at your option)
13 * any later version.
14 *
Vlad Yasevich60c778b2008-01-11 09:57:09 -050015 * This SCTP implementation is distributed in the hope that it
Linus Torvalds1da177e2005-04-16 15:20:36 -070016 * will be useful, but WITHOUT ANY WARRANTY; without even the implied
17 * ************************
18 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
19 * See the GNU General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with GNU CC; see the file COPYING. If not, write to
23 * the Free Software Foundation, 59 Temple Place - Suite 330,
24 * Boston, MA 02111-1307, USA.
25 *
26 * Please send any bug reports or fixes you make to the
27 * email addresses:
28 * lksctp developers <lksctp-developers@lists.sourceforge.net>
29 *
30 * Or submit a bug report through the following website:
31 * http://www.sf.net/projects/lksctp
32 *
33 * Written or modified by:
34 * Randall Stewart <randall@sctp.chicago.il.us>
35 * Ken Morneau <kmorneau@cisco.com>
36 * Qiaobing Xie <qxie1@email.mot.com>
37 * La Monte H.P. Yarroll <piggy@acm.org>
38 * Karl Knutson <karl@athena.chicago.il.us>
39 * Jon Grimm <jgrimm@us.ibm.com>
40 * Xingang Guo <xingang.guo@intel.com>
41 * Hui Huang <hui.huang@nokia.com>
42 * Sridhar Samudrala <sri@us.ibm.com>
43 * Daisy Chang <daisyc@us.ibm.com>
44 * Dajiang Zhang <dajiang.zhang@nokia.com>
45 * Ardelle Fan <ardelle.fan@intel.com>
46 * Ryan Layer <rmlayer@us.ibm.com>
47 * Anup Pemmaiah <pemmaiah@cc.usu.edu>
48 * Kevin Gao <kevin.gao@intel.com>
49 *
50 * Any bugs reported given to us we will try to fix... any fixes shared will
51 * be incorporated into the next SCTP release.
52 */
53
54#ifndef __sctp_structs_h__
55#define __sctp_structs_h__
56
57#include <linux/time.h> /* We get struct timespec. */
58#include <linux/socket.h> /* linux/in.h needs this!! */
59#include <linux/in.h> /* We get struct sockaddr_in. */
60#include <linux/in6.h> /* We get struct in6_addr */
61#include <linux/ipv6.h>
62#include <asm/param.h> /* We get MAXHOSTNAMELEN. */
63#include <asm/atomic.h> /* This gets us atomic counters. */
64#include <linux/skbuff.h> /* We need sk_buff_head. */
65#include <linux/workqueue.h> /* We need tq_struct. */
66#include <linux/sctp.h> /* We need sctp* header structs. */
Vlad Yasevich1f485642007-10-09 01:15:59 -070067#include <net/sctp/auth.h> /* We need auth specific structs */
Linus Torvalds1da177e2005-04-16 15:20:36 -070068
69/* A convenience structure for handling sockaddr structures.
70 * We should wean ourselves off this.
71 */
72union sctp_addr {
73 struct sockaddr_in v4;
74 struct sockaddr_in6 v6;
75 struct sockaddr sa;
76};
77
78/* Forward declarations for data structures. */
79struct sctp_globals;
80struct sctp_endpoint;
81struct sctp_association;
82struct sctp_transport;
83struct sctp_packet;
84struct sctp_chunk;
85struct sctp_inq;
86struct sctp_outq;
87struct sctp_bind_addr;
88struct sctp_ulpq;
89struct sctp_ep_common;
90struct sctp_ssnmap;
Herbert Xu1b489e12006-08-20 15:07:14 +100091struct crypto_hash;
Linus Torvalds1da177e2005-04-16 15:20:36 -070092
93
94#include <net/sctp/tsnmap.h>
95#include <net/sctp/ulpevent.h>
96#include <net/sctp/ulpqueue.h>
97
98/* Structures useful for managing bind/connect. */
99
100struct sctp_bind_bucket {
101 unsigned short port;
102 unsigned short fastreuse;
Vlad Yasevichd970dbf2007-11-09 11:43:40 -0500103 struct hlist_node node;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 struct hlist_head owner;
105};
106
107struct sctp_bind_hashbucket {
108 spinlock_t lock;
Vlad Yasevichd970dbf2007-11-09 11:43:40 -0500109 struct hlist_head chain;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110};
111
112/* Used for hashing all associations. */
113struct sctp_hashbucket {
114 rwlock_t lock;
Vlad Yasevichd970dbf2007-11-09 11:43:40 -0500115 struct hlist_head chain;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116} __attribute__((__aligned__(8)));
117
118
119/* The SCTP globals structure. */
120extern struct sctp_globals {
121 /* RFC2960 Section 14. Suggested SCTP Protocol Parameter Values
122 *
123 * The following protocol parameters are RECOMMENDED:
124 *
125 * RTO.Initial - 3 seconds
126 * RTO.Min - 1 second
127 * RTO.Max - 60 seconds
128 * RTO.Alpha - 1/8 (3 when converted to right shifts.)
129 * RTO.Beta - 1/4 (2 when converted to right shifts.)
130 */
Vladislav Yasevich3fd091e2006-08-22 13:29:17 -0700131 unsigned int rto_initial;
132 unsigned int rto_min;
133 unsigned int rto_max;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134
135 /* Note: rto_alpha and rto_beta are really defined as inverse
136 * powers of two to facilitate integer operations.
137 */
138 int rto_alpha;
139 int rto_beta;
140
141 /* Max.Burst - 4 */
142 int max_burst;
143
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144 /* Whether Cookie Preservative is enabled(1) or not(0) */
145 int cookie_preserve_enable;
146
Vlad Yasevich8116ffa2006-01-17 11:55:17 -0800147 /* Valid.Cookie.Life - 60 seconds */
Vladislav Yasevich3fd091e2006-08-22 13:29:17 -0700148 unsigned int valid_cookie_life;
Vlad Yasevich8116ffa2006-01-17 11:55:17 -0800149
150 /* Delayed SACK timeout 200ms default*/
Vladislav Yasevich3fd091e2006-08-22 13:29:17 -0700151 unsigned int sack_timeout;
Vlad Yasevich8116ffa2006-01-17 11:55:17 -0800152
153 /* HB.interval - 30 seconds */
Vladislav Yasevich3fd091e2006-08-22 13:29:17 -0700154 unsigned int hb_interval;
Vlad Yasevich8116ffa2006-01-17 11:55:17 -0800155
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 /* Association.Max.Retrans - 10 attempts
157 * Path.Max.Retrans - 5 attempts (per destination address)
158 * Max.Init.Retransmits - 8 attempts
159 */
160 int max_retrans_association;
161 int max_retrans_path;
162 int max_retrans_init;
163
Neil Horman4eb701d2005-04-28 12:02:04 -0700164 /*
165 * Policy for preforming sctp/socket accounting
166 * 0 - do socket level accounting, all assocs share sk_sndbuf
167 * 1 - do sctp accounting, each asoc may use sk_sndbuf bytes
168 */
169 int sndbuf_policy;
170
Neil Horman049b3ff2005-11-11 16:08:24 -0800171 /*
172 * Policy for preforming sctp/socket accounting
173 * 0 - do socket level accounting, all assocs share sk_rcvbuf
174 * 1 - do sctp accounting, each asoc may use sk_rcvbuf bytes
175 */
176 int rcvbuf_policy;
177
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 /* The following variables are implementation specific. */
179
180 /* Default initialization values to be applied to new associations. */
181 __u16 max_instreams;
182 __u16 max_outstreams;
183
184 /* This is a list of groups of functions for each address
185 * family that we support.
186 */
187 struct list_head address_families;
188
189 /* This is the hash of all endpoints. */
190 int ep_hashsize;
191 struct sctp_hashbucket *ep_hashtable;
192
193 /* This is the hash of all associations. */
194 int assoc_hashsize;
195 struct sctp_hashbucket *assoc_hashtable;
196
197 /* This is the sctp port control hash. */
198 int port_hashsize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 struct sctp_bind_hashbucket *port_hashtable;
200
201 /* This is the global local address list.
Sridhar Samudrala29c7cf92006-12-13 16:26:26 -0800202 * We actively maintain this complete list of addresses on
203 * the system by catching address add/delete events.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204 *
205 * It is a list of sctp_sockaddr_entry.
206 */
207 struct list_head local_addr_list;
Vlad Yasevich29303542007-09-16 16:02:12 -0700208
209 /* Lock that protects the local_addr_list writers */
210 spinlock_t addr_list_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211
212 /* Flag to indicate if addip is enabled. */
213 int addip_enable;
Vlad Yasevich73d9c4f2007-10-24 17:24:26 -0400214 int addip_noauth_enable;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215
216 /* Flag to indicate if PR-SCTP is enabled. */
217 int prsctp_enable;
Vlad Yasevich1f485642007-10-09 01:15:59 -0700218
219 /* Flag to idicate if SCTP-AUTH is enabled */
220 int auth_enable;
Lucas Nussbaum06e86802009-02-13 08:33:41 +0000221
Bhaskar Dutta72388432009-09-03 17:25:47 +0530222 /*
223 * Policy to control SCTP IPv4 address scoping
224 * 0 - Disable IPv4 address scoping
225 * 1 - Enable IPv4 address scoping
226 * 2 - Selectively allow only IPv4 private addresses
227 * 3 - Selectively allow only IPv4 link local address
228 */
229 int ipv4_scope_policy;
230
Lucas Nussbaum06e86802009-02-13 08:33:41 +0000231 /* Flag to indicate whether computing and verifying checksum
232 * is disabled. */
233 int checksum_disable;
Vlad Yasevich90f2f532009-11-23 15:53:57 -0500234
235 /* Threshold for rwnd update SACKS. Receive buffer shifted this many
236 * bits is an indicator of when to send and window update SACK.
237 */
238 int rwnd_update_shift;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239} sctp_globals;
240
241#define sctp_rto_initial (sctp_globals.rto_initial)
242#define sctp_rto_min (sctp_globals.rto_min)
243#define sctp_rto_max (sctp_globals.rto_max)
244#define sctp_rto_alpha (sctp_globals.rto_alpha)
245#define sctp_rto_beta (sctp_globals.rto_beta)
246#define sctp_max_burst (sctp_globals.max_burst)
247#define sctp_valid_cookie_life (sctp_globals.valid_cookie_life)
248#define sctp_cookie_preserve_enable (sctp_globals.cookie_preserve_enable)
249#define sctp_max_retrans_association (sctp_globals.max_retrans_association)
Neil Horman4eb701d2005-04-28 12:02:04 -0700250#define sctp_sndbuf_policy (sctp_globals.sndbuf_policy)
Neil Horman049b3ff2005-11-11 16:08:24 -0800251#define sctp_rcvbuf_policy (sctp_globals.rcvbuf_policy)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252#define sctp_max_retrans_path (sctp_globals.max_retrans_path)
253#define sctp_max_retrans_init (sctp_globals.max_retrans_init)
Vlad Yasevich2f85a422005-06-28 13:24:23 -0700254#define sctp_sack_timeout (sctp_globals.sack_timeout)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255#define sctp_hb_interval (sctp_globals.hb_interval)
256#define sctp_max_instreams (sctp_globals.max_instreams)
257#define sctp_max_outstreams (sctp_globals.max_outstreams)
258#define sctp_address_families (sctp_globals.address_families)
259#define sctp_ep_hashsize (sctp_globals.ep_hashsize)
260#define sctp_ep_hashtable (sctp_globals.ep_hashtable)
261#define sctp_assoc_hashsize (sctp_globals.assoc_hashsize)
262#define sctp_assoc_hashtable (sctp_globals.assoc_hashtable)
263#define sctp_port_hashsize (sctp_globals.port_hashsize)
264#define sctp_port_rover (sctp_globals.port_rover)
265#define sctp_port_alloc_lock (sctp_globals.port_alloc_lock)
266#define sctp_port_hashtable (sctp_globals.port_hashtable)
267#define sctp_local_addr_list (sctp_globals.local_addr_list)
Vlad Yasevich29303542007-09-16 16:02:12 -0700268#define sctp_local_addr_lock (sctp_globals.addr_list_lock)
Bhaskar Dutta72388432009-09-03 17:25:47 +0530269#define sctp_scope_policy (sctp_globals.ipv4_scope_policy)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270#define sctp_addip_enable (sctp_globals.addip_enable)
Vlad Yasevich73d9c4f2007-10-24 17:24:26 -0400271#define sctp_addip_noauth (sctp_globals.addip_noauth_enable)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272#define sctp_prsctp_enable (sctp_globals.prsctp_enable)
Vlad Yasevich1f485642007-10-09 01:15:59 -0700273#define sctp_auth_enable (sctp_globals.auth_enable)
Lucas Nussbaum06e86802009-02-13 08:33:41 +0000274#define sctp_checksum_disable (sctp_globals.checksum_disable)
Vlad Yasevich90f2f532009-11-23 15:53:57 -0500275#define sctp_rwnd_upd_shift (sctp_globals.rwnd_update_shift)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276
277/* SCTP Socket type: UDP or TCP style. */
278typedef enum {
279 SCTP_SOCKET_UDP = 0,
280 SCTP_SOCKET_UDP_HIGH_BANDWIDTH,
281 SCTP_SOCKET_TCP
282} sctp_socket_type_t;
283
284/* Per socket SCTP information. */
285struct sctp_sock {
286 /* inet_sock has to be the first member of sctp_sock */
287 struct inet_sock inet;
288 /* What kind of a socket is this? */
289 sctp_socket_type_t type;
290
291 /* PF_ family specific functions. */
292 struct sctp_pf *pf;
293
294 /* Access to HMAC transform. */
Herbert Xu1b489e12006-08-20 15:07:14 +1000295 struct crypto_hash *hmac;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296
297 /* What is our base endpointer? */
298 struct sctp_endpoint *ep;
299
300 struct sctp_bind_bucket *bind_hash;
301 /* Various Socket Options. */
302 __u16 default_stream;
303 __u32 default_ppid;
304 __u16 default_flags;
305 __u32 default_context;
306 __u32 default_timetolive;
Ivan Skytte Jorgensen6ab792f2006-12-13 16:34:22 -0800307 __u32 default_rcv_context;
Vlad Yasevich70331572007-03-23 11:34:36 -0700308 int max_burst;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309
Frank Filz52ccb8e2005-12-22 11:36:46 -0800310 /* Heartbeat interval: The endpoint sends out a Heartbeat chunk to
311 * the destination address every heartbeat interval. This value
312 * will be inherited by all new associations.
313 */
314 __u32 hbinterval;
315
316 /* This is the max_retrans value for new associations. */
317 __u16 pathmaxrxt;
318
319 /* The initial Path MTU to use for new associations. */
320 __u32 pathmtu;
321
322 /* The default SACK delay timeout for new associations. */
323 __u32 sackdelay;
Wei Yongjund364d922008-05-09 15:13:26 -0700324 __u32 sackfreq;
Frank Filz52ccb8e2005-12-22 11:36:46 -0800325
Joe Perchesf4ab2f722007-12-20 13:56:32 -0800326 /* Flags controlling Heartbeat, SACK delay, and Path MTU Discovery. */
Frank Filz52ccb8e2005-12-22 11:36:46 -0800327 __u32 param_flags;
328
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 struct sctp_initmsg initmsg;
330 struct sctp_rtoinfo rtoinfo;
331 struct sctp_paddrparams paddrparam;
332 struct sctp_event_subscribe subscribe;
333 struct sctp_assocparams assocparams;
334 int user_frag;
335 __u32 autoclose;
336 __u8 nodelay;
337 __u8 disable_fragments;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338 __u8 v4mapped;
Vlad Yasevichb6e13312007-04-20 12:23:15 -0700339 __u8 frag_interleave;
Ivan Skytte Jorgensen0f3fffd2006-12-20 16:07:04 -0800340 __u32 adaptation_ind;
Vlad Yasevichd49d91d2007-03-23 11:32:00 -0700341 __u32 pd_point;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342
Vlad Yasevichb6e13312007-04-20 12:23:15 -0700343 atomic_t pd_mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 /* Receive to here while partial delivery is in effect. */
345 struct sk_buff_head pd_lobby;
346};
347
348static inline struct sctp_sock *sctp_sk(const struct sock *sk)
349{
350 return (struct sctp_sock *)sk;
351}
352
353static inline struct sock *sctp_opt2sk(const struct sctp_sock *sp)
354{
355 return (struct sock *)sp;
356}
357
358#if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
359struct sctp6_sock {
360 struct sctp_sock sctp;
361 struct ipv6_pinfo inet6;
362};
363#endif /* CONFIG_IPV6 */
364
365
366/* This is our APPLICATION-SPECIFIC state cookie.
367 * THIS IS NOT DICTATED BY THE SPECIFICATION.
368 */
369/* These are the parts of an association which we send in the cookie.
370 * Most of these are straight out of:
371 * RFC2960 12.2 Parameters necessary per association (i.e. the TCB)
372 *
373 */
374
375struct sctp_cookie {
376
377 /* My : Tag expected in every inbound packet and sent
378 * Verification: in the INIT or INIT ACK chunk.
379 * Tag :
380 */
381 __u32 my_vtag;
382
383 /* Peer's : Tag expected in every outbound packet except
384 * Verification: in the INIT chunk.
385 * Tag :
386 */
387 __u32 peer_vtag;
388
389 /* The rest of these are not from the spec, but really need to
390 * be in the cookie.
391 */
392
393 /* My Tie Tag : Assist in discovering a restarting association. */
394 __u32 my_ttag;
395
396 /* Peer's Tie Tag: Assist in discovering a restarting association. */
397 __u32 peer_ttag;
398
399 /* When does this cookie expire? */
400 struct timeval expiration;
401
402 /* Number of inbound/outbound streams which are set
403 * and negotiated during the INIT process.
404 */
405 __u16 sinit_num_ostreams;
406 __u16 sinit_max_instreams;
407
408 /* This is the first sequence number I used. */
409 __u32 initial_tsn;
410
411 /* This holds the originating address of the INIT packet. */
412 union sctp_addr peer_addr;
413
414 /* IG Section 2.35.3
415 * Include the source port of the INIT-ACK
416 */
417 __u16 my_port;
418
419 __u8 prsctp_capable;
420
421 /* Padding for future use */
422 __u8 padding;
423
Ivan Skytte Jorgensen0f3fffd2006-12-20 16:07:04 -0800424 __u32 adaptation_ind;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425
Vlad Yasevich1f485642007-10-09 01:15:59 -0700426 __u8 auth_random[sizeof(sctp_paramhdr_t) + SCTP_AUTH_RANDOM_LENGTH];
427 __u8 auth_hmacs[SCTP_AUTH_NUM_HMACS + 2];
428 __u8 auth_chunks[sizeof(sctp_paramhdr_t) + SCTP_AUTH_MAX_CHUNKS];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429
430 /* This is a shim for my peer's INIT packet, followed by
431 * a copy of the raw address list of the association.
432 * The length of the raw address list is saved in the
433 * raw_addr_list_len field, which will be used at the time when
434 * the association TCB is re-constructed from the cookie.
435 */
436 __u32 raw_addr_list_len;
437 struct sctp_init_chunk peer_init[0];
438};
439
440
441/* The format of our cookie that we send to our peer. */
442struct sctp_signed_cookie {
443 __u8 signature[SCTP_SECRET_SIZE];
Vlad Yasevich9834a2b2006-01-17 11:52:12 -0800444 __u32 __pad; /* force sctp_cookie alignment to 64 bits */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 struct sctp_cookie c;
Vlad Yasevich9834a2b2006-01-17 11:52:12 -0800446} __attribute__((packed));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447
448/* This is another convenience type to allocate memory for address
449 * params for the maximum size and pass such structures around
450 * internally.
451 */
452union sctp_addr_param {
Wei Yongjun6f4c6182007-09-19 17:19:52 +0800453 struct sctp_paramhdr p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454 struct sctp_ipv4addr_param v4;
455 struct sctp_ipv6addr_param v6;
456};
457
458/* A convenience type to allow walking through the various
459 * parameters and avoid casting all over the place.
460 */
461union sctp_params {
462 void *v;
463 struct sctp_paramhdr *p;
464 struct sctp_cookie_preserve_param *life;
465 struct sctp_hostname_param *dns;
466 struct sctp_cookie_param *cookie;
467 struct sctp_supported_addrs_param *sat;
468 struct sctp_ipv4addr_param *v4;
469 struct sctp_ipv6addr_param *v6;
470 union sctp_addr_param *addr;
Ivan Skytte Jorgensen0f3fffd2006-12-20 16:07:04 -0800471 struct sctp_adaptation_ind_param *aind;
Vlad Yasevich131a47e2007-09-16 15:53:56 -0700472 struct sctp_supported_ext_param *ext;
Vlad Yasevich1f485642007-10-09 01:15:59 -0700473 struct sctp_random_param *random;
474 struct sctp_chunks_param *chunks;
475 struct sctp_hmac_algo_param *hmac_algo;
Vlad Yasevichd6de3092007-12-20 14:10:00 -0800476 struct sctp_addip_param *addip;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477};
478
479/* RFC 2960. Section 3.3.5 Heartbeat.
480 * Heartbeat Information: variable length
481 * The Sender-specific Heartbeat Info field should normally include
482 * information about the sender's current time when this HEARTBEAT
483 * chunk is sent and the destination transport address to which this
484 * HEARTBEAT is sent (see Section 8.3).
485 */
486typedef struct sctp_sender_hb_info {
487 struct sctp_paramhdr param_hdr;
488 union sctp_addr daddr;
489 unsigned long sent_at;
Sridhar Samudralaad8fec12006-07-21 14:48:50 -0700490 __u64 hb_nonce;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491} __attribute__((packed)) sctp_sender_hb_info_t;
492
493/*
494 * RFC 2960 1.3.2 Sequenced Delivery within Streams
495 *
496 * The term "stream" is used in SCTP to refer to a sequence of user
497 * messages that are to be delivered to the upper-layer protocol in
498 * order with respect to other messages within the same stream. This is
499 * in contrast to its usage in TCP, where it refers to a sequence of
500 * bytes (in this document a byte is assumed to be eight bits).
501 * ...
502 *
503 * This is the structure we use to track both our outbound and inbound
504 * SSN, or Stream Sequence Numbers.
505 */
506
507struct sctp_stream {
508 __u16 *ssn;
509 unsigned int len;
510};
511
512struct sctp_ssnmap {
513 struct sctp_stream in;
514 struct sctp_stream out;
515 int malloced;
516};
517
Alexey Dobriyan3182cd82005-07-11 20:57:47 -0700518struct sctp_ssnmap *sctp_ssnmap_new(__u16 in, __u16 out,
Al Virodd0fc662005-10-07 07:46:04 +0100519 gfp_t gfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520void sctp_ssnmap_free(struct sctp_ssnmap *map);
521void sctp_ssnmap_clear(struct sctp_ssnmap *map);
522
523/* What is the current SSN number for this stream? */
524static inline __u16 sctp_ssn_peek(struct sctp_stream *stream, __u16 id)
525{
526 return stream->ssn[id];
527}
528
529/* Return the next SSN number for this stream. */
530static inline __u16 sctp_ssn_next(struct sctp_stream *stream, __u16 id)
531{
532 return stream->ssn[id]++;
533}
534
535/* Skip over this ssn and all below. */
536static inline void sctp_ssn_skip(struct sctp_stream *stream, __u16 id,
537 __u16 ssn)
538{
539 stream->ssn[id] = ssn+1;
540}
541
542/*
543 * Pointers to address related SCTP functions.
544 * (i.e. things that depend on the address family.)
545 */
546struct sctp_af {
547 int (*sctp_xmit) (struct sk_buff *skb,
Herbert Xuf8803742008-08-03 21:15:08 -0700548 struct sctp_transport *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549 int (*setsockopt) (struct sock *sk,
550 int level,
551 int optname,
552 char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -0700553 unsigned int optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 int (*getsockopt) (struct sock *sk,
555 int level,
556 int optname,
557 char __user *optval,
558 int __user *optlen);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800559 int (*compat_setsockopt) (struct sock *sk,
560 int level,
561 int optname,
562 char __user *optval,
David S. Millerb7058842009-09-30 16:12:20 -0700563 unsigned int optlen);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800564 int (*compat_getsockopt) (struct sock *sk,
565 int level,
566 int optname,
567 char __user *optval,
568 int __user *optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569 struct dst_entry *(*get_dst) (struct sctp_association *asoc,
570 union sctp_addr *daddr,
571 union sctp_addr *saddr);
YOSHIFUJI Hideakie5117102008-05-29 19:55:05 +0900572 void (*get_saddr) (struct sctp_sock *sk,
573 struct sctp_association *asoc,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 struct dst_entry *dst,
575 union sctp_addr *daddr,
576 union sctp_addr *saddr);
577 void (*copy_addrlist) (struct list_head *,
578 struct net_device *);
579 void (*dst_saddr) (union sctp_addr *saddr,
580 struct dst_entry *dst,
Al Viro854d43a2006-11-20 17:06:24 -0800581 __be16 port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 int (*cmp_addr) (const union sctp_addr *addr1,
583 const union sctp_addr *addr2);
584 void (*addr_copy) (union sctp_addr *dst,
585 union sctp_addr *src);
586 void (*from_skb) (union sctp_addr *,
587 struct sk_buff *skb,
588 int saddr);
589 void (*from_sk) (union sctp_addr *,
590 struct sock *sk);
591 void (*to_sk_saddr) (union sctp_addr *,
592 struct sock *sk);
593 void (*to_sk_daddr) (union sctp_addr *,
594 struct sock *sk);
595 void (*from_addr_param) (union sctp_addr *,
596 union sctp_addr_param *,
Al Virodd86d132006-11-20 17:11:13 -0800597 __be16 port, int iif);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 int (*to_addr_param) (const union sctp_addr *,
599 union sctp_addr_param *);
600 int (*addr_valid) (union sctp_addr *,
Vlad Yasevich5636bef2006-06-17 22:55:35 -0700601 struct sctp_sock *,
602 const struct sk_buff *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603 sctp_scope_t (*scope) (union sctp_addr *);
Al Viro6fbfa9f2006-11-20 17:24:53 -0800604 void (*inaddr_any) (union sctp_addr *, __be16);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 int (*is_any) (const union sctp_addr *);
606 int (*available) (union sctp_addr *,
607 struct sctp_sock *);
608 int (*skb_iif) (const struct sk_buff *sk);
609 int (*is_ce) (const struct sk_buff *sk);
610 void (*seq_dump_addr)(struct seq_file *seq,
611 union sctp_addr *addr);
Vlad Yasevichb9031d92008-06-04 12:40:15 -0700612 void (*ecn_capable)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 __u16 net_header_len;
614 int sockaddr_len;
615 sa_family_t sa_family;
616 struct list_head list;
617};
618
619struct sctp_af *sctp_get_af_specific(sa_family_t);
620int sctp_register_af(struct sctp_af *);
621
622/* Protocol family functions. */
623struct sctp_pf {
624 void (*event_msgname)(struct sctp_ulpevent *, char *, int *);
625 void (*skb_msgname) (struct sk_buff *, char *, int *);
626 int (*af_supported) (sa_family_t, struct sctp_sock *);
627 int (*cmp_addr) (const union sctp_addr *,
628 const union sctp_addr *,
629 struct sctp_sock *);
630 int (*bind_verify) (struct sctp_sock *, union sctp_addr *);
631 int (*send_verify) (struct sctp_sock *, union sctp_addr *);
Al Viro3dbe8652006-11-20 17:25:49 -0800632 int (*supported_addrs)(const struct sctp_sock *, __be16 *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633 struct sock *(*create_accept_sk) (struct sock *sk,
634 struct sctp_association *asoc);
635 void (*addr_v4map) (struct sctp_sock *, union sctp_addr *);
636 struct sctp_af *af;
637};
638
639
640/* Structure to track chunk fragments that have been acked, but peer
641 * fragments of the same message have not.
642 */
643struct sctp_datamsg {
644 /* Chunks waiting to be submitted to lower layer. */
645 struct list_head chunks;
646 /* Chunks that have been transmitted. */
Vlad Yasevichcb95ea32009-09-04 18:20:59 -0400647 size_t msg_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 /* Reference counting. */
649 atomic_t refcnt;
650 /* When is this message no longer interesting to the peer? */
651 unsigned long expires_at;
652 /* Did the messenge fail to send? */
653 int send_error;
654 char send_failed;
655 /* Control whether chunks from this message can be abandoned. */
656 char can_abandon;
657};
658
659struct sctp_datamsg *sctp_datamsg_from_user(struct sctp_association *,
660 struct sctp_sndrcvinfo *,
661 struct msghdr *, int len);
Vlad Yasevich9c5c62b2009-08-10 13:51:03 -0400662void sctp_datamsg_free(struct sctp_datamsg *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663void sctp_datamsg_put(struct sctp_datamsg *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664void sctp_chunk_fail(struct sctp_chunk *, int error);
665int sctp_chunk_abandoned(struct sctp_chunk *);
666
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667/* RFC2960 1.4 Key Terms
668 *
669 * o Chunk: A unit of information within an SCTP packet, consisting of
670 * a chunk header and chunk-specific content.
671 *
672 * As a matter of convenience, we remember the SCTP common header for
673 * each chunk as well as a few other header pointers...
674 */
675struct sctp_chunk {
David S. Miller79af02c2005-07-08 21:47:49 -0700676 struct list_head list;
677
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678 atomic_t refcnt;
679
680 /* This is our link to the per-transport transmitted list. */
681 struct list_head transmitted_list;
682
683 /* This field is used by chunks that hold fragmented data.
684 * For the first fragment this is the list that holds the rest of
685 * fragments. For the remaining fragments, this is the link to the
686 * frag_list maintained in the first fragment.
687 */
688 struct list_head frag_list;
689
690 /* This points to the sk_buff containing the actual data. */
691 struct sk_buff *skb;
692
693 /* These are the SCTP headers by reverse order in a packet.
694 * Note that some of these may happen more than once. In that
695 * case, we point at the "current" one, whatever that means
696 * for that level of header.
697 */
698
699 /* We point this at the FIRST TLV parameter to chunk_hdr. */
700 union sctp_params param_hdr;
701 union {
702 __u8 *v;
703 struct sctp_datahdr *data_hdr;
704 struct sctp_inithdr *init_hdr;
705 struct sctp_sackhdr *sack_hdr;
706 struct sctp_heartbeathdr *hb_hdr;
707 struct sctp_sender_hb_info *hbs_hdr;
708 struct sctp_shutdownhdr *shutdown_hdr;
709 struct sctp_signed_cookie *cookie_hdr;
710 struct sctp_ecnehdr *ecne_hdr;
711 struct sctp_cwrhdr *ecn_cwr_hdr;
712 struct sctp_errhdr *err_hdr;
713 struct sctp_addiphdr *addip_hdr;
714 struct sctp_fwdtsn_hdr *fwdtsn_hdr;
Vlad Yasevich1f485642007-10-09 01:15:59 -0700715 struct sctp_authhdr *auth_hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716 } subh;
717
718 __u8 *chunk_end;
719
720 struct sctp_chunkhdr *chunk_hdr;
721 struct sctphdr *sctp_hdr;
722
723 /* This needs to be recoverable for SCTP_SEND_FAILED events. */
724 struct sctp_sndrcvinfo sinfo;
725
726 /* Which association does this belong to? */
727 struct sctp_association *asoc;
728
729 /* What endpoint received this chunk? */
730 struct sctp_ep_common *rcvr;
731
732 /* We fill this in if we are calculating RTT. */
733 unsigned long sent_at;
734
735 /* What is the origin IP address for this chunk? */
736 union sctp_addr source;
737 /* Destination address for this chunk. */
738 union sctp_addr dest;
739
740 /* For outbound message, track all fragments for SEND_FAILED. */
741 struct sctp_datamsg *msg;
742
743 /* For an inbound chunk, this tells us where it came from.
744 * For an outbound chunk, it tells us where we'd like it to
745 * go. It is NULL if we have no preference.
746 */
747 struct sctp_transport *transport;
748
Vlad Yasevichbbd0d592007-10-03 17:51:34 -0700749 /* SCTP-AUTH: For the special case inbound processing of COOKIE-ECHO
750 * we need save a pointer to the AUTH chunk, since the SCTP-AUTH
751 * spec violates the principle premis that all chunks are processed
752 * in order.
753 */
754 struct sk_buff *auth_chunk;
755
Neil Hormanc226ef92008-07-25 12:44:09 -0400756#define SCTP_CAN_FRTX 0x0
757#define SCTP_NEED_FRTX 0x1
758#define SCTP_DONT_FRTX 0x2
759 __u16 rtt_in_progress:1, /* This chunk used for RTT calc? */
760 resent:1, /* Has this chunk ever been resent. */
761 has_tsn:1, /* Does this chunk have a TSN yet? */
762 has_ssn:1, /* Does this chunk have a SSN yet? */
763 singleton:1, /* Only chunk in the packet? */
764 end_of_packet:1, /* Last chunk in the packet? */
765 ecn_ce_done:1, /* Have we processed the ECN CE bit? */
766 pdiscard:1, /* Discard the whole packet now? */
767 tsn_gap_acked:1, /* Is this chunk acked by a GAP ACK? */
768 data_accepted:1, /* At least 1 chunk accepted */
769 auth:1, /* IN: was auth'ed | OUT: needs auth */
770 has_asconf:1, /* IN: have seen an asconf before */
771 tsn_missing_report:2, /* Data chunk missing counter. */
772 fast_retransmit:2; /* Is this chunk fast retransmitted? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773};
774
775void sctp_chunk_hold(struct sctp_chunk *);
776void sctp_chunk_put(struct sctp_chunk *);
777int sctp_user_addto_chunk(struct sctp_chunk *chunk, int off, int len,
778 struct iovec *data);
779void sctp_chunk_free(struct sctp_chunk *);
780void *sctp_addto_chunk(struct sctp_chunk *, int len, const void *data);
Neil Horman5fa782c2010-04-28 10:30:59 +0000781void *sctp_addto_chunk_fixed(struct sctp_chunk *, int len, const void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782struct sctp_chunk *sctp_chunkify(struct sk_buff *,
783 const struct sctp_association *,
784 struct sock *);
785void sctp_init_addrs(struct sctp_chunk *, union sctp_addr *,
786 union sctp_addr *);
787const union sctp_addr *sctp_source(const struct sctp_chunk *chunk);
788
Vlad Yasevichf57d96b2007-12-20 14:12:24 -0800789enum {
790 SCTP_ADDR_NEW, /* new address added to assoc/ep */
791 SCTP_ADDR_SRC, /* address can be used as source */
792 SCTP_ADDR_DEL, /* address about to be deleted */
793};
794
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795/* This is a structure for holding either an IPv6 or an IPv4 address. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796struct sctp_sockaddr_entry {
797 struct list_head list;
Vlad Yasevich29303542007-09-16 16:02:12 -0700798 struct rcu_head rcu;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 union sctp_addr a;
Vlad Yasevichf57d96b2007-12-20 14:12:24 -0800800 __u8 state;
Vlad Yasevich29303542007-09-16 16:02:12 -0700801 __u8 valid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802};
803
804typedef struct sctp_chunk *(sctp_packet_phandler_t)(struct sctp_association *);
805
806/* This structure holds lists of chunks as we are assembling for
807 * transmission.
808 */
809struct sctp_packet {
810 /* These are the SCTP header values (host order) for the packet. */
811 __u16 source_port;
812 __u16 destination_port;
813 __u32 vtag;
814
815 /* This contains the payload chunks. */
David S. Miller79af02c2005-07-08 21:47:49 -0700816 struct list_head chunk_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817
818 /* This is the overhead of the sctp and ip headers. */
819 size_t overhead;
820 /* This is the total size of all chunks INCLUDING padding. */
821 size_t size;
822
823 /* The packet is destined for this transport address.
824 * The function we finally use to pass down to the next lower
825 * layer lives in the transport structure.
826 */
827 struct sctp_transport *transport;
828
Vlad Yasevich1f485642007-10-09 01:15:59 -0700829 /* pointer to the auth chunk for this packet */
830 struct sctp_chunk *auth;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831
Vlad Yasevicha803c942009-09-04 18:21:01 -0400832 u8 has_cookie_echo:1, /* This packet contains a COOKIE-ECHO chunk. */
833 has_sack:1, /* This packet contains a SACK chunk. */
834 has_auth:1, /* This packet contains an AUTH chunk */
835 has_data:1, /* This packet contains at least 1 DATA chunk */
836 ipfragok:1, /* So let ip fragment this packet */
837 malloced:1; /* Is it malloced? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838};
839
840struct sctp_packet *sctp_packet_init(struct sctp_packet *,
841 struct sctp_transport *,
842 __u16 sport, __u16 dport);
843struct sctp_packet *sctp_packet_config(struct sctp_packet *, __u32 vtag, int);
844sctp_xmit_t sctp_packet_transmit_chunk(struct sctp_packet *,
Vlad Yasevich2e3216c2008-06-19 16:08:18 -0700845 struct sctp_chunk *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846sctp_xmit_t sctp_packet_append_chunk(struct sctp_packet *,
847 struct sctp_chunk *);
848int sctp_packet_transmit(struct sctp_packet *);
849void sctp_packet_free(struct sctp_packet *);
850
851static inline int sctp_packet_empty(struct sctp_packet *packet)
852{
853 return (packet->size == packet->overhead);
854}
855
856/* This represents a remote transport address.
857 * For local transport addresses, we just use union sctp_addr.
858 *
859 * RFC2960 Section 1.4 Key Terms
860 *
861 * o Transport address: A Transport Address is traditionally defined
862 * by Network Layer address, Transport Layer protocol and Transport
863 * Layer port number. In the case of SCTP running over IP, a
864 * transport address is defined by the combination of an IP address
865 * and an SCTP port number (where SCTP is the Transport protocol).
866 *
867 * RFC2960 Section 7.1 SCTP Differences from TCP Congestion control
868 *
869 * o The sender keeps a separate congestion control parameter set for
870 * each of the destination addresses it can send to (not each
871 * source-destination pair but for each destination). The parameters
872 * should decay if the address is not used for a long enough time
873 * period.
874 *
875 */
876struct sctp_transport {
877 /* A list of transports. */
878 struct list_head transports;
879
880 /* Reference counting. */
881 atomic_t refcnt;
882 int dead;
883
884 /* This is the peer's IP address and port. */
885 union sctp_addr ipaddr;
886
887 /* These are the functions we call to handle LLP stuff. */
888 struct sctp_af *af_specific;
889
890 /* Which association do we belong to? */
891 struct sctp_association *asoc;
892
893 /* RFC2960
894 *
895 * 12.3 Per Transport Address Data
896 *
897 * For each destination transport address in the peer's
898 * address list derived from the INIT or INIT ACK chunk, a
899 * number of data elements needs to be maintained including:
900 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901 /* RTO : The current retransmission timeout value. */
Vlad Yasevich8116ffa2006-01-17 11:55:17 -0800902 unsigned long rto;
Vlad Yasevichb6157d82007-10-24 15:59:16 -0400903
904 __u32 rtt; /* This is the most recent RTT. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905
906 /* RTTVAR : The current RTT variation. */
907 __u32 rttvar;
908
909 /* SRTT : The current smoothed round trip time. */
910 __u32 srtt;
911
912 /* RTO-Pending : A flag used to track if one of the DATA
913 * chunks sent to this address is currently being
914 * used to compute a RTT. If this flag is 0,
915 * the next DATA chunk sent to this destination
916 * should be used to compute a RTT and this flag
917 * should be set. Every time the RTT
918 * calculation completes (i.e. the DATA chunk
919 * is SACK'd) clear this flag.
Vlad Yasevichfaee47c2009-02-13 08:33:43 +0000920 * hb_sent : a flag that signals that we have a pending heartbeat.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921 */
Vlad Yasevicha6465232008-06-04 12:38:43 -0700922 __u8 rto_pending;
Vlad Yasevichfaee47c2009-02-13 08:33:43 +0000923 __u8 hb_sent;
Vlad Yasevicha6465232008-06-04 12:38:43 -0700924
925 /* Flag to track the current fast recovery state */
926 __u8 fast_recovery;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927
928 /*
929 * These are the congestion stats.
930 */
931 /* cwnd : The current congestion window. */
932 __u32 cwnd; /* This is the actual cwnd. */
933
934 /* ssthresh : The current slow start threshold value. */
935 __u32 ssthresh;
936
937 /* partial : The tracking method for increase of cwnd when in
938 * bytes acked : congestion avoidance mode (see Section 6.2.2)
939 */
940 __u32 partial_bytes_acked;
941
942 /* Data that has been sent, but not acknowledged. */
943 __u32 flight_size;
944
Vlad Yasevich46d5a802009-11-23 15:54:00 -0500945 __u32 burst_limited; /* Holds old cwnd when max.burst is applied */
946
Vlad Yasevicha6465232008-06-04 12:38:43 -0700947 /* TSN marking the fast recovery exit point */
948 __u32 fast_recovery_exit;
949
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950 /* Destination */
951 struct dst_entry *dst;
952 /* Source address. */
953 union sctp_addr saddr;
954
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955 /* Heartbeat interval: The endpoint sends out a Heartbeat chunk to
956 * the destination address every heartbeat interval.
957 */
Vlad Yasevich8116ffa2006-01-17 11:55:17 -0800958 unsigned long hbinterval;
Frank Filz52ccb8e2005-12-22 11:36:46 -0800959
960 /* SACK delay timeout */
Vlad Yasevich8116ffa2006-01-17 11:55:17 -0800961 unsigned long sackdelay;
Wei Yongjund364d922008-05-09 15:13:26 -0700962 __u32 sackfreq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963
964 /* When was the last time (in jiffies) that we heard from this
965 * transport? We use this to pick new active and retran paths.
966 */
967 unsigned long last_time_heard;
968
969 /* Last time(in jiffies) when cwnd is reduced due to the congestion
970 * indication based on ECNE chunk.
971 */
972 unsigned long last_time_ecne_reduced;
973
Vlad Yasevich8116ffa2006-01-17 11:55:17 -0800974 /* This is the max_retrans value for the transport and will
975 * be initialized from the assocs value. This can be changed
976 * using SCTP_SET_PEER_ADDR_PARAMS socket option.
977 */
978 __u16 pathmaxrxt;
979
Vlad Yasevich8a479492007-06-07 14:21:05 -0400980 /* is the Path MTU update pending on this tranport */
981 __u8 pmtu_pending;
982
Vlad Yasevich8116ffa2006-01-17 11:55:17 -0800983 /* PMTU : The current known path MTU. */
984 __u32 pathmtu;
985
Joe Perchesf4ab2f722007-12-20 13:56:32 -0800986 /* Flags controlling Heartbeat, SACK delay, and Path MTU Discovery. */
Vlad Yasevich8116ffa2006-01-17 11:55:17 -0800987 __u32 param_flags;
988
Frank Filz3f7a87d2005-06-20 13:14:57 -0700989 /* The number of times INIT has been sent on this transport. */
990 int init_sent_count;
991
992 /* state : The current state of this destination,
André Goddard Rosaaf901ca2009-11-14 13:09:05 -0200993 * : i.e. SCTP_ACTIVE, SCTP_INACTIVE, SCTP_UNKNOWN.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994 */
Frank Filz3f7a87d2005-06-20 13:14:57 -0700995 int state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 /* These are the error stats for this destination. */
998
999 /* Error count : The current error count for this destination. */
1000 unsigned short error_count;
1001
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002 /* Per : A timer used by each destination.
1003 * Destination :
1004 * Timer :
1005 *
1006 * [Everywhere else in the text this is called T3-rtx. -ed]
1007 */
1008 struct timer_list T3_rtx_timer;
1009
1010 /* Heartbeat timer is per destination. */
1011 struct timer_list hb_timer;
1012
1013 /* Since we're using per-destination retransmission timers
1014 * (see above), we're also using per-destination "transmitted"
1015 * queues. This probably ought to be a private struct
1016 * accessible only within the outqueue, but it's not, yet.
1017 */
1018 struct list_head transmitted;
1019
1020 /* We build bundle-able packets for this transport here. */
1021 struct sctp_packet packet;
1022
1023 /* This is the list of transports that have chunks to send. */
1024 struct list_head send_ready;
1025
1026 int malloced; /* Is this structure kfree()able? */
1027
1028 /* State information saved for SFR_CACC algorithm. The key
1029 * idea in SFR_CACC is to maintain state at the sender on a
1030 * per-destination basis when a changeover happens.
1031 * char changeover_active;
1032 * char cycling_changeover;
1033 * __u32 next_tsn_at_change;
1034 * char cacc_saw_newack;
1035 */
1036 struct {
1037 /* An unsigned integer, which stores the next TSN to be
1038 * used by the sender, at the moment of changeover.
1039 */
1040 __u32 next_tsn_at_change;
1041
1042 /* A flag which indicates the occurrence of a changeover */
1043 char changeover_active;
1044
1045 /* A flag which indicates whether the change of primary is
1046 * the first switch to this destination address during an
1047 * active switch.
1048 */
1049 char cycling_changeover;
1050
1051 /* A temporary flag, which is used during the processing of
1052 * a SACK to estimate the causative TSN(s)'s group.
1053 */
1054 char cacc_saw_newack;
1055 } cacc;
Sridhar Samudralaad8fec12006-07-21 14:48:50 -07001056
1057 /* 64-bit random number sent with heartbeat. */
1058 __u64 hb_nonce;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059};
1060
Alexey Dobriyan3182cd82005-07-11 20:57:47 -07001061struct sctp_transport *sctp_transport_new(const union sctp_addr *,
Al Virodd0fc662005-10-07 07:46:04 +01001062 gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063void sctp_transport_set_owner(struct sctp_transport *,
1064 struct sctp_association *);
1065void sctp_transport_route(struct sctp_transport *, union sctp_addr *,
1066 struct sctp_sock *);
1067void sctp_transport_pmtu(struct sctp_transport *);
1068void sctp_transport_free(struct sctp_transport *);
Vlad Yasevich62aeaff2008-06-04 12:39:11 -07001069void sctp_transport_reset_timers(struct sctp_transport *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070void sctp_transport_hold(struct sctp_transport *);
1071void sctp_transport_put(struct sctp_transport *);
1072void sctp_transport_update_rto(struct sctp_transport *, __u32);
1073void sctp_transport_raise_cwnd(struct sctp_transport *, __u32, __u32);
1074void sctp_transport_lower_cwnd(struct sctp_transport *, sctp_lower_cwnd_t);
Vlad Yasevich46d5a802009-11-23 15:54:00 -05001075void sctp_transport_burst_limited(struct sctp_transport *);
1076void sctp_transport_burst_reset(struct sctp_transport *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077unsigned long sctp_transport_timeout(struct sctp_transport *);
Vlad Yasevich749bf922007-03-19 17:02:30 -07001078void sctp_transport_reset(struct sctp_transport *);
Vlad Yasevichc910b472007-06-07 13:47:03 -04001079void sctp_transport_update_pmtu(struct sctp_transport *, u32);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080
1081
1082/* This is the structure we use to queue packets as they come into
1083 * SCTP. We write packets to it and read chunks from it.
1084 */
1085struct sctp_inq {
1086 /* This is actually a queue of sctp_chunk each
1087 * containing a partially decoded packet.
1088 */
David S. Miller79af02c2005-07-08 21:47:49 -07001089 struct list_head in_chunk_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001090 /* This is the packet which is currently off the in queue and is
1091 * being worked on through the inbound chunk processing.
1092 */
1093 struct sctp_chunk *in_progress;
1094
1095 /* This is the delayed task to finish delivering inbound
1096 * messages.
1097 */
1098 struct work_struct immediate;
1099
1100 int malloced; /* Is this structure kfree()able? */
1101};
1102
1103void sctp_inq_init(struct sctp_inq *);
1104void sctp_inq_free(struct sctp_inq *);
1105void sctp_inq_push(struct sctp_inq *, struct sctp_chunk *packet);
1106struct sctp_chunk *sctp_inq_pop(struct sctp_inq *);
Vlad Yasevichbbd0d592007-10-03 17:51:34 -07001107struct sctp_chunkhdr *sctp_inq_peek(struct sctp_inq *);
David Howellsc4028952006-11-22 14:57:56 +00001108void sctp_inq_set_th_handler(struct sctp_inq *, work_func_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109
1110/* This is the structure we use to hold outbound chunks. You push
1111 * chunks in and they automatically pop out the other end as bundled
1112 * packets (it calls (*output_handler)()).
1113 *
1114 * This structure covers sections 6.3, 6.4, 6.7, 6.8, 6.10, 7., 8.1,
1115 * and 8.2 of the v13 draft.
1116 *
1117 * It handles retransmissions. The connection to the timeout portion
1118 * of the state machine is through sctp_..._timeout() and timeout_handler.
1119 *
1120 * If you feed it SACKs, it will eat them.
1121 *
1122 * If you give it big chunks, it will fragment them.
1123 *
1124 * It assigns TSN's to data chunks. This happens at the last possible
1125 * instant before transmission.
1126 *
1127 * When free()'d, it empties itself out via output_handler().
1128 */
1129struct sctp_outq {
1130 struct sctp_association *asoc;
1131
1132 /* Data pending that has never been transmitted. */
David S. Miller79af02c2005-07-08 21:47:49 -07001133 struct list_head out_chunk_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134
1135 unsigned out_qlen; /* Total length of queued data chunks. */
1136
1137 /* Error of send failed, may used in SCTP_SEND_FAILED event. */
1138 unsigned error;
1139
1140 /* These are control chunks we want to send. */
David S. Miller79af02c2005-07-08 21:47:49 -07001141 struct list_head control_chunk_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142
1143 /* These are chunks that have been sacked but are above the
1144 * CTSN, or cumulative tsn ack point.
1145 */
1146 struct list_head sacked;
1147
1148 /* Put chunks on this list to schedule them for
1149 * retransmission.
1150 */
1151 struct list_head retransmit;
1152
1153 /* Put chunks on this list to save them for FWD TSN processing as
1154 * they were abandoned.
1155 */
1156 struct list_head abandoned;
1157
1158 /* How many unackd bytes do we have in-flight? */
1159 __u32 outstanding_bytes;
1160
Vlad Yasevich62aeaff2008-06-04 12:39:11 -07001161 /* Are we doing fast-rtx on this queue */
1162 char fast_rtx;
1163
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164 /* Corked? */
1165 char cork;
1166
1167 /* Is this structure empty? */
1168 char empty;
1169
1170 /* Are we kfree()able? */
1171 char malloced;
1172};
1173
1174void sctp_outq_init(struct sctp_association *, struct sctp_outq *);
1175void sctp_outq_teardown(struct sctp_outq *);
1176void sctp_outq_free(struct sctp_outq*);
1177int sctp_outq_tail(struct sctp_outq *, struct sctp_chunk *chunk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178int sctp_outq_sack(struct sctp_outq *, struct sctp_sackhdr *);
1179int sctp_outq_is_empty(const struct sctp_outq *);
1180void sctp_outq_restart(struct sctp_outq *);
1181
1182void sctp_retransmit(struct sctp_outq *, struct sctp_transport *,
1183 sctp_retransmit_reason_t);
1184void sctp_retransmit_mark(struct sctp_outq *, struct sctp_transport *, __u8);
1185int sctp_outq_uncork(struct sctp_outq *);
1186/* Uncork and flush an outqueue. */
1187static inline void sctp_outq_cork(struct sctp_outq *q)
1188{
1189 q->cork = 1;
1190}
1191
1192/* These bind address data fields common between endpoints and associations */
1193struct sctp_bind_addr {
1194
1195 /* RFC 2960 12.1 Parameters necessary for the SCTP instance
1196 *
1197 * SCTP Port: The local SCTP port number the endpoint is
1198 * bound to.
1199 */
1200 __u16 port;
1201
1202 /* RFC 2960 12.1 Parameters necessary for the SCTP instance
1203 *
1204 * Address List: The list of IP addresses that this instance
1205 * has bound. This information is passed to one's
1206 * peer(s) in INIT and INIT ACK chunks.
1207 */
1208 struct list_head address_list;
1209
1210 int malloced; /* Are we kfree()able? */
1211};
1212
1213void sctp_bind_addr_init(struct sctp_bind_addr *, __u16 port);
1214void sctp_bind_addr_free(struct sctp_bind_addr *);
1215int sctp_bind_addr_copy(struct sctp_bind_addr *dest,
1216 const struct sctp_bind_addr *src,
Al Virodd0fc662005-10-07 07:46:04 +01001217 sctp_scope_t scope, gfp_t gfp,
Alexey Dobriyan3182cd82005-07-11 20:57:47 -07001218 int flags);
Vlad Yasevich8e71a112007-12-06 22:50:54 -08001219int sctp_bind_addr_dup(struct sctp_bind_addr *dest,
1220 const struct sctp_bind_addr *src,
1221 gfp_t gfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222int sctp_add_bind_addr(struct sctp_bind_addr *, union sctp_addr *,
Vlad Yasevichf57d96b2007-12-20 14:12:24 -08001223 __u8 addr_state, gfp_t gfp);
Vlad Yasevich0ed90fb2007-10-24 16:10:00 -04001224int sctp_del_bind_addr(struct sctp_bind_addr *, union sctp_addr *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225int sctp_bind_addr_match(struct sctp_bind_addr *, const union sctp_addr *,
1226 struct sctp_sock *);
Vlad Yasevich7dab83d2008-07-18 23:05:40 -07001227int sctp_bind_addr_conflict(struct sctp_bind_addr *, const union sctp_addr *,
1228 struct sctp_sock *, struct sctp_sock *);
Vlad Yasevich75205f42007-12-20 14:12:59 -08001229int sctp_bind_addr_state(const struct sctp_bind_addr *bp,
1230 const union sctp_addr *addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231union sctp_addr *sctp_find_unmatch_addr(struct sctp_bind_addr *bp,
1232 const union sctp_addr *addrs,
1233 int addrcnt,
1234 struct sctp_sock *opt);
1235union sctp_params sctp_bind_addrs_to_raw(const struct sctp_bind_addr *bp,
Alexey Dobriyan3182cd82005-07-11 20:57:47 -07001236 int *addrs_len,
Al Virodd0fc662005-10-07 07:46:04 +01001237 gfp_t gfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238int sctp_raw_to_bind_addrs(struct sctp_bind_addr *bp, __u8 *raw, int len,
Al Virodd0fc662005-10-07 07:46:04 +01001239 __u16 port, gfp_t gfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001240
1241sctp_scope_t sctp_scope(const union sctp_addr *);
1242int sctp_in_scope(const union sctp_addr *addr, const sctp_scope_t scope);
Vlad Yasevich52cae8f2008-08-18 10:34:34 -04001243int sctp_is_any(struct sock *sk, const union sctp_addr *addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244int sctp_addr_is_valid(const union sctp_addr *addr);
1245
1246
1247/* What type of endpoint? */
1248typedef enum {
1249 SCTP_EP_TYPE_SOCKET,
1250 SCTP_EP_TYPE_ASSOCIATION,
1251} sctp_endpoint_type_t;
1252
1253/*
1254 * A common base class to bridge the implmentation view of a
1255 * socket (usually listening) endpoint versus an association's
1256 * local endpoint.
1257 * This common structure is useful for several purposes:
1258 * 1) Common interface for lookup routines.
1259 * a) Subfunctions work for either endpoint or association
1260 * b) Single interface to lookup allows hiding the lookup lock rather
1261 * than acquiring it externally.
1262 * 2) Common interface for the inbound chunk handling/state machine.
1263 * 3) Common object handling routines for reference counting, etc.
1264 * 4) Disentangle association lookup from endpoint lookup, where we
1265 * do not have to find our endpoint to find our association.
1266 *
1267 */
1268
1269struct sctp_ep_common {
1270 /* Fields to help us manage our entries in the hash tables. */
Vlad Yasevichd970dbf2007-11-09 11:43:40 -05001271 struct hlist_node node;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272 int hashent;
1273
1274 /* Runtime type information. What kind of endpoint is this? */
1275 sctp_endpoint_type_t type;
1276
1277 /* Some fields to help us manage this object.
1278 * refcnt - Reference count access to this object.
1279 * dead - Do not attempt to use this object.
1280 * malloced - Do we need to kfree this object?
1281 */
1282 atomic_t refcnt;
1283 char dead;
1284 char malloced;
1285
1286 /* What socket does this endpoint belong to? */
1287 struct sock *sk;
1288
1289 /* This is where we receive inbound chunks. */
1290 struct sctp_inq inqueue;
1291
1292 /* This substructure includes the defining parameters of the
1293 * endpoint:
1294 * bind_addr.port is our shared port number.
1295 * bind_addr.address_list is our set of local IP addresses.
1296 */
1297 struct sctp_bind_addr bind_addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298};
1299
1300
1301/* RFC Section 1.4 Key Terms
1302 *
1303 * o SCTP endpoint: The logical sender/receiver of SCTP packets. On a
1304 * multi-homed host, an SCTP endpoint is represented to its peers as a
1305 * combination of a set of eligible destination transport addresses to
1306 * which SCTP packets can be sent and a set of eligible source
1307 * transport addresses from which SCTP packets can be received.
1308 * All transport addresses used by an SCTP endpoint must use the
1309 * same port number, but can use multiple IP addresses. A transport
1310 * address used by an SCTP endpoint must not be used by another
1311 * SCTP endpoint. In other words, a transport address is unique
1312 * to an SCTP endpoint.
1313 *
1314 * From an implementation perspective, each socket has one of these.
1315 * A TCP-style socket will have exactly one association on one of
1316 * these. An UDP-style socket will have multiple associations hanging
1317 * off one of these.
1318 */
1319
1320struct sctp_endpoint {
1321 /* Common substructure for endpoint and association. */
1322 struct sctp_ep_common base;
1323
1324 /* Associations: A list of current associations and mappings
1325 * to the data consumers for each association. This
1326 * may be in the form of a hash table or other
1327 * implementation dependent structure. The data
1328 * consumers may be process identification
1329 * information such as file descriptors, named pipe
1330 * pointer, or table pointers dependent on how SCTP
1331 * is implemented.
1332 */
1333 /* This is really a list of struct sctp_association entries. */
1334 struct list_head asocs;
1335
1336 /* Secret Key: A secret key used by this endpoint to compute
1337 * the MAC. This SHOULD be a cryptographic quality
1338 * random number with a sufficient length.
1339 * Discussion in [RFC1750] can be helpful in
1340 * selection of the key.
1341 */
1342 __u8 secret_key[SCTP_HOW_MANY_SECRETS][SCTP_SECRET_SIZE];
1343 int current_key;
1344 int last_key;
1345 int key_changed_at;
1346
Vlad Yasevich313e7b42006-01-17 11:55:57 -08001347 /* digest: This is a digest of the sctp cookie. This field is
1348 * only used on the receive path when we try to validate
1349 * that the cookie has not been tampered with. We put
1350 * this here so we pre-allocate this once and can re-use
1351 * on every receive.
1352 */
Vlad Yasevichb68dbca2006-11-09 16:29:57 -08001353 __u8 *digest;
Vlad Yasevich313e7b42006-01-17 11:55:57 -08001354
Neil Horman4eb701d2005-04-28 12:02:04 -07001355 /* sendbuf acct. policy. */
1356 __u32 sndbuf_policy;
Neil Horman049b3ff2005-11-11 16:08:24 -08001357
1358 /* rcvbuf acct. policy. */
1359 __u32 rcvbuf_policy;
Vlad Yasevich1f485642007-10-09 01:15:59 -07001360
1361 /* SCTP AUTH: array of the HMACs that will be allocated
1362 * we need this per association so that we don't serialize
1363 */
1364 struct crypto_hash **auth_hmacs;
1365
1366 /* SCTP-AUTH: hmacs for the endpoint encoded into parameter */
1367 struct sctp_hmac_algo_param *auth_hmacs_list;
1368
1369 /* SCTP-AUTH: chunks to authenticate encoded into parameter */
1370 struct sctp_chunks_param *auth_chunk_list;
1371
1372 /* SCTP-AUTH: endpoint shared keys */
1373 struct list_head endpoint_shared_keys;
1374 __u16 active_key_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375};
1376
1377/* Recover the outter endpoint structure. */
1378static inline struct sctp_endpoint *sctp_ep(struct sctp_ep_common *base)
1379{
1380 struct sctp_endpoint *ep;
1381
1382 ep = container_of(base, struct sctp_endpoint, base);
1383 return ep;
1384}
1385
1386/* These are function signatures for manipulating endpoints. */
Al Virodd0fc662005-10-07 07:46:04 +01001387struct sctp_endpoint *sctp_endpoint_new(struct sock *, gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388void sctp_endpoint_free(struct sctp_endpoint *);
1389void sctp_endpoint_put(struct sctp_endpoint *);
1390void sctp_endpoint_hold(struct sctp_endpoint *);
1391void sctp_endpoint_add_asoc(struct sctp_endpoint *, struct sctp_association *);
1392struct sctp_association *sctp_endpoint_lookup_assoc(
1393 const struct sctp_endpoint *ep,
1394 const union sctp_addr *paddr,
1395 struct sctp_transport **);
1396int sctp_endpoint_is_peeled_off(struct sctp_endpoint *,
1397 const union sctp_addr *);
1398struct sctp_endpoint *sctp_endpoint_is_match(struct sctp_endpoint *,
1399 const union sctp_addr *);
1400int sctp_has_association(const union sctp_addr *laddr,
1401 const union sctp_addr *paddr);
1402
1403int sctp_verify_init(const struct sctp_association *asoc, sctp_cid_t,
1404 sctp_init_chunk_t *peer_init, struct sctp_chunk *chunk,
1405 struct sctp_chunk **err_chunk);
1406int sctp_process_init(struct sctp_association *, sctp_cid_t cid,
1407 const union sctp_addr *peer,
Al Virodd0fc662005-10-07 07:46:04 +01001408 sctp_init_chunk_t *init, gfp_t gfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001409__u32 sctp_generate_tag(const struct sctp_endpoint *);
1410__u32 sctp_generate_tsn(const struct sctp_endpoint *);
1411
Al Viroe1857ea2006-11-20 17:25:32 -08001412struct sctp_inithdr_host {
1413 __u32 init_tag;
1414 __u32 a_rwnd;
1415 __u16 num_outbound_streams;
1416 __u16 num_inbound_streams;
1417 __u32 initial_tsn;
1418};
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419
1420/* RFC2960
1421 *
1422 * 12. Recommended Transmission Control Block (TCB) Parameters
1423 *
1424 * This section details a recommended set of parameters that should
1425 * be contained within the TCB for an implementation. This section is
1426 * for illustrative purposes and should not be deemed as requirements
1427 * on an implementation or as an exhaustive list of all parameters
1428 * inside an SCTP TCB. Each implementation may need its own additional
1429 * parameters for optimization.
1430 */
1431
1432
1433/* Here we have information about each individual association. */
1434struct sctp_association {
1435
1436 /* A base structure common to endpoint and association.
1437 * In this context, it represents the associations's view
1438 * of the local endpoint of the association.
1439 */
1440 struct sctp_ep_common base;
1441
1442 /* Associations on the same socket. */
1443 struct list_head asocs;
1444
1445 /* association id. */
1446 sctp_assoc_t assoc_id;
1447
1448 /* This is our parent endpoint. */
1449 struct sctp_endpoint *ep;
1450
1451 /* These are those association elements needed in the cookie. */
1452 struct sctp_cookie c;
1453
1454 /* This is all information about our peer. */
1455 struct {
1456 /* rwnd
1457 *
1458 * Peer Rwnd : Current calculated value of the peer's rwnd.
1459 */
1460 __u32 rwnd;
1461
1462 /* transport_addr_list
1463 *
1464 * Peer : A list of SCTP transport addresses that the
1465 * Transport : peer is bound to. This information is derived
1466 * Address : from the INIT or INIT ACK and is used to
1467 * List : associate an inbound packet with a given
1468 * : association. Normally this information is
1469 * : hashed or keyed for quick lookup and access
1470 * : of the TCB.
Frank Filz3f7a87d2005-06-20 13:14:57 -07001471 * : The list is also initialized with the list
1472 * : of addresses passed with the sctp_connectx()
1473 * : call.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474 *
1475 * It is a list of SCTP_transport's.
1476 */
1477 struct list_head transport_addr_list;
1478
Frank Filz3f7a87d2005-06-20 13:14:57 -07001479 /* transport_count
1480 *
1481 * Peer : A count of the number of peer addresses
1482 * Transport : in the Peer Transport Address List.
1483 * Address :
1484 * Count :
1485 */
1486 __u16 transport_count;
1487
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488 /* port
1489 * The transport layer port number.
1490 */
1491 __u16 port;
1492
1493 /* primary_path
1494 *
1495 * Primary : This is the current primary destination
1496 * Path : transport address of the peer endpoint. It
1497 * : may also specify a source transport address
1498 * : on this endpoint.
1499 *
1500 * All of these paths live on transport_addr_list.
1501 *
1502 * At the bakeoffs, we discovered that the intent of
1503 * primaryPath is that it only changes when the ULP
1504 * asks to have it changed. We add the activePath to
1505 * designate the connection we are currently using to
1506 * transmit new data and most control chunks.
1507 */
1508 struct sctp_transport *primary_path;
1509
1510 /* Cache the primary path address here, when we
1511 * need a an address for msg_name.
1512 */
1513 union sctp_addr primary_addr;
1514
1515 /* active_path
1516 * The path that we are currently using to
1517 * transmit new data and most control chunks.
1518 */
1519 struct sctp_transport *active_path;
1520
1521 /* retran_path
1522 *
1523 * RFC2960 6.4 Multi-homed SCTP Endpoints
1524 * ...
1525 * Furthermore, when its peer is multi-homed, an
1526 * endpoint SHOULD try to retransmit a chunk to an
1527 * active destination transport address that is
1528 * different from the last destination address to
1529 * which the DATA chunk was sent.
1530 */
1531 struct sctp_transport *retran_path;
1532
1533 /* Pointer to last transport I have sent on. */
1534 struct sctp_transport *last_sent_to;
1535
1536 /* This is the last transport I have received DATA on. */
1537 struct sctp_transport *last_data_from;
1538
1539 /*
1540 * Mapping An array of bits or bytes indicating which out of
1541 * Array order TSN's have been received (relative to the
1542 * Last Rcvd TSN). If no gaps exist, i.e. no out of
1543 * order packets have been received, this array
1544 * will be set to all zero. This structure may be
1545 * in the form of a circular buffer or bit array.
1546 *
1547 * Last Rcvd : This is the last TSN received in
1548 * TSN : sequence. This value is set initially by
1549 * : taking the peer's Initial TSN, received in
1550 * : the INIT or INIT ACK chunk, and subtracting
1551 * : one from it.
1552 *
1553 * Throughout most of the specification this is called the
1554 * "Cumulative TSN ACK Point". In this case, we
1555 * ignore the advice in 12.2 in favour of the term
1556 * used in the bulk of the text. This value is hidden
1557 * in tsn_map--we get it by calling sctp_tsnmap_get_ctsn().
1558 */
1559 struct sctp_tsnmap tsn_map;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560
1561 /* Ack State : This flag indicates if the next received
1562 * : packet is to be responded to with a
1563 * : SACK. This is initializedto 0. When a packet
1564 * : is received it is incremented. If this value
1565 * : reaches 2 or more, a SACK is sent and the
1566 * : value is reset to 0. Note: This is used only
1567 * : when no DATA chunks are received out of
1568 * : order. When DATA chunks are out of order,
1569 * : SACK's are not delayed (see Section 6).
1570 */
1571 __u8 sack_needed; /* Do we need to sack the peer? */
Wei Yongjund364d922008-05-09 15:13:26 -07001572 __u32 sack_cnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573
1574 /* These are capabilities which our peer advertised. */
Wei Yongjun9237ccb2009-09-04 14:33:19 +08001575 __u8 ecn_capable:1, /* Can peer do ECN? */
1576 ipv4_address:1, /* Peer understands IPv4 addresses? */
1577 ipv6_address:1, /* Peer understands IPv6 addresses? */
1578 hostname_address:1, /* Peer understands DNS addresses? */
1579 asconf_capable:1, /* Does peer support ADDIP? */
1580 prsctp_capable:1, /* Can peer do PR-SCTP? */
1581 auth_capable:1; /* Is peer doing SCTP-AUTH? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582
Ivan Skytte Jorgensen0f3fffd2006-12-20 16:07:04 -08001583 __u32 adaptation_ind; /* Adaptation Code point. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584
1585 /* This mask is used to disable sending the ASCONF chunk
1586 * with specified parameter to peer.
1587 */
Al Virodbc16db2006-11-20 17:01:42 -08001588 __be16 addip_disabled_mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589
Al Viroe1857ea2006-11-20 17:25:32 -08001590 struct sctp_inithdr_host i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591 int cookie_len;
1592 void *cookie;
1593
1594 /* ADDIP Section 4.2 Upon reception of an ASCONF Chunk.
1595 * C1) ... "Peer-Serial-Number'. This value MUST be initialized to the
1596 * Initial TSN Value minus 1
1597 */
1598 __u32 addip_serial;
Vlad Yasevich1f485642007-10-09 01:15:59 -07001599
1600 /* SCTP-AUTH: We need to know pears random number, hmac list
1601 * and authenticated chunk list. All that is part of the
1602 * cookie and these are just pointers to those locations
1603 */
1604 sctp_random_param_t *peer_random;
1605 sctp_chunks_param_t *peer_chunks;
1606 sctp_hmac_algo_param_t *peer_hmacs;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607 } peer;
1608
1609 /* State : A state variable indicating what state the
1610 * : association is in, i.e. COOKIE-WAIT,
1611 * : COOKIE-ECHOED, ESTABLISHED, SHUTDOWN-PENDING,
1612 * : SHUTDOWN-SENT, SHUTDOWN-RECEIVED, SHUTDOWN-ACK-SENT.
1613 *
1614 * Note: No "CLOSED" state is illustrated since if a
1615 * association is "CLOSED" its TCB SHOULD be removed.
1616 *
1617 * In this implementation we DO have a CLOSED
1618 * state which is used during initiation and shutdown.
1619 *
1620 * State takes values from SCTP_STATE_*.
1621 */
1622 sctp_state_t state;
1623
1624 /* The cookie life I award for any cookie. */
1625 struct timeval cookie_life;
1626
1627 /* Overall : The overall association error count.
1628 * Error Count : [Clear this any time I get something.]
1629 */
1630 int overall_error_count;
1631
1632 /* These are the association's initial, max, and min RTO values.
1633 * These values will be initialized by system defaults, but can
1634 * be modified via the SCTP_RTOINFO socket option.
1635 */
Vlad Yasevich8116ffa2006-01-17 11:55:17 -08001636 unsigned long rto_initial;
1637 unsigned long rto_max;
1638 unsigned long rto_min;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001639
1640 /* Maximum number of new data packets that can be sent in a burst. */
1641 int max_burst;
1642
1643 /* This is the max_retrans value for the association. This value will
1644 * be initialized initialized from system defaults, but can be
1645 * modified by the SCTP_ASSOCINFO socket option.
1646 */
1647 int max_retrans;
1648
1649 /* Maximum number of times the endpoint will retransmit INIT */
1650 __u16 max_init_attempts;
1651
1652 /* How many times have we resent an INIT? */
1653 __u16 init_retries;
1654
1655 /* The largest timeout or RTO value to use in attempting an INIT */
Vlad Yasevich8116ffa2006-01-17 11:55:17 -08001656 unsigned long max_init_timeo;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657
Frank Filz52ccb8e2005-12-22 11:36:46 -08001658 /* Heartbeat interval: The endpoint sends out a Heartbeat chunk to
1659 * the destination address every heartbeat interval. This value
1660 * will be inherited by all new transports.
1661 */
Vlad Yasevich8116ffa2006-01-17 11:55:17 -08001662 unsigned long hbinterval;
Frank Filz52ccb8e2005-12-22 11:36:46 -08001663
1664 /* This is the max_retrans value for new transports in the
1665 * association.
1666 */
1667 __u16 pathmaxrxt;
1668
Vlad Yasevich8a479492007-06-07 14:21:05 -04001669 /* Flag that path mtu update is pending */
1670 __u8 pmtu_pending;
1671
Frank Filz52ccb8e2005-12-22 11:36:46 -08001672 /* Association : The smallest PMTU discovered for all of the
1673 * PMTU : peer's transport addresses.
1674 */
1675 __u32 pathmtu;
1676
Joe Perchesf4ab2f722007-12-20 13:56:32 -08001677 /* Flags controlling Heartbeat, SACK delay, and Path MTU Discovery. */
Frank Filz52ccb8e2005-12-22 11:36:46 -08001678 __u32 param_flags;
1679
Vlad Yasevich8116ffa2006-01-17 11:55:17 -08001680 /* SACK delay timeout */
1681 unsigned long sackdelay;
Wei Yongjund364d922008-05-09 15:13:26 -07001682 __u32 sackfreq;
Vlad Yasevich8116ffa2006-01-17 11:55:17 -08001683
1684
1685 unsigned long timeouts[SCTP_NUM_TIMEOUT_TYPES];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686 struct timer_list timers[SCTP_NUM_TIMEOUT_TYPES];
1687
1688 /* Transport to which SHUTDOWN chunk was last sent. */
1689 struct sctp_transport *shutdown_last_sent_to;
1690
Neil Horman58fbbed2008-02-29 11:40:56 -08001691 /* How many times have we resent a SHUTDOWN */
1692 int shutdown_retries;
1693
Frank Filz3f7a87d2005-06-20 13:14:57 -07001694 /* Transport to which INIT chunk was last sent. */
1695 struct sctp_transport *init_last_sent_to;
1696
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697 /* Next TSN : The next TSN number to be assigned to a new
1698 * : DATA chunk. This is sent in the INIT or INIT
1699 * : ACK chunk to the peer and incremented each
1700 * : time a DATA chunk is assigned a TSN
1701 * : (normally just prior to transmit or during
1702 * : fragmentation).
1703 */
1704 __u32 next_tsn;
1705
1706 /*
1707 * Last Rcvd : This is the last TSN received in sequence. This value
1708 * TSN : is set initially by taking the peer's Initial TSN,
1709 * : received in the INIT or INIT ACK chunk, and
1710 * : subtracting one from it.
1711 *
1712 * Most of RFC 2960 refers to this as the Cumulative TSN Ack Point.
1713 */
1714
1715 __u32 ctsn_ack_point;
1716
1717 /* PR-SCTP Advanced.Peer.Ack.Point */
1718 __u32 adv_peer_ack_point;
1719
1720 /* Highest TSN that is acknowledged by incoming SACKs. */
1721 __u32 highest_sacked;
1722
1723 /* The number of unacknowledged data chunks. Reported through
1724 * the SCTP_STATUS sockopt.
1725 */
1726 __u16 unack_data;
1727
Neil Horman58fbbed2008-02-29 11:40:56 -08001728 /* The total number of data chunks that we've had to retransmit
1729 * as the result of a T3 timer expiration
1730 */
1731 __u32 rtx_data_chunks;
1732
Linus Torvalds1da177e2005-04-16 15:20:36 -07001733 /* This is the association's receive buffer space. This value is used
1734 * to set a_rwnd field in an INIT or a SACK chunk.
1735 */
1736 __u32 rwnd;
1737
1738 /* This is the last advertised value of rwnd over a SACK chunk. */
1739 __u32 a_rwnd;
1740
1741 /* Number of bytes by which the rwnd has slopped. The rwnd is allowed
1742 * to slop over a maximum of the association's frag_point.
1743 */
1744 __u32 rwnd_over;
1745
Vlad Yasevich4d3c46e2009-09-04 18:20:59 -04001746 /* Keeps treack of rwnd pressure. This happens when we have
1747 * a window, but not recevie buffer (i.e small packets). This one
1748 * is releases slowly (1 PMTU at a time ).
1749 */
1750 __u32 rwnd_press;
1751
Linus Torvalds1da177e2005-04-16 15:20:36 -07001752 /* This is the sndbuf size in use for the association.
1753 * This corresponds to the sndbuf size for the association,
1754 * as specified in the sk->sndbuf.
1755 */
1756 int sndbuf_used;
1757
Neil Horman049b3ff2005-11-11 16:08:24 -08001758 /* This is the amount of memory that this association has allocated
1759 * in the receive path at any given time.
1760 */
1761 atomic_t rmem_alloc;
1762
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763 /* This is the wait queue head for send requests waiting on
1764 * the association sndbuf space.
1765 */
1766 wait_queue_head_t wait;
1767
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768 /* The message size at which SCTP fragmentation will occur. */
1769 __u32 frag_point;
Vlad Yasevichf68b2e02009-09-04 18:21:00 -04001770 __u32 user_frag;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771
Frank Filz3f7a87d2005-06-20 13:14:57 -07001772 /* Counter used to count INIT errors. */
1773 int init_err_counter;
1774
1775 /* Count the number of INIT cycles (for doubling timeout). */
1776 int init_cycle;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777
1778 /* Default send parameters. */
1779 __u16 default_stream;
1780 __u16 default_flags;
1781 __u32 default_ppid;
1782 __u32 default_context;
1783 __u32 default_timetolive;
1784
Ivan Skytte Jorgensen6ab792f2006-12-13 16:34:22 -08001785 /* Default receive parameters */
1786 __u32 default_rcv_context;
1787
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788 /* This tracks outbound ssn for a given stream. */
1789 struct sctp_ssnmap *ssnmap;
1790
1791 /* All outbound chunks go through this structure. */
1792 struct sctp_outq outqueue;
1793
1794 /* A smart pipe that will handle reordering and fragmentation,
1795 * as well as handle passing events up to the ULP.
1796 */
1797 struct sctp_ulpq ulpq;
1798
1799 /* Last TSN that caused an ECNE Chunk to be sent. */
1800 __u32 last_ecne_tsn;
1801
1802 /* Last TSN that caused a CWR Chunk to be sent. */
1803 __u32 last_cwr_tsn;
1804
1805 /* How many duplicated TSNs have we seen? */
1806 int numduptsns;
1807
Vlad Yasevich8116ffa2006-01-17 11:55:17 -08001808 /* Number of seconds of idle time before an association is closed.
1809 * In the association context, this is really used as a boolean
1810 * since the real timeout is stored in the timeouts array
1811 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812 __u32 autoclose;
1813
1814 /* These are to support
1815 * "SCTP Extensions for Dynamic Reconfiguration of IP Addresses
1816 * and Enforcement of Flow and Message Limits"
1817 * <draft-ietf-tsvwg-addip-sctp-02.txt>
1818 * or "ADDIP" for short.
1819 */
1820
1821
1822
1823 /* ADDIP Section 4.1.1 Congestion Control of ASCONF Chunks
1824 *
1825 * R1) One and only one ASCONF Chunk MAY be in transit and
1826 * unacknowledged at any one time. If a sender, after sending
1827 * an ASCONF chunk, decides it needs to transfer another
1828 * ASCONF Chunk, it MUST wait until the ASCONF-ACK Chunk
1829 * returns from the previous ASCONF Chunk before sending a
1830 * subsequent ASCONF. Note this restriction binds each side,
1831 * so at any time two ASCONF may be in-transit on any given
1832 * association (one sent from each endpoint).
1833 *
1834 * [This is our one-and-only-one ASCONF in flight. If we do
1835 * not have an ASCONF in flight, this is NULL.]
1836 */
1837 struct sctp_chunk *addip_last_asconf;
1838
Vlad Yasevicha08de642007-12-20 14:11:47 -08001839 /* ADDIP Section 5.2 Upon reception of an ASCONF Chunk.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001840 *
Vlad Yasevicha08de642007-12-20 14:11:47 -08001841 * This is needed to implement itmes E1 - E4 of the updated
1842 * spec. Here is the justification:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001843 *
Vlad Yasevicha08de642007-12-20 14:11:47 -08001844 * Since the peer may bundle multiple ASCONF chunks toward us,
1845 * we now need the ability to cache multiple ACKs. The section
1846 * describes in detail how they are cached and cleaned up.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001847 */
Vlad Yasevicha08de642007-12-20 14:11:47 -08001848 struct list_head asconf_ack_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001849
1850 /* These ASCONF chunks are waiting to be sent.
1851 *
1852 * These chunaks can't be pushed to outqueue until receiving
1853 * ASCONF_ACK for the previous ASCONF indicated by
1854 * addip_last_asconf, so as to guarantee that only one ASCONF
1855 * is in flight at any time.
1856 *
1857 * ADDIP Section 4.1.1 Congestion Control of ASCONF Chunks
1858 *
1859 * In defining the ASCONF Chunk transfer procedures, it is
1860 * essential that these transfers MUST NOT cause congestion
1861 * within the network. To achieve this, we place these
1862 * restrictions on the transfer of ASCONF Chunks:
1863 *
1864 * R1) One and only one ASCONF Chunk MAY be in transit and
1865 * unacknowledged at any one time. If a sender, after sending
1866 * an ASCONF chunk, decides it needs to transfer another
1867 * ASCONF Chunk, it MUST wait until the ASCONF-ACK Chunk
1868 * returns from the previous ASCONF Chunk before sending a
1869 * subsequent ASCONF. Note this restriction binds each side,
1870 * so at any time two ASCONF may be in-transit on any given
1871 * association (one sent from each endpoint).
1872 *
1873 *
1874 * [I really think this is EXACTLY the sort of intelligence
1875 * which already resides in sctp_outq. Please move this
1876 * queue and its supporting logic down there. --piggy]
1877 */
David S. Miller79af02c2005-07-08 21:47:49 -07001878 struct list_head addip_chunk_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001879
1880 /* ADDIP Section 4.1 ASCONF Chunk Procedures
1881 *
1882 * A2) A serial number should be assigned to the Chunk. The
1883 * serial number SHOULD be a monotonically increasing
1884 * number. The serial number SHOULD be initialized at
1885 * the start of the association to the same value as the
1886 * Initial TSN and every time a new ASCONF chunk is created
1887 * it is incremented by one after assigning the serial number
1888 * to the newly created chunk.
1889 *
1890 * ADDIP
1891 * 3.1.1 Address/Stream Configuration Change Chunk (ASCONF)
1892 *
1893 * Serial Number : 32 bits (unsigned integer)
1894 *
1895 * This value represents a Serial Number for the ASCONF
1896 * Chunk. The valid range of Serial Number is from 0 to
1897 * 4294967295 (2^32 - 1). Serial Numbers wrap back to 0
1898 * after reaching 4294967295.
1899 */
1900 __u32 addip_serial;
1901
Vlad Yasevich1f485642007-10-09 01:15:59 -07001902 /* SCTP AUTH: list of the endpoint shared keys. These
1903 * keys are provided out of band by the user applicaton
1904 * and can't change during the lifetime of the association
1905 */
1906 struct list_head endpoint_shared_keys;
1907
1908 /* SCTP AUTH:
1909 * The current generated assocaition shared key (secret)
1910 */
1911 struct sctp_auth_bytes *asoc_shared_key;
1912
1913 /* SCTP AUTH: hmac id of the first peer requested algorithm
1914 * that we support.
1915 */
1916 __u16 default_hmac_id;
1917
1918 __u16 active_key_id;
1919
Wei Yongjun9237ccb2009-09-04 14:33:19 +08001920 __u8 need_ecne:1, /* Need to send an ECNE Chunk? */
1921 temp:1; /* Is it a temporary association? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001922};
1923
1924
1925/* An eyecatcher for determining if we are really looking at an
1926 * association data structure.
1927 */
1928enum {
1929 SCTP_ASSOC_EYECATCHER = 0xa550c123,
1930};
1931
1932/* Recover the outter association structure. */
1933static inline struct sctp_association *sctp_assoc(struct sctp_ep_common *base)
1934{
1935 struct sctp_association *asoc;
1936
1937 asoc = container_of(base, struct sctp_association, base);
1938 return asoc;
1939}
1940
1941/* These are function signatures for manipulating associations. */
1942
1943
1944struct sctp_association *
1945sctp_association_new(const struct sctp_endpoint *, const struct sock *,
Al Virodd0fc662005-10-07 07:46:04 +01001946 sctp_scope_t scope, gfp_t gfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947void sctp_association_free(struct sctp_association *);
1948void sctp_association_put(struct sctp_association *);
1949void sctp_association_hold(struct sctp_association *);
1950
Wei Yongjun9919b452009-05-12 21:52:51 +08001951struct sctp_transport *sctp_assoc_choose_alter_transport(
1952 struct sctp_association *, struct sctp_transport *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953void sctp_assoc_update_retran_path(struct sctp_association *);
1954struct sctp_transport *sctp_assoc_lookup_paddr(const struct sctp_association *,
1955 const union sctp_addr *);
1956int sctp_assoc_lookup_laddr(struct sctp_association *asoc,
1957 const union sctp_addr *laddr);
1958struct sctp_transport *sctp_assoc_add_peer(struct sctp_association *,
1959 const union sctp_addr *address,
Al Virodd0fc662005-10-07 07:46:04 +01001960 const gfp_t gfp,
Frank Filz3f7a87d2005-06-20 13:14:57 -07001961 const int peer_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001962void sctp_assoc_del_peer(struct sctp_association *asoc,
1963 const union sctp_addr *addr);
Frank Filz3f7a87d2005-06-20 13:14:57 -07001964void sctp_assoc_rm_peer(struct sctp_association *asoc,
1965 struct sctp_transport *peer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001966void sctp_assoc_control_transport(struct sctp_association *,
1967 struct sctp_transport *,
1968 sctp_transport_cmd_t, sctp_sn_error_t);
1969struct sctp_transport *sctp_assoc_lookup_tsn(struct sctp_association *, __u32);
1970struct sctp_transport *sctp_assoc_is_match(struct sctp_association *,
1971 const union sctp_addr *,
1972 const union sctp_addr *);
1973void sctp_assoc_migrate(struct sctp_association *, struct sock *);
1974void sctp_assoc_update(struct sctp_association *old,
1975 struct sctp_association *new);
1976
1977__u32 sctp_association_get_next_tsn(struct sctp_association *);
1978
1979void sctp_assoc_sync_pmtu(struct sctp_association *);
1980void sctp_assoc_rwnd_increase(struct sctp_association *, unsigned);
1981void sctp_assoc_rwnd_decrease(struct sctp_association *, unsigned);
1982void sctp_assoc_set_primary(struct sctp_association *,
1983 struct sctp_transport *);
Vlad Yasevich42e30bf2007-12-20 14:08:56 -08001984void sctp_assoc_del_nonprimary_peers(struct sctp_association *,
1985 struct sctp_transport *);
Alexey Dobriyan3182cd82005-07-11 20:57:47 -07001986int sctp_assoc_set_bind_addr_from_ep(struct sctp_association *,
Vlad Yasevich409b95a2009-11-10 08:57:34 +00001987 sctp_scope_t, gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001988int sctp_assoc_set_bind_addr_from_cookie(struct sctp_association *,
Alexey Dobriyan3182cd82005-07-11 20:57:47 -07001989 struct sctp_cookie*,
Al Virodd0fc662005-10-07 07:46:04 +01001990 gfp_t gfp);
Vlad Yasevich07d93962007-05-04 13:55:27 -07001991int sctp_assoc_set_id(struct sctp_association *, gfp_t);
Vlad Yasevicha08de642007-12-20 14:11:47 -08001992void sctp_assoc_clean_asconf_ack_cache(const struct sctp_association *asoc);
1993struct sctp_chunk *sctp_assoc_lookup_asconf_ack(
1994 const struct sctp_association *asoc,
1995 __be32 serial);
1996
Linus Torvalds1da177e2005-04-16 15:20:36 -07001997
1998int sctp_cmp_addr_exact(const union sctp_addr *ss1,
1999 const union sctp_addr *ss2);
2000struct sctp_chunk *sctp_get_ecne_prepend(struct sctp_association *asoc);
2001
2002/* A convenience structure to parse out SCTP specific CMSGs. */
2003typedef struct sctp_cmsgs {
2004 struct sctp_initmsg *init;
2005 struct sctp_sndrcvinfo *info;
2006} sctp_cmsgs_t;
2007
2008/* Structure for tracking memory objects */
2009typedef struct {
2010 char *label;
2011 atomic_t *counter;
2012} sctp_dbg_objcnt_entry_t;
2013
2014#endif /* __sctp_structs_h__ */