blob: 9f70d54fcefcb8b823e50d59238b1ab8ae1ae7a3 [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
222 /* Flag to indicate whether computing and verifying checksum
223 * is disabled. */
224 int checksum_disable;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225} sctp_globals;
226
227#define sctp_rto_initial (sctp_globals.rto_initial)
228#define sctp_rto_min (sctp_globals.rto_min)
229#define sctp_rto_max (sctp_globals.rto_max)
230#define sctp_rto_alpha (sctp_globals.rto_alpha)
231#define sctp_rto_beta (sctp_globals.rto_beta)
232#define sctp_max_burst (sctp_globals.max_burst)
233#define sctp_valid_cookie_life (sctp_globals.valid_cookie_life)
234#define sctp_cookie_preserve_enable (sctp_globals.cookie_preserve_enable)
235#define sctp_max_retrans_association (sctp_globals.max_retrans_association)
Neil Horman4eb701d2005-04-28 12:02:04 -0700236#define sctp_sndbuf_policy (sctp_globals.sndbuf_policy)
Neil Horman049b3ff2005-11-11 16:08:24 -0800237#define sctp_rcvbuf_policy (sctp_globals.rcvbuf_policy)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238#define sctp_max_retrans_path (sctp_globals.max_retrans_path)
239#define sctp_max_retrans_init (sctp_globals.max_retrans_init)
Vlad Yasevich2f85a422005-06-28 13:24:23 -0700240#define sctp_sack_timeout (sctp_globals.sack_timeout)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241#define sctp_hb_interval (sctp_globals.hb_interval)
242#define sctp_max_instreams (sctp_globals.max_instreams)
243#define sctp_max_outstreams (sctp_globals.max_outstreams)
244#define sctp_address_families (sctp_globals.address_families)
245#define sctp_ep_hashsize (sctp_globals.ep_hashsize)
246#define sctp_ep_hashtable (sctp_globals.ep_hashtable)
247#define sctp_assoc_hashsize (sctp_globals.assoc_hashsize)
248#define sctp_assoc_hashtable (sctp_globals.assoc_hashtable)
249#define sctp_port_hashsize (sctp_globals.port_hashsize)
250#define sctp_port_rover (sctp_globals.port_rover)
251#define sctp_port_alloc_lock (sctp_globals.port_alloc_lock)
252#define sctp_port_hashtable (sctp_globals.port_hashtable)
253#define sctp_local_addr_list (sctp_globals.local_addr_list)
Vlad Yasevich29303542007-09-16 16:02:12 -0700254#define sctp_local_addr_lock (sctp_globals.addr_list_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255#define sctp_addip_enable (sctp_globals.addip_enable)
Vlad Yasevich73d9c4f2007-10-24 17:24:26 -0400256#define sctp_addip_noauth (sctp_globals.addip_noauth_enable)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257#define sctp_prsctp_enable (sctp_globals.prsctp_enable)
Vlad Yasevich1f485642007-10-09 01:15:59 -0700258#define sctp_auth_enable (sctp_globals.auth_enable)
Lucas Nussbaum06e86802009-02-13 08:33:41 +0000259#define sctp_checksum_disable (sctp_globals.checksum_disable)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260
261/* SCTP Socket type: UDP or TCP style. */
262typedef enum {
263 SCTP_SOCKET_UDP = 0,
264 SCTP_SOCKET_UDP_HIGH_BANDWIDTH,
265 SCTP_SOCKET_TCP
266} sctp_socket_type_t;
267
268/* Per socket SCTP information. */
269struct sctp_sock {
270 /* inet_sock has to be the first member of sctp_sock */
271 struct inet_sock inet;
272 /* What kind of a socket is this? */
273 sctp_socket_type_t type;
274
275 /* PF_ family specific functions. */
276 struct sctp_pf *pf;
277
278 /* Access to HMAC transform. */
Herbert Xu1b489e12006-08-20 15:07:14 +1000279 struct crypto_hash *hmac;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280
281 /* What is our base endpointer? */
282 struct sctp_endpoint *ep;
283
284 struct sctp_bind_bucket *bind_hash;
285 /* Various Socket Options. */
286 __u16 default_stream;
287 __u32 default_ppid;
288 __u16 default_flags;
289 __u32 default_context;
290 __u32 default_timetolive;
Ivan Skytte Jorgensen6ab792f2006-12-13 16:34:22 -0800291 __u32 default_rcv_context;
Vlad Yasevich70331572007-03-23 11:34:36 -0700292 int max_burst;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293
Frank Filz52ccb8e2005-12-22 11:36:46 -0800294 /* Heartbeat interval: The endpoint sends out a Heartbeat chunk to
295 * the destination address every heartbeat interval. This value
296 * will be inherited by all new associations.
297 */
298 __u32 hbinterval;
299
300 /* This is the max_retrans value for new associations. */
301 __u16 pathmaxrxt;
302
303 /* The initial Path MTU to use for new associations. */
304 __u32 pathmtu;
305
306 /* The default SACK delay timeout for new associations. */
307 __u32 sackdelay;
Wei Yongjund364d922008-05-09 15:13:26 -0700308 __u32 sackfreq;
Frank Filz52ccb8e2005-12-22 11:36:46 -0800309
Joe Perchesf4ab2f722007-12-20 13:56:32 -0800310 /* Flags controlling Heartbeat, SACK delay, and Path MTU Discovery. */
Frank Filz52ccb8e2005-12-22 11:36:46 -0800311 __u32 param_flags;
312
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313 struct sctp_initmsg initmsg;
314 struct sctp_rtoinfo rtoinfo;
315 struct sctp_paddrparams paddrparam;
316 struct sctp_event_subscribe subscribe;
317 struct sctp_assocparams assocparams;
318 int user_frag;
319 __u32 autoclose;
320 __u8 nodelay;
321 __u8 disable_fragments;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 __u8 v4mapped;
Vlad Yasevichb6e13312007-04-20 12:23:15 -0700323 __u8 frag_interleave;
Ivan Skytte Jorgensen0f3fffd2006-12-20 16:07:04 -0800324 __u32 adaptation_ind;
Vlad Yasevichd49d91d2007-03-23 11:32:00 -0700325 __u32 pd_point;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326
Vlad Yasevichb6e13312007-04-20 12:23:15 -0700327 atomic_t pd_mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 /* Receive to here while partial delivery is in effect. */
329 struct sk_buff_head pd_lobby;
330};
331
332static inline struct sctp_sock *sctp_sk(const struct sock *sk)
333{
334 return (struct sctp_sock *)sk;
335}
336
337static inline struct sock *sctp_opt2sk(const struct sctp_sock *sp)
338{
339 return (struct sock *)sp;
340}
341
342#if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
343struct sctp6_sock {
344 struct sctp_sock sctp;
345 struct ipv6_pinfo inet6;
346};
347#endif /* CONFIG_IPV6 */
348
349
350/* This is our APPLICATION-SPECIFIC state cookie.
351 * THIS IS NOT DICTATED BY THE SPECIFICATION.
352 */
353/* These are the parts of an association which we send in the cookie.
354 * Most of these are straight out of:
355 * RFC2960 12.2 Parameters necessary per association (i.e. the TCB)
356 *
357 */
358
359struct sctp_cookie {
360
361 /* My : Tag expected in every inbound packet and sent
362 * Verification: in the INIT or INIT ACK chunk.
363 * Tag :
364 */
365 __u32 my_vtag;
366
367 /* Peer's : Tag expected in every outbound packet except
368 * Verification: in the INIT chunk.
369 * Tag :
370 */
371 __u32 peer_vtag;
372
373 /* The rest of these are not from the spec, but really need to
374 * be in the cookie.
375 */
376
377 /* My Tie Tag : Assist in discovering a restarting association. */
378 __u32 my_ttag;
379
380 /* Peer's Tie Tag: Assist in discovering a restarting association. */
381 __u32 peer_ttag;
382
383 /* When does this cookie expire? */
384 struct timeval expiration;
385
386 /* Number of inbound/outbound streams which are set
387 * and negotiated during the INIT process.
388 */
389 __u16 sinit_num_ostreams;
390 __u16 sinit_max_instreams;
391
392 /* This is the first sequence number I used. */
393 __u32 initial_tsn;
394
395 /* This holds the originating address of the INIT packet. */
396 union sctp_addr peer_addr;
397
398 /* IG Section 2.35.3
399 * Include the source port of the INIT-ACK
400 */
401 __u16 my_port;
402
403 __u8 prsctp_capable;
404
405 /* Padding for future use */
406 __u8 padding;
407
Ivan Skytte Jorgensen0f3fffd2006-12-20 16:07:04 -0800408 __u32 adaptation_ind;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409
Vlad Yasevich1f485642007-10-09 01:15:59 -0700410 __u8 auth_random[sizeof(sctp_paramhdr_t) + SCTP_AUTH_RANDOM_LENGTH];
411 __u8 auth_hmacs[SCTP_AUTH_NUM_HMACS + 2];
412 __u8 auth_chunks[sizeof(sctp_paramhdr_t) + SCTP_AUTH_MAX_CHUNKS];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413
414 /* This is a shim for my peer's INIT packet, followed by
415 * a copy of the raw address list of the association.
416 * The length of the raw address list is saved in the
417 * raw_addr_list_len field, which will be used at the time when
418 * the association TCB is re-constructed from the cookie.
419 */
420 __u32 raw_addr_list_len;
421 struct sctp_init_chunk peer_init[0];
422};
423
424
425/* The format of our cookie that we send to our peer. */
426struct sctp_signed_cookie {
427 __u8 signature[SCTP_SECRET_SIZE];
Vlad Yasevich9834a2b2006-01-17 11:52:12 -0800428 __u32 __pad; /* force sctp_cookie alignment to 64 bits */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 struct sctp_cookie c;
Vlad Yasevich9834a2b2006-01-17 11:52:12 -0800430} __attribute__((packed));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431
432/* This is another convenience type to allocate memory for address
433 * params for the maximum size and pass such structures around
434 * internally.
435 */
436union sctp_addr_param {
Wei Yongjun6f4c6182007-09-19 17:19:52 +0800437 struct sctp_paramhdr p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 struct sctp_ipv4addr_param v4;
439 struct sctp_ipv6addr_param v6;
440};
441
442/* A convenience type to allow walking through the various
443 * parameters and avoid casting all over the place.
444 */
445union sctp_params {
446 void *v;
447 struct sctp_paramhdr *p;
448 struct sctp_cookie_preserve_param *life;
449 struct sctp_hostname_param *dns;
450 struct sctp_cookie_param *cookie;
451 struct sctp_supported_addrs_param *sat;
452 struct sctp_ipv4addr_param *v4;
453 struct sctp_ipv6addr_param *v6;
454 union sctp_addr_param *addr;
Ivan Skytte Jorgensen0f3fffd2006-12-20 16:07:04 -0800455 struct sctp_adaptation_ind_param *aind;
Vlad Yasevich131a47e2007-09-16 15:53:56 -0700456 struct sctp_supported_ext_param *ext;
Vlad Yasevich1f485642007-10-09 01:15:59 -0700457 struct sctp_random_param *random;
458 struct sctp_chunks_param *chunks;
459 struct sctp_hmac_algo_param *hmac_algo;
Vlad Yasevichd6de3092007-12-20 14:10:00 -0800460 struct sctp_addip_param *addip;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461};
462
463/* RFC 2960. Section 3.3.5 Heartbeat.
464 * Heartbeat Information: variable length
465 * The Sender-specific Heartbeat Info field should normally include
466 * information about the sender's current time when this HEARTBEAT
467 * chunk is sent and the destination transport address to which this
468 * HEARTBEAT is sent (see Section 8.3).
469 */
470typedef struct sctp_sender_hb_info {
471 struct sctp_paramhdr param_hdr;
472 union sctp_addr daddr;
473 unsigned long sent_at;
Sridhar Samudralaad8fec12006-07-21 14:48:50 -0700474 __u64 hb_nonce;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475} __attribute__((packed)) sctp_sender_hb_info_t;
476
477/*
478 * RFC 2960 1.3.2 Sequenced Delivery within Streams
479 *
480 * The term "stream" is used in SCTP to refer to a sequence of user
481 * messages that are to be delivered to the upper-layer protocol in
482 * order with respect to other messages within the same stream. This is
483 * in contrast to its usage in TCP, where it refers to a sequence of
484 * bytes (in this document a byte is assumed to be eight bits).
485 * ...
486 *
487 * This is the structure we use to track both our outbound and inbound
488 * SSN, or Stream Sequence Numbers.
489 */
490
491struct sctp_stream {
492 __u16 *ssn;
493 unsigned int len;
494};
495
496struct sctp_ssnmap {
497 struct sctp_stream in;
498 struct sctp_stream out;
499 int malloced;
500};
501
Alexey Dobriyan3182cd82005-07-11 20:57:47 -0700502struct sctp_ssnmap *sctp_ssnmap_new(__u16 in, __u16 out,
Al Virodd0fc662005-10-07 07:46:04 +0100503 gfp_t gfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504void sctp_ssnmap_free(struct sctp_ssnmap *map);
505void sctp_ssnmap_clear(struct sctp_ssnmap *map);
506
507/* What is the current SSN number for this stream? */
508static inline __u16 sctp_ssn_peek(struct sctp_stream *stream, __u16 id)
509{
510 return stream->ssn[id];
511}
512
513/* Return the next SSN number for this stream. */
514static inline __u16 sctp_ssn_next(struct sctp_stream *stream, __u16 id)
515{
516 return stream->ssn[id]++;
517}
518
519/* Skip over this ssn and all below. */
520static inline void sctp_ssn_skip(struct sctp_stream *stream, __u16 id,
521 __u16 ssn)
522{
523 stream->ssn[id] = ssn+1;
524}
525
526/*
527 * Pointers to address related SCTP functions.
528 * (i.e. things that depend on the address family.)
529 */
530struct sctp_af {
531 int (*sctp_xmit) (struct sk_buff *skb,
Herbert Xuf8803742008-08-03 21:15:08 -0700532 struct sctp_transport *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 int (*setsockopt) (struct sock *sk,
534 int level,
535 int optname,
536 char __user *optval,
537 int optlen);
538 int (*getsockopt) (struct sock *sk,
539 int level,
540 int optname,
541 char __user *optval,
542 int __user *optlen);
Dmitry Mishin3fdadf72006-03-20 22:45:21 -0800543 int (*compat_setsockopt) (struct sock *sk,
544 int level,
545 int optname,
546 char __user *optval,
547 int optlen);
548 int (*compat_getsockopt) (struct sock *sk,
549 int level,
550 int optname,
551 char __user *optval,
552 int __user *optlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 struct dst_entry *(*get_dst) (struct sctp_association *asoc,
554 union sctp_addr *daddr,
555 union sctp_addr *saddr);
YOSHIFUJI Hideakie5117102008-05-29 19:55:05 +0900556 void (*get_saddr) (struct sctp_sock *sk,
557 struct sctp_association *asoc,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558 struct dst_entry *dst,
559 union sctp_addr *daddr,
560 union sctp_addr *saddr);
561 void (*copy_addrlist) (struct list_head *,
562 struct net_device *);
563 void (*dst_saddr) (union sctp_addr *saddr,
564 struct dst_entry *dst,
Al Viro854d43a2006-11-20 17:06:24 -0800565 __be16 port);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 int (*cmp_addr) (const union sctp_addr *addr1,
567 const union sctp_addr *addr2);
568 void (*addr_copy) (union sctp_addr *dst,
569 union sctp_addr *src);
570 void (*from_skb) (union sctp_addr *,
571 struct sk_buff *skb,
572 int saddr);
573 void (*from_sk) (union sctp_addr *,
574 struct sock *sk);
575 void (*to_sk_saddr) (union sctp_addr *,
576 struct sock *sk);
577 void (*to_sk_daddr) (union sctp_addr *,
578 struct sock *sk);
579 void (*from_addr_param) (union sctp_addr *,
580 union sctp_addr_param *,
Al Virodd86d132006-11-20 17:11:13 -0800581 __be16 port, int iif);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 int (*to_addr_param) (const union sctp_addr *,
583 union sctp_addr_param *);
584 int (*addr_valid) (union sctp_addr *,
Vlad Yasevich5636bef2006-06-17 22:55:35 -0700585 struct sctp_sock *,
586 const struct sk_buff *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587 sctp_scope_t (*scope) (union sctp_addr *);
Al Viro6fbfa9f2006-11-20 17:24:53 -0800588 void (*inaddr_any) (union sctp_addr *, __be16);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 int (*is_any) (const union sctp_addr *);
590 int (*available) (union sctp_addr *,
591 struct sctp_sock *);
592 int (*skb_iif) (const struct sk_buff *sk);
593 int (*is_ce) (const struct sk_buff *sk);
594 void (*seq_dump_addr)(struct seq_file *seq,
595 union sctp_addr *addr);
Vlad Yasevichb9031d92008-06-04 12:40:15 -0700596 void (*ecn_capable)(struct sock *sk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 __u16 net_header_len;
598 int sockaddr_len;
599 sa_family_t sa_family;
600 struct list_head list;
601};
602
603struct sctp_af *sctp_get_af_specific(sa_family_t);
604int sctp_register_af(struct sctp_af *);
605
606/* Protocol family functions. */
607struct sctp_pf {
608 void (*event_msgname)(struct sctp_ulpevent *, char *, int *);
609 void (*skb_msgname) (struct sk_buff *, char *, int *);
610 int (*af_supported) (sa_family_t, struct sctp_sock *);
611 int (*cmp_addr) (const union sctp_addr *,
612 const union sctp_addr *,
613 struct sctp_sock *);
614 int (*bind_verify) (struct sctp_sock *, union sctp_addr *);
615 int (*send_verify) (struct sctp_sock *, union sctp_addr *);
Al Viro3dbe8652006-11-20 17:25:49 -0800616 int (*supported_addrs)(const struct sctp_sock *, __be16 *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 struct sock *(*create_accept_sk) (struct sock *sk,
618 struct sctp_association *asoc);
619 void (*addr_v4map) (struct sctp_sock *, union sctp_addr *);
620 struct sctp_af *af;
621};
622
623
624/* Structure to track chunk fragments that have been acked, but peer
625 * fragments of the same message have not.
626 */
627struct sctp_datamsg {
628 /* Chunks waiting to be submitted to lower layer. */
629 struct list_head chunks;
630 /* Chunks that have been transmitted. */
631 struct list_head track;
632 /* Reference counting. */
633 atomic_t refcnt;
634 /* When is this message no longer interesting to the peer? */
635 unsigned long expires_at;
636 /* Did the messenge fail to send? */
637 int send_error;
638 char send_failed;
639 /* Control whether chunks from this message can be abandoned. */
640 char can_abandon;
641};
642
643struct sctp_datamsg *sctp_datamsg_from_user(struct sctp_association *,
644 struct sctp_sndrcvinfo *,
645 struct msghdr *, int len);
646void sctp_datamsg_put(struct sctp_datamsg *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647void sctp_chunk_fail(struct sctp_chunk *, int error);
648int sctp_chunk_abandoned(struct sctp_chunk *);
649
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650/* RFC2960 1.4 Key Terms
651 *
652 * o Chunk: A unit of information within an SCTP packet, consisting of
653 * a chunk header and chunk-specific content.
654 *
655 * As a matter of convenience, we remember the SCTP common header for
656 * each chunk as well as a few other header pointers...
657 */
658struct sctp_chunk {
David S. Miller79af02c2005-07-08 21:47:49 -0700659 struct list_head list;
660
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661 atomic_t refcnt;
662
663 /* This is our link to the per-transport transmitted list. */
664 struct list_head transmitted_list;
665
666 /* This field is used by chunks that hold fragmented data.
667 * For the first fragment this is the list that holds the rest of
668 * fragments. For the remaining fragments, this is the link to the
669 * frag_list maintained in the first fragment.
670 */
671 struct list_head frag_list;
672
673 /* This points to the sk_buff containing the actual data. */
674 struct sk_buff *skb;
675
676 /* These are the SCTP headers by reverse order in a packet.
677 * Note that some of these may happen more than once. In that
678 * case, we point at the "current" one, whatever that means
679 * for that level of header.
680 */
681
682 /* We point this at the FIRST TLV parameter to chunk_hdr. */
683 union sctp_params param_hdr;
684 union {
685 __u8 *v;
686 struct sctp_datahdr *data_hdr;
687 struct sctp_inithdr *init_hdr;
688 struct sctp_sackhdr *sack_hdr;
689 struct sctp_heartbeathdr *hb_hdr;
690 struct sctp_sender_hb_info *hbs_hdr;
691 struct sctp_shutdownhdr *shutdown_hdr;
692 struct sctp_signed_cookie *cookie_hdr;
693 struct sctp_ecnehdr *ecne_hdr;
694 struct sctp_cwrhdr *ecn_cwr_hdr;
695 struct sctp_errhdr *err_hdr;
696 struct sctp_addiphdr *addip_hdr;
697 struct sctp_fwdtsn_hdr *fwdtsn_hdr;
Vlad Yasevich1f485642007-10-09 01:15:59 -0700698 struct sctp_authhdr *auth_hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 } subh;
700
701 __u8 *chunk_end;
702
703 struct sctp_chunkhdr *chunk_hdr;
704 struct sctphdr *sctp_hdr;
705
706 /* This needs to be recoverable for SCTP_SEND_FAILED events. */
707 struct sctp_sndrcvinfo sinfo;
708
709 /* Which association does this belong to? */
710 struct sctp_association *asoc;
711
712 /* What endpoint received this chunk? */
713 struct sctp_ep_common *rcvr;
714
715 /* We fill this in if we are calculating RTT. */
716 unsigned long sent_at;
717
718 /* What is the origin IP address for this chunk? */
719 union sctp_addr source;
720 /* Destination address for this chunk. */
721 union sctp_addr dest;
722
723 /* For outbound message, track all fragments for SEND_FAILED. */
724 struct sctp_datamsg *msg;
725
726 /* For an inbound chunk, this tells us where it came from.
727 * For an outbound chunk, it tells us where we'd like it to
728 * go. It is NULL if we have no preference.
729 */
730 struct sctp_transport *transport;
731
Vlad Yasevichbbd0d592007-10-03 17:51:34 -0700732 /* SCTP-AUTH: For the special case inbound processing of COOKIE-ECHO
733 * we need save a pointer to the AUTH chunk, since the SCTP-AUTH
734 * spec violates the principle premis that all chunks are processed
735 * in order.
736 */
737 struct sk_buff *auth_chunk;
738
Neil Hormanc226ef92008-07-25 12:44:09 -0400739#define SCTP_CAN_FRTX 0x0
740#define SCTP_NEED_FRTX 0x1
741#define SCTP_DONT_FRTX 0x2
742 __u16 rtt_in_progress:1, /* This chunk used for RTT calc? */
743 resent:1, /* Has this chunk ever been resent. */
744 has_tsn:1, /* Does this chunk have a TSN yet? */
745 has_ssn:1, /* Does this chunk have a SSN yet? */
746 singleton:1, /* Only chunk in the packet? */
747 end_of_packet:1, /* Last chunk in the packet? */
748 ecn_ce_done:1, /* Have we processed the ECN CE bit? */
749 pdiscard:1, /* Discard the whole packet now? */
750 tsn_gap_acked:1, /* Is this chunk acked by a GAP ACK? */
751 data_accepted:1, /* At least 1 chunk accepted */
752 auth:1, /* IN: was auth'ed | OUT: needs auth */
753 has_asconf:1, /* IN: have seen an asconf before */
754 tsn_missing_report:2, /* Data chunk missing counter. */
755 fast_retransmit:2; /* Is this chunk fast retransmitted? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756};
757
758void sctp_chunk_hold(struct sctp_chunk *);
759void sctp_chunk_put(struct sctp_chunk *);
760int sctp_user_addto_chunk(struct sctp_chunk *chunk, int off, int len,
761 struct iovec *data);
762void sctp_chunk_free(struct sctp_chunk *);
763void *sctp_addto_chunk(struct sctp_chunk *, int len, const void *data);
764struct sctp_chunk *sctp_chunkify(struct sk_buff *,
765 const struct sctp_association *,
766 struct sock *);
767void sctp_init_addrs(struct sctp_chunk *, union sctp_addr *,
768 union sctp_addr *);
769const union sctp_addr *sctp_source(const struct sctp_chunk *chunk);
770
Vlad Yasevichf57d96b2007-12-20 14:12:24 -0800771enum {
772 SCTP_ADDR_NEW, /* new address added to assoc/ep */
773 SCTP_ADDR_SRC, /* address can be used as source */
774 SCTP_ADDR_DEL, /* address about to be deleted */
775};
776
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777/* This is a structure for holding either an IPv6 or an IPv4 address. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778struct sctp_sockaddr_entry {
779 struct list_head list;
Vlad Yasevich29303542007-09-16 16:02:12 -0700780 struct rcu_head rcu;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781 union sctp_addr a;
Vlad Yasevichf57d96b2007-12-20 14:12:24 -0800782 __u8 state;
Vlad Yasevich29303542007-09-16 16:02:12 -0700783 __u8 valid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784};
785
786typedef struct sctp_chunk *(sctp_packet_phandler_t)(struct sctp_association *);
787
788/* This structure holds lists of chunks as we are assembling for
789 * transmission.
790 */
791struct sctp_packet {
792 /* These are the SCTP header values (host order) for the packet. */
793 __u16 source_port;
794 __u16 destination_port;
795 __u32 vtag;
796
797 /* This contains the payload chunks. */
David S. Miller79af02c2005-07-08 21:47:49 -0700798 struct list_head chunk_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799
800 /* This is the overhead of the sctp and ip headers. */
801 size_t overhead;
802 /* This is the total size of all chunks INCLUDING padding. */
803 size_t size;
804
805 /* The packet is destined for this transport address.
806 * The function we finally use to pass down to the next lower
807 * layer lives in the transport structure.
808 */
809 struct sctp_transport *transport;
810
Vlad Yasevich1f485642007-10-09 01:15:59 -0700811 /* pointer to the auth chunk for this packet */
812 struct sctp_chunk *auth;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813
Vlad Yasevich1f485642007-10-09 01:15:59 -0700814 /* This packet contains a COOKIE-ECHO chunk. */
815 __u8 has_cookie_echo;
816
817 /* This packet contains a SACK chunk. */
818 __u8 has_sack;
819
820 /* This packet contains an AUTH chunk */
821 __u8 has_auth;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822
Vlad Yasevich4cd57c82007-09-16 19:32:45 -0700823 /* This packet contains at least 1 DATA chunk */
824 __u8 has_data;
825
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 /* SCTP cannot fragment this packet. So let ip fragment it. */
Vlad Yasevich1f485642007-10-09 01:15:59 -0700827 __u8 ipfragok;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828
Vlad Yasevich1f485642007-10-09 01:15:59 -0700829 __u8 malloced;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830};
831
832struct sctp_packet *sctp_packet_init(struct sctp_packet *,
833 struct sctp_transport *,
834 __u16 sport, __u16 dport);
835struct sctp_packet *sctp_packet_config(struct sctp_packet *, __u32 vtag, int);
836sctp_xmit_t sctp_packet_transmit_chunk(struct sctp_packet *,
Vlad Yasevich2e3216c2008-06-19 16:08:18 -0700837 struct sctp_chunk *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838sctp_xmit_t sctp_packet_append_chunk(struct sctp_packet *,
839 struct sctp_chunk *);
840int sctp_packet_transmit(struct sctp_packet *);
841void sctp_packet_free(struct sctp_packet *);
842
843static inline int sctp_packet_empty(struct sctp_packet *packet)
844{
845 return (packet->size == packet->overhead);
846}
847
848/* This represents a remote transport address.
849 * For local transport addresses, we just use union sctp_addr.
850 *
851 * RFC2960 Section 1.4 Key Terms
852 *
853 * o Transport address: A Transport Address is traditionally defined
854 * by Network Layer address, Transport Layer protocol and Transport
855 * Layer port number. In the case of SCTP running over IP, a
856 * transport address is defined by the combination of an IP address
857 * and an SCTP port number (where SCTP is the Transport protocol).
858 *
859 * RFC2960 Section 7.1 SCTP Differences from TCP Congestion control
860 *
861 * o The sender keeps a separate congestion control parameter set for
862 * each of the destination addresses it can send to (not each
863 * source-destination pair but for each destination). The parameters
864 * should decay if the address is not used for a long enough time
865 * period.
866 *
867 */
868struct sctp_transport {
869 /* A list of transports. */
870 struct list_head transports;
871
872 /* Reference counting. */
873 atomic_t refcnt;
874 int dead;
875
876 /* This is the peer's IP address and port. */
877 union sctp_addr ipaddr;
878
879 /* These are the functions we call to handle LLP stuff. */
880 struct sctp_af *af_specific;
881
882 /* Which association do we belong to? */
883 struct sctp_association *asoc;
884
885 /* RFC2960
886 *
887 * 12.3 Per Transport Address Data
888 *
889 * For each destination transport address in the peer's
890 * address list derived from the INIT or INIT ACK chunk, a
891 * number of data elements needs to be maintained including:
892 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893 /* RTO : The current retransmission timeout value. */
Vlad Yasevich8116ffa2006-01-17 11:55:17 -0800894 unsigned long rto;
Vlad Yasevichb6157d82007-10-24 15:59:16 -0400895 unsigned long last_rto;
896
897 __u32 rtt; /* This is the most recent RTT. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898
899 /* RTTVAR : The current RTT variation. */
900 __u32 rttvar;
901
902 /* SRTT : The current smoothed round trip time. */
903 __u32 srtt;
904
905 /* RTO-Pending : A flag used to track if one of the DATA
906 * chunks sent to this address is currently being
907 * used to compute a RTT. If this flag is 0,
908 * the next DATA chunk sent to this destination
909 * should be used to compute a RTT and this flag
910 * should be set. Every time the RTT
911 * calculation completes (i.e. the DATA chunk
912 * is SACK'd) clear this flag.
913 */
Vlad Yasevicha6465232008-06-04 12:38:43 -0700914 __u8 rto_pending;
915
916 /* Flag to track the current fast recovery state */
917 __u8 fast_recovery;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918
919 /*
920 * These are the congestion stats.
921 */
922 /* cwnd : The current congestion window. */
923 __u32 cwnd; /* This is the actual cwnd. */
924
925 /* ssthresh : The current slow start threshold value. */
926 __u32 ssthresh;
927
928 /* partial : The tracking method for increase of cwnd when in
929 * bytes acked : congestion avoidance mode (see Section 6.2.2)
930 */
931 __u32 partial_bytes_acked;
932
933 /* Data that has been sent, but not acknowledged. */
934 __u32 flight_size;
935
Vlad Yasevicha6465232008-06-04 12:38:43 -0700936 /* TSN marking the fast recovery exit point */
937 __u32 fast_recovery_exit;
938
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 /* Destination */
940 struct dst_entry *dst;
941 /* Source address. */
942 union sctp_addr saddr;
943
944 /* When was the last time(in jiffies) that a data packet was sent on
945 * this transport? This is used to adjust the cwnd when the transport
946 * becomes inactive.
947 */
948 unsigned long last_time_used;
949
950 /* Heartbeat interval: The endpoint sends out a Heartbeat chunk to
951 * the destination address every heartbeat interval.
952 */
Vlad Yasevich8116ffa2006-01-17 11:55:17 -0800953 unsigned long hbinterval;
Frank Filz52ccb8e2005-12-22 11:36:46 -0800954
955 /* SACK delay timeout */
Vlad Yasevich8116ffa2006-01-17 11:55:17 -0800956 unsigned long sackdelay;
Wei Yongjund364d922008-05-09 15:13:26 -0700957 __u32 sackfreq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958
959 /* When was the last time (in jiffies) that we heard from this
960 * transport? We use this to pick new active and retran paths.
961 */
962 unsigned long last_time_heard;
963
964 /* Last time(in jiffies) when cwnd is reduced due to the congestion
965 * indication based on ECNE chunk.
966 */
967 unsigned long last_time_ecne_reduced;
968
Vlad Yasevich8116ffa2006-01-17 11:55:17 -0800969 /* This is the max_retrans value for the transport and will
970 * be initialized from the assocs value. This can be changed
971 * using SCTP_SET_PEER_ADDR_PARAMS socket option.
972 */
973 __u16 pathmaxrxt;
974
Vlad Yasevich8a479492007-06-07 14:21:05 -0400975 /* is the Path MTU update pending on this tranport */
976 __u8 pmtu_pending;
977
Vlad Yasevich8116ffa2006-01-17 11:55:17 -0800978 /* PMTU : The current known path MTU. */
979 __u32 pathmtu;
980
Joe Perchesf4ab2f722007-12-20 13:56:32 -0800981 /* Flags controlling Heartbeat, SACK delay, and Path MTU Discovery. */
Vlad Yasevich8116ffa2006-01-17 11:55:17 -0800982 __u32 param_flags;
983
Frank Filz3f7a87d2005-06-20 13:14:57 -0700984 /* The number of times INIT has been sent on this transport. */
985 int init_sent_count;
986
987 /* state : The current state of this destination,
988 * : i.e. SCTP_ACTIVE, SCTP_INACTIVE, SCTP_UNKOWN.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989 */
Frank Filz3f7a87d2005-06-20 13:14:57 -0700990 int state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992 /* These are the error stats for this destination. */
993
994 /* Error count : The current error count for this destination. */
995 unsigned short error_count;
996
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 /* Per : A timer used by each destination.
998 * Destination :
999 * Timer :
1000 *
1001 * [Everywhere else in the text this is called T3-rtx. -ed]
1002 */
1003 struct timer_list T3_rtx_timer;
1004
1005 /* Heartbeat timer is per destination. */
1006 struct timer_list hb_timer;
1007
1008 /* Since we're using per-destination retransmission timers
1009 * (see above), we're also using per-destination "transmitted"
1010 * queues. This probably ought to be a private struct
1011 * accessible only within the outqueue, but it's not, yet.
1012 */
1013 struct list_head transmitted;
1014
1015 /* We build bundle-able packets for this transport here. */
1016 struct sctp_packet packet;
1017
1018 /* This is the list of transports that have chunks to send. */
1019 struct list_head send_ready;
1020
1021 int malloced; /* Is this structure kfree()able? */
1022
1023 /* State information saved for SFR_CACC algorithm. The key
1024 * idea in SFR_CACC is to maintain state at the sender on a
1025 * per-destination basis when a changeover happens.
1026 * char changeover_active;
1027 * char cycling_changeover;
1028 * __u32 next_tsn_at_change;
1029 * char cacc_saw_newack;
1030 */
1031 struct {
1032 /* An unsigned integer, which stores the next TSN to be
1033 * used by the sender, at the moment of changeover.
1034 */
1035 __u32 next_tsn_at_change;
1036
1037 /* A flag which indicates the occurrence of a changeover */
1038 char changeover_active;
1039
1040 /* A flag which indicates whether the change of primary is
1041 * the first switch to this destination address during an
1042 * active switch.
1043 */
1044 char cycling_changeover;
1045
1046 /* A temporary flag, which is used during the processing of
1047 * a SACK to estimate the causative TSN(s)'s group.
1048 */
1049 char cacc_saw_newack;
1050 } cacc;
Sridhar Samudralaad8fec12006-07-21 14:48:50 -07001051
1052 /* 64-bit random number sent with heartbeat. */
1053 __u64 hb_nonce;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054};
1055
Alexey Dobriyan3182cd82005-07-11 20:57:47 -07001056struct sctp_transport *sctp_transport_new(const union sctp_addr *,
Al Virodd0fc662005-10-07 07:46:04 +01001057 gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058void sctp_transport_set_owner(struct sctp_transport *,
1059 struct sctp_association *);
1060void sctp_transport_route(struct sctp_transport *, union sctp_addr *,
1061 struct sctp_sock *);
1062void sctp_transport_pmtu(struct sctp_transport *);
1063void sctp_transport_free(struct sctp_transport *);
Vlad Yasevich62aeaff2008-06-04 12:39:11 -07001064void sctp_transport_reset_timers(struct sctp_transport *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065void sctp_transport_hold(struct sctp_transport *);
1066void sctp_transport_put(struct sctp_transport *);
1067void sctp_transport_update_rto(struct sctp_transport *, __u32);
1068void sctp_transport_raise_cwnd(struct sctp_transport *, __u32, __u32);
1069void sctp_transport_lower_cwnd(struct sctp_transport *, sctp_lower_cwnd_t);
1070unsigned long sctp_transport_timeout(struct sctp_transport *);
Vlad Yasevich749bf922007-03-19 17:02:30 -07001071void sctp_transport_reset(struct sctp_transport *);
Vlad Yasevichc910b472007-06-07 13:47:03 -04001072void sctp_transport_update_pmtu(struct sctp_transport *, u32);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073
1074
1075/* This is the structure we use to queue packets as they come into
1076 * SCTP. We write packets to it and read chunks from it.
1077 */
1078struct sctp_inq {
1079 /* This is actually a queue of sctp_chunk each
1080 * containing a partially decoded packet.
1081 */
David S. Miller79af02c2005-07-08 21:47:49 -07001082 struct list_head in_chunk_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083 /* This is the packet which is currently off the in queue and is
1084 * being worked on through the inbound chunk processing.
1085 */
1086 struct sctp_chunk *in_progress;
1087
1088 /* This is the delayed task to finish delivering inbound
1089 * messages.
1090 */
1091 struct work_struct immediate;
1092
1093 int malloced; /* Is this structure kfree()able? */
1094};
1095
1096void sctp_inq_init(struct sctp_inq *);
1097void sctp_inq_free(struct sctp_inq *);
1098void sctp_inq_push(struct sctp_inq *, struct sctp_chunk *packet);
1099struct sctp_chunk *sctp_inq_pop(struct sctp_inq *);
Vlad Yasevichbbd0d592007-10-03 17:51:34 -07001100struct sctp_chunkhdr *sctp_inq_peek(struct sctp_inq *);
David Howellsc4028952006-11-22 14:57:56 +00001101void sctp_inq_set_th_handler(struct sctp_inq *, work_func_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102
1103/* This is the structure we use to hold outbound chunks. You push
1104 * chunks in and they automatically pop out the other end as bundled
1105 * packets (it calls (*output_handler)()).
1106 *
1107 * This structure covers sections 6.3, 6.4, 6.7, 6.8, 6.10, 7., 8.1,
1108 * and 8.2 of the v13 draft.
1109 *
1110 * It handles retransmissions. The connection to the timeout portion
1111 * of the state machine is through sctp_..._timeout() and timeout_handler.
1112 *
1113 * If you feed it SACKs, it will eat them.
1114 *
1115 * If you give it big chunks, it will fragment them.
1116 *
1117 * It assigns TSN's to data chunks. This happens at the last possible
1118 * instant before transmission.
1119 *
1120 * When free()'d, it empties itself out via output_handler().
1121 */
1122struct sctp_outq {
1123 struct sctp_association *asoc;
1124
1125 /* Data pending that has never been transmitted. */
David S. Miller79af02c2005-07-08 21:47:49 -07001126 struct list_head out_chunk_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127
1128 unsigned out_qlen; /* Total length of queued data chunks. */
1129
1130 /* Error of send failed, may used in SCTP_SEND_FAILED event. */
1131 unsigned error;
1132
1133 /* These are control chunks we want to send. */
David S. Miller79af02c2005-07-08 21:47:49 -07001134 struct list_head control_chunk_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135
1136 /* These are chunks that have been sacked but are above the
1137 * CTSN, or cumulative tsn ack point.
1138 */
1139 struct list_head sacked;
1140
1141 /* Put chunks on this list to schedule them for
1142 * retransmission.
1143 */
1144 struct list_head retransmit;
1145
1146 /* Put chunks on this list to save them for FWD TSN processing as
1147 * they were abandoned.
1148 */
1149 struct list_head abandoned;
1150
1151 /* How many unackd bytes do we have in-flight? */
1152 __u32 outstanding_bytes;
1153
Vlad Yasevich62aeaff2008-06-04 12:39:11 -07001154 /* Are we doing fast-rtx on this queue */
1155 char fast_rtx;
1156
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157 /* Corked? */
1158 char cork;
1159
1160 /* Is this structure empty? */
1161 char empty;
1162
1163 /* Are we kfree()able? */
1164 char malloced;
1165};
1166
1167void sctp_outq_init(struct sctp_association *, struct sctp_outq *);
1168void sctp_outq_teardown(struct sctp_outq *);
1169void sctp_outq_free(struct sctp_outq*);
1170int sctp_outq_tail(struct sctp_outq *, struct sctp_chunk *chunk);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171int sctp_outq_sack(struct sctp_outq *, struct sctp_sackhdr *);
1172int sctp_outq_is_empty(const struct sctp_outq *);
1173void sctp_outq_restart(struct sctp_outq *);
1174
1175void sctp_retransmit(struct sctp_outq *, struct sctp_transport *,
1176 sctp_retransmit_reason_t);
1177void sctp_retransmit_mark(struct sctp_outq *, struct sctp_transport *, __u8);
1178int sctp_outq_uncork(struct sctp_outq *);
1179/* Uncork and flush an outqueue. */
1180static inline void sctp_outq_cork(struct sctp_outq *q)
1181{
1182 q->cork = 1;
1183}
1184
1185/* These bind address data fields common between endpoints and associations */
1186struct sctp_bind_addr {
1187
1188 /* RFC 2960 12.1 Parameters necessary for the SCTP instance
1189 *
1190 * SCTP Port: The local SCTP port number the endpoint is
1191 * bound to.
1192 */
1193 __u16 port;
1194
1195 /* RFC 2960 12.1 Parameters necessary for the SCTP instance
1196 *
1197 * Address List: The list of IP addresses that this instance
1198 * has bound. This information is passed to one's
1199 * peer(s) in INIT and INIT ACK chunks.
1200 */
1201 struct list_head address_list;
1202
1203 int malloced; /* Are we kfree()able? */
1204};
1205
1206void sctp_bind_addr_init(struct sctp_bind_addr *, __u16 port);
1207void sctp_bind_addr_free(struct sctp_bind_addr *);
1208int sctp_bind_addr_copy(struct sctp_bind_addr *dest,
1209 const struct sctp_bind_addr *src,
Al Virodd0fc662005-10-07 07:46:04 +01001210 sctp_scope_t scope, gfp_t gfp,
Alexey Dobriyan3182cd82005-07-11 20:57:47 -07001211 int flags);
Vlad Yasevich8e71a112007-12-06 22:50:54 -08001212int sctp_bind_addr_dup(struct sctp_bind_addr *dest,
1213 const struct sctp_bind_addr *src,
1214 gfp_t gfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215int sctp_add_bind_addr(struct sctp_bind_addr *, union sctp_addr *,
Vlad Yasevichf57d96b2007-12-20 14:12:24 -08001216 __u8 addr_state, gfp_t gfp);
Vlad Yasevich0ed90fb2007-10-24 16:10:00 -04001217int sctp_del_bind_addr(struct sctp_bind_addr *, union sctp_addr *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218int sctp_bind_addr_match(struct sctp_bind_addr *, const union sctp_addr *,
1219 struct sctp_sock *);
Vlad Yasevich7dab83d2008-07-18 23:05:40 -07001220int sctp_bind_addr_conflict(struct sctp_bind_addr *, const union sctp_addr *,
1221 struct sctp_sock *, struct sctp_sock *);
Vlad Yasevich75205f42007-12-20 14:12:59 -08001222int sctp_bind_addr_state(const struct sctp_bind_addr *bp,
1223 const union sctp_addr *addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224union sctp_addr *sctp_find_unmatch_addr(struct sctp_bind_addr *bp,
1225 const union sctp_addr *addrs,
1226 int addrcnt,
1227 struct sctp_sock *opt);
1228union sctp_params sctp_bind_addrs_to_raw(const struct sctp_bind_addr *bp,
Alexey Dobriyan3182cd82005-07-11 20:57:47 -07001229 int *addrs_len,
Al Virodd0fc662005-10-07 07:46:04 +01001230 gfp_t gfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231int sctp_raw_to_bind_addrs(struct sctp_bind_addr *bp, __u8 *raw, int len,
Al Virodd0fc662005-10-07 07:46:04 +01001232 __u16 port, gfp_t gfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233
1234sctp_scope_t sctp_scope(const union sctp_addr *);
1235int sctp_in_scope(const union sctp_addr *addr, const sctp_scope_t scope);
Vlad Yasevich52cae8f2008-08-18 10:34:34 -04001236int sctp_is_any(struct sock *sk, const union sctp_addr *addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237int sctp_addr_is_valid(const union sctp_addr *addr);
1238
1239
1240/* What type of endpoint? */
1241typedef enum {
1242 SCTP_EP_TYPE_SOCKET,
1243 SCTP_EP_TYPE_ASSOCIATION,
1244} sctp_endpoint_type_t;
1245
1246/*
1247 * A common base class to bridge the implmentation view of a
1248 * socket (usually listening) endpoint versus an association's
1249 * local endpoint.
1250 * This common structure is useful for several purposes:
1251 * 1) Common interface for lookup routines.
1252 * a) Subfunctions work for either endpoint or association
1253 * b) Single interface to lookup allows hiding the lookup lock rather
1254 * than acquiring it externally.
1255 * 2) Common interface for the inbound chunk handling/state machine.
1256 * 3) Common object handling routines for reference counting, etc.
1257 * 4) Disentangle association lookup from endpoint lookup, where we
1258 * do not have to find our endpoint to find our association.
1259 *
1260 */
1261
1262struct sctp_ep_common {
1263 /* Fields to help us manage our entries in the hash tables. */
Vlad Yasevichd970dbf2007-11-09 11:43:40 -05001264 struct hlist_node node;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265 int hashent;
1266
1267 /* Runtime type information. What kind of endpoint is this? */
1268 sctp_endpoint_type_t type;
1269
1270 /* Some fields to help us manage this object.
1271 * refcnt - Reference count access to this object.
1272 * dead - Do not attempt to use this object.
1273 * malloced - Do we need to kfree this object?
1274 */
1275 atomic_t refcnt;
1276 char dead;
1277 char malloced;
1278
1279 /* What socket does this endpoint belong to? */
1280 struct sock *sk;
1281
1282 /* This is where we receive inbound chunks. */
1283 struct sctp_inq inqueue;
1284
1285 /* This substructure includes the defining parameters of the
1286 * endpoint:
1287 * bind_addr.port is our shared port number.
1288 * bind_addr.address_list is our set of local IP addresses.
1289 */
1290 struct sctp_bind_addr bind_addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291};
1292
1293
1294/* RFC Section 1.4 Key Terms
1295 *
1296 * o SCTP endpoint: The logical sender/receiver of SCTP packets. On a
1297 * multi-homed host, an SCTP endpoint is represented to its peers as a
1298 * combination of a set of eligible destination transport addresses to
1299 * which SCTP packets can be sent and a set of eligible source
1300 * transport addresses from which SCTP packets can be received.
1301 * All transport addresses used by an SCTP endpoint must use the
1302 * same port number, but can use multiple IP addresses. A transport
1303 * address used by an SCTP endpoint must not be used by another
1304 * SCTP endpoint. In other words, a transport address is unique
1305 * to an SCTP endpoint.
1306 *
1307 * From an implementation perspective, each socket has one of these.
1308 * A TCP-style socket will have exactly one association on one of
1309 * these. An UDP-style socket will have multiple associations hanging
1310 * off one of these.
1311 */
1312
1313struct sctp_endpoint {
1314 /* Common substructure for endpoint and association. */
1315 struct sctp_ep_common base;
1316
1317 /* Associations: A list of current associations and mappings
1318 * to the data consumers for each association. This
1319 * may be in the form of a hash table or other
1320 * implementation dependent structure. The data
1321 * consumers may be process identification
1322 * information such as file descriptors, named pipe
1323 * pointer, or table pointers dependent on how SCTP
1324 * is implemented.
1325 */
1326 /* This is really a list of struct sctp_association entries. */
1327 struct list_head asocs;
1328
1329 /* Secret Key: A secret key used by this endpoint to compute
1330 * the MAC. This SHOULD be a cryptographic quality
1331 * random number with a sufficient length.
1332 * Discussion in [RFC1750] can be helpful in
1333 * selection of the key.
1334 */
1335 __u8 secret_key[SCTP_HOW_MANY_SECRETS][SCTP_SECRET_SIZE];
1336 int current_key;
1337 int last_key;
1338 int key_changed_at;
1339
Vlad Yasevich313e7b42006-01-17 11:55:57 -08001340 /* digest: This is a digest of the sctp cookie. This field is
1341 * only used on the receive path when we try to validate
1342 * that the cookie has not been tampered with. We put
1343 * this here so we pre-allocate this once and can re-use
1344 * on every receive.
1345 */
Vlad Yasevichb68dbca2006-11-09 16:29:57 -08001346 __u8 *digest;
Vlad Yasevich313e7b42006-01-17 11:55:57 -08001347
Neil Horman4eb701d2005-04-28 12:02:04 -07001348 /* sendbuf acct. policy. */
1349 __u32 sndbuf_policy;
Neil Horman049b3ff2005-11-11 16:08:24 -08001350
1351 /* rcvbuf acct. policy. */
1352 __u32 rcvbuf_policy;
Vlad Yasevich1f485642007-10-09 01:15:59 -07001353
1354 /* SCTP AUTH: array of the HMACs that will be allocated
1355 * we need this per association so that we don't serialize
1356 */
1357 struct crypto_hash **auth_hmacs;
1358
1359 /* SCTP-AUTH: hmacs for the endpoint encoded into parameter */
1360 struct sctp_hmac_algo_param *auth_hmacs_list;
1361
1362 /* SCTP-AUTH: chunks to authenticate encoded into parameter */
1363 struct sctp_chunks_param *auth_chunk_list;
1364
1365 /* SCTP-AUTH: endpoint shared keys */
1366 struct list_head endpoint_shared_keys;
1367 __u16 active_key_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368};
1369
1370/* Recover the outter endpoint structure. */
1371static inline struct sctp_endpoint *sctp_ep(struct sctp_ep_common *base)
1372{
1373 struct sctp_endpoint *ep;
1374
1375 ep = container_of(base, struct sctp_endpoint, base);
1376 return ep;
1377}
1378
1379/* These are function signatures for manipulating endpoints. */
Al Virodd0fc662005-10-07 07:46:04 +01001380struct sctp_endpoint *sctp_endpoint_new(struct sock *, gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381void sctp_endpoint_free(struct sctp_endpoint *);
1382void sctp_endpoint_put(struct sctp_endpoint *);
1383void sctp_endpoint_hold(struct sctp_endpoint *);
1384void sctp_endpoint_add_asoc(struct sctp_endpoint *, struct sctp_association *);
1385struct sctp_association *sctp_endpoint_lookup_assoc(
1386 const struct sctp_endpoint *ep,
1387 const union sctp_addr *paddr,
1388 struct sctp_transport **);
1389int sctp_endpoint_is_peeled_off(struct sctp_endpoint *,
1390 const union sctp_addr *);
1391struct sctp_endpoint *sctp_endpoint_is_match(struct sctp_endpoint *,
1392 const union sctp_addr *);
1393int sctp_has_association(const union sctp_addr *laddr,
1394 const union sctp_addr *paddr);
1395
1396int sctp_verify_init(const struct sctp_association *asoc, sctp_cid_t,
1397 sctp_init_chunk_t *peer_init, struct sctp_chunk *chunk,
1398 struct sctp_chunk **err_chunk);
1399int sctp_process_init(struct sctp_association *, sctp_cid_t cid,
1400 const union sctp_addr *peer,
Al Virodd0fc662005-10-07 07:46:04 +01001401 sctp_init_chunk_t *init, gfp_t gfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402__u32 sctp_generate_tag(const struct sctp_endpoint *);
1403__u32 sctp_generate_tsn(const struct sctp_endpoint *);
1404
Al Viroe1857ea2006-11-20 17:25:32 -08001405struct sctp_inithdr_host {
1406 __u32 init_tag;
1407 __u32 a_rwnd;
1408 __u16 num_outbound_streams;
1409 __u16 num_inbound_streams;
1410 __u32 initial_tsn;
1411};
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412
1413/* RFC2960
1414 *
1415 * 12. Recommended Transmission Control Block (TCB) Parameters
1416 *
1417 * This section details a recommended set of parameters that should
1418 * be contained within the TCB for an implementation. This section is
1419 * for illustrative purposes and should not be deemed as requirements
1420 * on an implementation or as an exhaustive list of all parameters
1421 * inside an SCTP TCB. Each implementation may need its own additional
1422 * parameters for optimization.
1423 */
1424
1425
1426/* Here we have information about each individual association. */
1427struct sctp_association {
1428
1429 /* A base structure common to endpoint and association.
1430 * In this context, it represents the associations's view
1431 * of the local endpoint of the association.
1432 */
1433 struct sctp_ep_common base;
1434
1435 /* Associations on the same socket. */
1436 struct list_head asocs;
1437
1438 /* association id. */
1439 sctp_assoc_t assoc_id;
1440
1441 /* This is our parent endpoint. */
1442 struct sctp_endpoint *ep;
1443
1444 /* These are those association elements needed in the cookie. */
1445 struct sctp_cookie c;
1446
1447 /* This is all information about our peer. */
1448 struct {
1449 /* rwnd
1450 *
1451 * Peer Rwnd : Current calculated value of the peer's rwnd.
1452 */
1453 __u32 rwnd;
1454
1455 /* transport_addr_list
1456 *
1457 * Peer : A list of SCTP transport addresses that the
1458 * Transport : peer is bound to. This information is derived
1459 * Address : from the INIT or INIT ACK and is used to
1460 * List : associate an inbound packet with a given
1461 * : association. Normally this information is
1462 * : hashed or keyed for quick lookup and access
1463 * : of the TCB.
Frank Filz3f7a87d2005-06-20 13:14:57 -07001464 * : The list is also initialized with the list
1465 * : of addresses passed with the sctp_connectx()
1466 * : call.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467 *
1468 * It is a list of SCTP_transport's.
1469 */
1470 struct list_head transport_addr_list;
1471
Frank Filz3f7a87d2005-06-20 13:14:57 -07001472 /* transport_count
1473 *
1474 * Peer : A count of the number of peer addresses
1475 * Transport : in the Peer Transport Address List.
1476 * Address :
1477 * Count :
1478 */
1479 __u16 transport_count;
1480
Linus Torvalds1da177e2005-04-16 15:20:36 -07001481 /* port
1482 * The transport layer port number.
1483 */
1484 __u16 port;
1485
1486 /* primary_path
1487 *
1488 * Primary : This is the current primary destination
1489 * Path : transport address of the peer endpoint. It
1490 * : may also specify a source transport address
1491 * : on this endpoint.
1492 *
1493 * All of these paths live on transport_addr_list.
1494 *
1495 * At the bakeoffs, we discovered that the intent of
1496 * primaryPath is that it only changes when the ULP
1497 * asks to have it changed. We add the activePath to
1498 * designate the connection we are currently using to
1499 * transmit new data and most control chunks.
1500 */
1501 struct sctp_transport *primary_path;
1502
1503 /* Cache the primary path address here, when we
1504 * need a an address for msg_name.
1505 */
1506 union sctp_addr primary_addr;
1507
1508 /* active_path
1509 * The path that we are currently using to
1510 * transmit new data and most control chunks.
1511 */
1512 struct sctp_transport *active_path;
1513
1514 /* retran_path
1515 *
1516 * RFC2960 6.4 Multi-homed SCTP Endpoints
1517 * ...
1518 * Furthermore, when its peer is multi-homed, an
1519 * endpoint SHOULD try to retransmit a chunk to an
1520 * active destination transport address that is
1521 * different from the last destination address to
1522 * which the DATA chunk was sent.
1523 */
1524 struct sctp_transport *retran_path;
1525
1526 /* Pointer to last transport I have sent on. */
1527 struct sctp_transport *last_sent_to;
1528
1529 /* This is the last transport I have received DATA on. */
1530 struct sctp_transport *last_data_from;
1531
1532 /*
1533 * Mapping An array of bits or bytes indicating which out of
1534 * Array order TSN's have been received (relative to the
1535 * Last Rcvd TSN). If no gaps exist, i.e. no out of
1536 * order packets have been received, this array
1537 * will be set to all zero. This structure may be
1538 * in the form of a circular buffer or bit array.
1539 *
1540 * Last Rcvd : This is the last TSN received in
1541 * TSN : sequence. This value is set initially by
1542 * : taking the peer's Initial TSN, received in
1543 * : the INIT or INIT ACK chunk, and subtracting
1544 * : one from it.
1545 *
1546 * Throughout most of the specification this is called the
1547 * "Cumulative TSN ACK Point". In this case, we
1548 * ignore the advice in 12.2 in favour of the term
1549 * used in the bulk of the text. This value is hidden
1550 * in tsn_map--we get it by calling sctp_tsnmap_get_ctsn().
1551 */
1552 struct sctp_tsnmap tsn_map;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553
1554 /* Ack State : This flag indicates if the next received
1555 * : packet is to be responded to with a
1556 * : SACK. This is initializedto 0. When a packet
1557 * : is received it is incremented. If this value
1558 * : reaches 2 or more, a SACK is sent and the
1559 * : value is reset to 0. Note: This is used only
1560 * : when no DATA chunks are received out of
1561 * : order. When DATA chunks are out of order,
1562 * : SACK's are not delayed (see Section 6).
1563 */
1564 __u8 sack_needed; /* Do we need to sack the peer? */
Wei Yongjund364d922008-05-09 15:13:26 -07001565 __u32 sack_cnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566
1567 /* These are capabilities which our peer advertised. */
1568 __u8 ecn_capable; /* Can peer do ECN? */
1569 __u8 ipv4_address; /* Peer understands IPv4 addresses? */
1570 __u8 ipv6_address; /* Peer understands IPv6 addresses? */
1571 __u8 hostname_address;/* Peer understands DNS addresses? */
1572 __u8 asconf_capable; /* Does peer support ADDIP? */
1573 __u8 prsctp_capable; /* Can peer do PR-SCTP? */
Vlad Yasevich1f485642007-10-09 01:15:59 -07001574 __u8 auth_capable; /* Is peer doing SCTP-AUTH? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575
Ivan Skytte Jorgensen0f3fffd2006-12-20 16:07:04 -08001576 __u32 adaptation_ind; /* Adaptation Code point. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001577
1578 /* This mask is used to disable sending the ASCONF chunk
1579 * with specified parameter to peer.
1580 */
Al Virodbc16db2006-11-20 17:01:42 -08001581 __be16 addip_disabled_mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582
Al Viroe1857ea2006-11-20 17:25:32 -08001583 struct sctp_inithdr_host i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584 int cookie_len;
1585 void *cookie;
1586
1587 /* ADDIP Section 4.2 Upon reception of an ASCONF Chunk.
1588 * C1) ... "Peer-Serial-Number'. This value MUST be initialized to the
1589 * Initial TSN Value minus 1
1590 */
1591 __u32 addip_serial;
Vlad Yasevich1f485642007-10-09 01:15:59 -07001592
1593 /* SCTP-AUTH: We need to know pears random number, hmac list
1594 * and authenticated chunk list. All that is part of the
1595 * cookie and these are just pointers to those locations
1596 */
1597 sctp_random_param_t *peer_random;
1598 sctp_chunks_param_t *peer_chunks;
1599 sctp_hmac_algo_param_t *peer_hmacs;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001600 } peer;
1601
1602 /* State : A state variable indicating what state the
1603 * : association is in, i.e. COOKIE-WAIT,
1604 * : COOKIE-ECHOED, ESTABLISHED, SHUTDOWN-PENDING,
1605 * : SHUTDOWN-SENT, SHUTDOWN-RECEIVED, SHUTDOWN-ACK-SENT.
1606 *
1607 * Note: No "CLOSED" state is illustrated since if a
1608 * association is "CLOSED" its TCB SHOULD be removed.
1609 *
1610 * In this implementation we DO have a CLOSED
1611 * state which is used during initiation and shutdown.
1612 *
1613 * State takes values from SCTP_STATE_*.
1614 */
1615 sctp_state_t state;
1616
1617 /* The cookie life I award for any cookie. */
1618 struct timeval cookie_life;
1619
1620 /* Overall : The overall association error count.
1621 * Error Count : [Clear this any time I get something.]
1622 */
1623 int overall_error_count;
1624
1625 /* These are the association's initial, max, and min RTO values.
1626 * These values will be initialized by system defaults, but can
1627 * be modified via the SCTP_RTOINFO socket option.
1628 */
Vlad Yasevich8116ffa2006-01-17 11:55:17 -08001629 unsigned long rto_initial;
1630 unsigned long rto_max;
1631 unsigned long rto_min;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001632
1633 /* Maximum number of new data packets that can be sent in a burst. */
1634 int max_burst;
1635
1636 /* This is the max_retrans value for the association. This value will
1637 * be initialized initialized from system defaults, but can be
1638 * modified by the SCTP_ASSOCINFO socket option.
1639 */
1640 int max_retrans;
1641
1642 /* Maximum number of times the endpoint will retransmit INIT */
1643 __u16 max_init_attempts;
1644
1645 /* How many times have we resent an INIT? */
1646 __u16 init_retries;
1647
1648 /* The largest timeout or RTO value to use in attempting an INIT */
Vlad Yasevich8116ffa2006-01-17 11:55:17 -08001649 unsigned long max_init_timeo;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650
Frank Filz52ccb8e2005-12-22 11:36:46 -08001651 /* Heartbeat interval: The endpoint sends out a Heartbeat chunk to
1652 * the destination address every heartbeat interval. This value
1653 * will be inherited by all new transports.
1654 */
Vlad Yasevich8116ffa2006-01-17 11:55:17 -08001655 unsigned long hbinterval;
Frank Filz52ccb8e2005-12-22 11:36:46 -08001656
1657 /* This is the max_retrans value for new transports in the
1658 * association.
1659 */
1660 __u16 pathmaxrxt;
1661
Vlad Yasevich8a479492007-06-07 14:21:05 -04001662 /* Flag that path mtu update is pending */
1663 __u8 pmtu_pending;
1664
Frank Filz52ccb8e2005-12-22 11:36:46 -08001665 /* Association : The smallest PMTU discovered for all of the
1666 * PMTU : peer's transport addresses.
1667 */
1668 __u32 pathmtu;
1669
Joe Perchesf4ab2f722007-12-20 13:56:32 -08001670 /* Flags controlling Heartbeat, SACK delay, and Path MTU Discovery. */
Frank Filz52ccb8e2005-12-22 11:36:46 -08001671 __u32 param_flags;
1672
Vlad Yasevich8116ffa2006-01-17 11:55:17 -08001673 /* SACK delay timeout */
1674 unsigned long sackdelay;
Wei Yongjund364d922008-05-09 15:13:26 -07001675 __u32 sackfreq;
Vlad Yasevich8116ffa2006-01-17 11:55:17 -08001676
1677
1678 unsigned long timeouts[SCTP_NUM_TIMEOUT_TYPES];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679 struct timer_list timers[SCTP_NUM_TIMEOUT_TYPES];
1680
1681 /* Transport to which SHUTDOWN chunk was last sent. */
1682 struct sctp_transport *shutdown_last_sent_to;
1683
Neil Horman58fbbed2008-02-29 11:40:56 -08001684 /* How many times have we resent a SHUTDOWN */
1685 int shutdown_retries;
1686
Frank Filz3f7a87d2005-06-20 13:14:57 -07001687 /* Transport to which INIT chunk was last sent. */
1688 struct sctp_transport *init_last_sent_to;
1689
Linus Torvalds1da177e2005-04-16 15:20:36 -07001690 /* Next TSN : The next TSN number to be assigned to a new
1691 * : DATA chunk. This is sent in the INIT or INIT
1692 * : ACK chunk to the peer and incremented each
1693 * : time a DATA chunk is assigned a TSN
1694 * : (normally just prior to transmit or during
1695 * : fragmentation).
1696 */
1697 __u32 next_tsn;
1698
1699 /*
1700 * Last Rcvd : This is the last TSN received in sequence. This value
1701 * TSN : is set initially by taking the peer's Initial TSN,
1702 * : received in the INIT or INIT ACK chunk, and
1703 * : subtracting one from it.
1704 *
1705 * Most of RFC 2960 refers to this as the Cumulative TSN Ack Point.
1706 */
1707
1708 __u32 ctsn_ack_point;
1709
1710 /* PR-SCTP Advanced.Peer.Ack.Point */
1711 __u32 adv_peer_ack_point;
1712
1713 /* Highest TSN that is acknowledged by incoming SACKs. */
1714 __u32 highest_sacked;
1715
1716 /* The number of unacknowledged data chunks. Reported through
1717 * the SCTP_STATUS sockopt.
1718 */
1719 __u16 unack_data;
1720
Neil Horman58fbbed2008-02-29 11:40:56 -08001721 /* The total number of data chunks that we've had to retransmit
1722 * as the result of a T3 timer expiration
1723 */
1724 __u32 rtx_data_chunks;
1725
Linus Torvalds1da177e2005-04-16 15:20:36 -07001726 /* This is the association's receive buffer space. This value is used
1727 * to set a_rwnd field in an INIT or a SACK chunk.
1728 */
1729 __u32 rwnd;
1730
1731 /* This is the last advertised value of rwnd over a SACK chunk. */
1732 __u32 a_rwnd;
1733
1734 /* Number of bytes by which the rwnd has slopped. The rwnd is allowed
1735 * to slop over a maximum of the association's frag_point.
1736 */
1737 __u32 rwnd_over;
1738
1739 /* This is the sndbuf size in use for the association.
1740 * This corresponds to the sndbuf size for the association,
1741 * as specified in the sk->sndbuf.
1742 */
1743 int sndbuf_used;
1744
Neil Horman049b3ff2005-11-11 16:08:24 -08001745 /* This is the amount of memory that this association has allocated
1746 * in the receive path at any given time.
1747 */
1748 atomic_t rmem_alloc;
1749
Linus Torvalds1da177e2005-04-16 15:20:36 -07001750 /* This is the wait queue head for send requests waiting on
1751 * the association sndbuf space.
1752 */
1753 wait_queue_head_t wait;
1754
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755 /* The message size at which SCTP fragmentation will occur. */
1756 __u32 frag_point;
1757
Frank Filz3f7a87d2005-06-20 13:14:57 -07001758 /* Counter used to count INIT errors. */
1759 int init_err_counter;
1760
1761 /* Count the number of INIT cycles (for doubling timeout). */
1762 int init_cycle;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763
1764 /* Default send parameters. */
1765 __u16 default_stream;
1766 __u16 default_flags;
1767 __u32 default_ppid;
1768 __u32 default_context;
1769 __u32 default_timetolive;
1770
Ivan Skytte Jorgensen6ab792f2006-12-13 16:34:22 -08001771 /* Default receive parameters */
1772 __u32 default_rcv_context;
1773
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774 /* This tracks outbound ssn for a given stream. */
1775 struct sctp_ssnmap *ssnmap;
1776
1777 /* All outbound chunks go through this structure. */
1778 struct sctp_outq outqueue;
1779
1780 /* A smart pipe that will handle reordering and fragmentation,
1781 * as well as handle passing events up to the ULP.
1782 */
1783 struct sctp_ulpq ulpq;
1784
1785 /* Last TSN that caused an ECNE Chunk to be sent. */
1786 __u32 last_ecne_tsn;
1787
1788 /* Last TSN that caused a CWR Chunk to be sent. */
1789 __u32 last_cwr_tsn;
1790
1791 /* How many duplicated TSNs have we seen? */
1792 int numduptsns;
1793
Vlad Yasevich8116ffa2006-01-17 11:55:17 -08001794 /* Number of seconds of idle time before an association is closed.
1795 * In the association context, this is really used as a boolean
1796 * since the real timeout is stored in the timeouts array
1797 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798 __u32 autoclose;
1799
1800 /* These are to support
1801 * "SCTP Extensions for Dynamic Reconfiguration of IP Addresses
1802 * and Enforcement of Flow and Message Limits"
1803 * <draft-ietf-tsvwg-addip-sctp-02.txt>
1804 * or "ADDIP" for short.
1805 */
1806
1807
1808
1809 /* ADDIP Section 4.1.1 Congestion Control of ASCONF Chunks
1810 *
1811 * R1) One and only one ASCONF Chunk MAY be in transit and
1812 * unacknowledged at any one time. If a sender, after sending
1813 * an ASCONF chunk, decides it needs to transfer another
1814 * ASCONF Chunk, it MUST wait until the ASCONF-ACK Chunk
1815 * returns from the previous ASCONF Chunk before sending a
1816 * subsequent ASCONF. Note this restriction binds each side,
1817 * so at any time two ASCONF may be in-transit on any given
1818 * association (one sent from each endpoint).
1819 *
1820 * [This is our one-and-only-one ASCONF in flight. If we do
1821 * not have an ASCONF in flight, this is NULL.]
1822 */
1823 struct sctp_chunk *addip_last_asconf;
1824
Vlad Yasevicha08de642007-12-20 14:11:47 -08001825 /* ADDIP Section 5.2 Upon reception of an ASCONF Chunk.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826 *
Vlad Yasevicha08de642007-12-20 14:11:47 -08001827 * This is needed to implement itmes E1 - E4 of the updated
1828 * spec. Here is the justification:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829 *
Vlad Yasevicha08de642007-12-20 14:11:47 -08001830 * Since the peer may bundle multiple ASCONF chunks toward us,
1831 * we now need the ability to cache multiple ACKs. The section
1832 * describes in detail how they are cached and cleaned up.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001833 */
Vlad Yasevicha08de642007-12-20 14:11:47 -08001834 struct list_head asconf_ack_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001835
1836 /* These ASCONF chunks are waiting to be sent.
1837 *
1838 * These chunaks can't be pushed to outqueue until receiving
1839 * ASCONF_ACK for the previous ASCONF indicated by
1840 * addip_last_asconf, so as to guarantee that only one ASCONF
1841 * is in flight at any time.
1842 *
1843 * ADDIP Section 4.1.1 Congestion Control of ASCONF Chunks
1844 *
1845 * In defining the ASCONF Chunk transfer procedures, it is
1846 * essential that these transfers MUST NOT cause congestion
1847 * within the network. To achieve this, we place these
1848 * restrictions on the transfer of ASCONF Chunks:
1849 *
1850 * R1) One and only one ASCONF Chunk MAY be in transit and
1851 * unacknowledged at any one time. If a sender, after sending
1852 * an ASCONF chunk, decides it needs to transfer another
1853 * ASCONF Chunk, it MUST wait until the ASCONF-ACK Chunk
1854 * returns from the previous ASCONF Chunk before sending a
1855 * subsequent ASCONF. Note this restriction binds each side,
1856 * so at any time two ASCONF may be in-transit on any given
1857 * association (one sent from each endpoint).
1858 *
1859 *
1860 * [I really think this is EXACTLY the sort of intelligence
1861 * which already resides in sctp_outq. Please move this
1862 * queue and its supporting logic down there. --piggy]
1863 */
David S. Miller79af02c2005-07-08 21:47:49 -07001864 struct list_head addip_chunk_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001865
1866 /* ADDIP Section 4.1 ASCONF Chunk Procedures
1867 *
1868 * A2) A serial number should be assigned to the Chunk. The
1869 * serial number SHOULD be a monotonically increasing
1870 * number. The serial number SHOULD be initialized at
1871 * the start of the association to the same value as the
1872 * Initial TSN and every time a new ASCONF chunk is created
1873 * it is incremented by one after assigning the serial number
1874 * to the newly created chunk.
1875 *
1876 * ADDIP
1877 * 3.1.1 Address/Stream Configuration Change Chunk (ASCONF)
1878 *
1879 * Serial Number : 32 bits (unsigned integer)
1880 *
1881 * This value represents a Serial Number for the ASCONF
1882 * Chunk. The valid range of Serial Number is from 0 to
1883 * 4294967295 (2^32 - 1). Serial Numbers wrap back to 0
1884 * after reaching 4294967295.
1885 */
1886 __u32 addip_serial;
1887
Vlad Yasevich1f485642007-10-09 01:15:59 -07001888 /* SCTP AUTH: list of the endpoint shared keys. These
1889 * keys are provided out of band by the user applicaton
1890 * and can't change during the lifetime of the association
1891 */
1892 struct list_head endpoint_shared_keys;
1893
1894 /* SCTP AUTH:
1895 * The current generated assocaition shared key (secret)
1896 */
1897 struct sctp_auth_bytes *asoc_shared_key;
1898
1899 /* SCTP AUTH: hmac id of the first peer requested algorithm
1900 * that we support.
1901 */
1902 __u16 default_hmac_id;
1903
1904 __u16 active_key_id;
1905
Linus Torvalds1da177e2005-04-16 15:20:36 -07001906 /* Need to send an ECNE Chunk? */
1907 char need_ecne;
1908
1909 /* Is it a temporary association? */
1910 char temp;
1911};
1912
1913
1914/* An eyecatcher for determining if we are really looking at an
1915 * association data structure.
1916 */
1917enum {
1918 SCTP_ASSOC_EYECATCHER = 0xa550c123,
1919};
1920
1921/* Recover the outter association structure. */
1922static inline struct sctp_association *sctp_assoc(struct sctp_ep_common *base)
1923{
1924 struct sctp_association *asoc;
1925
1926 asoc = container_of(base, struct sctp_association, base);
1927 return asoc;
1928}
1929
1930/* These are function signatures for manipulating associations. */
1931
1932
1933struct sctp_association *
1934sctp_association_new(const struct sctp_endpoint *, const struct sock *,
Al Virodd0fc662005-10-07 07:46:04 +01001935 sctp_scope_t scope, gfp_t gfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001936void sctp_association_free(struct sctp_association *);
1937void sctp_association_put(struct sctp_association *);
1938void sctp_association_hold(struct sctp_association *);
1939
Frank Filz3f7a87d2005-06-20 13:14:57 -07001940struct sctp_transport *sctp_assoc_choose_init_transport(
1941 struct sctp_association *);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001942struct sctp_transport *sctp_assoc_choose_shutdown_transport(
1943 struct sctp_association *);
1944void sctp_assoc_update_retran_path(struct sctp_association *);
1945struct sctp_transport *sctp_assoc_lookup_paddr(const struct sctp_association *,
1946 const union sctp_addr *);
1947int sctp_assoc_lookup_laddr(struct sctp_association *asoc,
1948 const union sctp_addr *laddr);
1949struct sctp_transport *sctp_assoc_add_peer(struct sctp_association *,
1950 const union sctp_addr *address,
Al Virodd0fc662005-10-07 07:46:04 +01001951 const gfp_t gfp,
Frank Filz3f7a87d2005-06-20 13:14:57 -07001952 const int peer_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953void sctp_assoc_del_peer(struct sctp_association *asoc,
1954 const union sctp_addr *addr);
Frank Filz3f7a87d2005-06-20 13:14:57 -07001955void sctp_assoc_rm_peer(struct sctp_association *asoc,
1956 struct sctp_transport *peer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001957void sctp_assoc_control_transport(struct sctp_association *,
1958 struct sctp_transport *,
1959 sctp_transport_cmd_t, sctp_sn_error_t);
1960struct sctp_transport *sctp_assoc_lookup_tsn(struct sctp_association *, __u32);
1961struct sctp_transport *sctp_assoc_is_match(struct sctp_association *,
1962 const union sctp_addr *,
1963 const union sctp_addr *);
1964void sctp_assoc_migrate(struct sctp_association *, struct sock *);
1965void sctp_assoc_update(struct sctp_association *old,
1966 struct sctp_association *new);
1967
1968__u32 sctp_association_get_next_tsn(struct sctp_association *);
1969
1970void sctp_assoc_sync_pmtu(struct sctp_association *);
1971void sctp_assoc_rwnd_increase(struct sctp_association *, unsigned);
1972void sctp_assoc_rwnd_decrease(struct sctp_association *, unsigned);
1973void sctp_assoc_set_primary(struct sctp_association *,
1974 struct sctp_transport *);
Vlad Yasevich42e30bf2007-12-20 14:08:56 -08001975void sctp_assoc_del_nonprimary_peers(struct sctp_association *,
1976 struct sctp_transport *);
Alexey Dobriyan3182cd82005-07-11 20:57:47 -07001977int sctp_assoc_set_bind_addr_from_ep(struct sctp_association *,
Al Virodd0fc662005-10-07 07:46:04 +01001978 gfp_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001979int sctp_assoc_set_bind_addr_from_cookie(struct sctp_association *,
Alexey Dobriyan3182cd82005-07-11 20:57:47 -07001980 struct sctp_cookie*,
Al Virodd0fc662005-10-07 07:46:04 +01001981 gfp_t gfp);
Vlad Yasevich07d93962007-05-04 13:55:27 -07001982int sctp_assoc_set_id(struct sctp_association *, gfp_t);
Vlad Yasevicha08de642007-12-20 14:11:47 -08001983void sctp_assoc_clean_asconf_ack_cache(const struct sctp_association *asoc);
1984struct sctp_chunk *sctp_assoc_lookup_asconf_ack(
1985 const struct sctp_association *asoc,
1986 __be32 serial);
1987
Linus Torvalds1da177e2005-04-16 15:20:36 -07001988
1989int sctp_cmp_addr_exact(const union sctp_addr *ss1,
1990 const union sctp_addr *ss2);
1991struct sctp_chunk *sctp_get_ecne_prepend(struct sctp_association *asoc);
1992
1993/* A convenience structure to parse out SCTP specific CMSGs. */
1994typedef struct sctp_cmsgs {
1995 struct sctp_initmsg *init;
1996 struct sctp_sndrcvinfo *info;
1997} sctp_cmsgs_t;
1998
1999/* Structure for tracking memory objects */
2000typedef struct {
2001 char *label;
2002 atomic_t *counter;
2003} sctp_dbg_objcnt_entry_t;
2004
2005#endif /* __sctp_structs_h__ */