1 /* SCTP kernel implementation
2 * (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 * Copyright (c) 2001 Nokia, Inc.
7 * Copyright (c) 2001 La Monte H.P. Yarroll
9 * These functions manipulate an sctp event. The struct ulpevent is used
10 * to carry notifications and data to the ULP (sockets).
12 * This SCTP implementation is free software;
13 * you can redistribute it and/or modify it under the terms of
14 * the GNU General Public License as published by
15 * the Free Software Foundation; either version 2, or (at your option)
18 * This SCTP implementation is distributed in the hope that it
19 * will be useful, but WITHOUT ANY WARRANTY; without even the implied
20 * ************************
21 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
22 * See the GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with GNU CC; see the file COPYING. If not, write to
26 * the Free Software Foundation, 59 Temple Place - Suite 330,
27 * Boston, MA 02111-1307, USA.
29 * Please send any bug reports or fixes you make to the
31 * lksctp developers <lksctp-developers@lists.sourceforge.net>
33 * Or submit a bug report through the following website:
34 * http://www.sf.net/projects/lksctp
36 * Written or modified by:
37 * Jon Grimm <jgrimm@us.ibm.com>
38 * La Monte H.P. Yarroll <piggy@acm.org>
39 * Ardelle Fan <ardelle.fan@intel.com>
40 * Sridhar Samudrala <sri@us.ibm.com>
42 * Any bugs reported given to us we will try to fix... any fixes shared will
43 * be incorporated into the next SCTP release.
46 #include <linux/slab.h>
47 #include <linux/types.h>
48 #include <linux/skbuff.h>
49 #include <net/sctp/structs.h>
50 #include <net/sctp/sctp.h>
51 #include <net/sctp/sm.h>
53 static void sctp_ulpevent_receive_data(struct sctp_ulpevent
*event
,
54 struct sctp_association
*asoc
);
55 static void sctp_ulpevent_release_data(struct sctp_ulpevent
*event
);
56 static void sctp_ulpevent_release_frag_data(struct sctp_ulpevent
*event
);
59 /* Initialize an ULP event from an given skb. */
60 SCTP_STATIC
void sctp_ulpevent_init(struct sctp_ulpevent
*event
,
64 memset(event
, 0, sizeof(struct sctp_ulpevent
));
65 event
->msg_flags
= msg_flags
;
66 event
->rmem_len
= len
;
69 /* Create a new sctp_ulpevent. */
70 SCTP_STATIC
struct sctp_ulpevent
*sctp_ulpevent_new(int size
, int msg_flags
,
73 struct sctp_ulpevent
*event
;
76 skb
= alloc_skb(size
, gfp
);
80 event
= sctp_skb2event(skb
);
81 sctp_ulpevent_init(event
, msg_flags
, skb
->truesize
);
89 /* Is this a MSG_NOTIFICATION? */
90 int sctp_ulpevent_is_notification(const struct sctp_ulpevent
*event
)
92 return MSG_NOTIFICATION
== (event
->msg_flags
& MSG_NOTIFICATION
);
95 /* Hold the association in case the msg_name needs read out of
98 static inline void sctp_ulpevent_set_owner(struct sctp_ulpevent
*event
,
99 const struct sctp_association
*asoc
)
103 /* Cast away the const, as we are just wanting to
104 * bump the reference count.
106 sctp_association_hold((struct sctp_association
*)asoc
);
107 skb
= sctp_event2skb(event
);
108 event
->asoc
= (struct sctp_association
*)asoc
;
109 atomic_add(event
->rmem_len
, &event
->asoc
->rmem_alloc
);
110 sctp_skb_set_owner_r(skb
, asoc
->base
.sk
);
113 /* A simple destructor to give up the reference to the association. */
114 static inline void sctp_ulpevent_release_owner(struct sctp_ulpevent
*event
)
116 struct sctp_association
*asoc
= event
->asoc
;
118 atomic_sub(event
->rmem_len
, &asoc
->rmem_alloc
);
119 sctp_association_put(asoc
);
122 /* Create and initialize an SCTP_ASSOC_CHANGE event.
124 * 5.3.1.1 SCTP_ASSOC_CHANGE
126 * Communication notifications inform the ULP that an SCTP association
127 * has either begun or ended. The identifier for a new association is
128 * provided by this notification.
130 * Note: There is no field checking here. If a field is unused it will be
133 struct sctp_ulpevent
*sctp_ulpevent_make_assoc_change(
134 const struct sctp_association
*asoc
,
135 __u16 flags
, __u16 state
, __u16 error
, __u16 outbound
,
136 __u16 inbound
, struct sctp_chunk
*chunk
, gfp_t gfp
)
138 struct sctp_ulpevent
*event
;
139 struct sctp_assoc_change
*sac
;
142 /* If the lower layer passed in the chunk, it will be
143 * an ABORT, so we need to include it in the sac_info.
146 /* Copy the chunk data to a new skb and reserve enough
147 * head room to use as notification.
149 skb
= skb_copy_expand(chunk
->skb
,
150 sizeof(struct sctp_assoc_change
), 0, gfp
);
155 /* Embed the event fields inside the cloned skb. */
156 event
= sctp_skb2event(skb
);
157 sctp_ulpevent_init(event
, MSG_NOTIFICATION
, skb
->truesize
);
159 /* Include the notification structure */
160 sac
= (struct sctp_assoc_change
*)
161 skb_push(skb
, sizeof(struct sctp_assoc_change
));
163 /* Trim the buffer to the right length. */
164 skb_trim(skb
, sizeof(struct sctp_assoc_change
) +
165 ntohs(chunk
->chunk_hdr
->length
) -
166 sizeof(sctp_chunkhdr_t
));
168 event
= sctp_ulpevent_new(sizeof(struct sctp_assoc_change
),
169 MSG_NOTIFICATION
, gfp
);
173 skb
= sctp_event2skb(event
);
174 sac
= (struct sctp_assoc_change
*) skb_put(skb
,
175 sizeof(struct sctp_assoc_change
));
178 /* Socket Extensions for SCTP
179 * 5.3.1.1 SCTP_ASSOC_CHANGE
182 * It should be SCTP_ASSOC_CHANGE.
184 sac
->sac_type
= SCTP_ASSOC_CHANGE
;
186 /* Socket Extensions for SCTP
187 * 5.3.1.1 SCTP_ASSOC_CHANGE
189 * sac_state: 32 bits (signed integer)
190 * This field holds one of a number of values that communicate the
191 * event that happened to the association.
193 sac
->sac_state
= state
;
195 /* Socket Extensions for SCTP
196 * 5.3.1.1 SCTP_ASSOC_CHANGE
198 * sac_flags: 16 bits (unsigned integer)
203 /* Socket Extensions for SCTP
204 * 5.3.1.1 SCTP_ASSOC_CHANGE
206 * sac_length: sizeof (__u32)
207 * This field is the total length of the notification data, including
208 * the notification header.
210 sac
->sac_length
= skb
->len
;
212 /* Socket Extensions for SCTP
213 * 5.3.1.1 SCTP_ASSOC_CHANGE
215 * sac_error: 32 bits (signed integer)
217 * If the state was reached due to a error condition (e.g.
218 * COMMUNICATION_LOST) any relevant error information is available in
219 * this field. This corresponds to the protocol error codes defined in
222 sac
->sac_error
= error
;
224 /* Socket Extensions for SCTP
225 * 5.3.1.1 SCTP_ASSOC_CHANGE
227 * sac_outbound_streams: 16 bits (unsigned integer)
228 * sac_inbound_streams: 16 bits (unsigned integer)
230 * The maximum number of streams allowed in each direction are
231 * available in sac_outbound_streams and sac_inbound streams.
233 sac
->sac_outbound_streams
= outbound
;
234 sac
->sac_inbound_streams
= inbound
;
236 /* Socket Extensions for SCTP
237 * 5.3.1.1 SCTP_ASSOC_CHANGE
239 * sac_assoc_id: sizeof (sctp_assoc_t)
241 * The association id field, holds the identifier for the association.
242 * All notifications for a given association have the same association
243 * identifier. For TCP style socket, this field is ignored.
245 sctp_ulpevent_set_owner(event
, asoc
);
246 sac
->sac_assoc_id
= sctp_assoc2id(asoc
);
254 /* Create and initialize an SCTP_PEER_ADDR_CHANGE event.
256 * Socket Extensions for SCTP - draft-01
257 * 5.3.1.2 SCTP_PEER_ADDR_CHANGE
259 * When a destination address on a multi-homed peer encounters a change
260 * an interface details event is sent.
262 struct sctp_ulpevent
*sctp_ulpevent_make_peer_addr_change(
263 const struct sctp_association
*asoc
,
264 const struct sockaddr_storage
*aaddr
,
265 int flags
, int state
, int error
, gfp_t gfp
)
267 struct sctp_ulpevent
*event
;
268 struct sctp_paddr_change
*spc
;
271 event
= sctp_ulpevent_new(sizeof(struct sctp_paddr_change
),
272 MSG_NOTIFICATION
, gfp
);
276 skb
= sctp_event2skb(event
);
277 spc
= (struct sctp_paddr_change
*)
278 skb_put(skb
, sizeof(struct sctp_paddr_change
));
280 /* Sockets API Extensions for SCTP
281 * Section 5.3.1.2 SCTP_PEER_ADDR_CHANGE
285 * It should be SCTP_PEER_ADDR_CHANGE.
287 spc
->spc_type
= SCTP_PEER_ADDR_CHANGE
;
289 /* Sockets API Extensions for SCTP
290 * Section 5.3.1.2 SCTP_PEER_ADDR_CHANGE
292 * spc_length: sizeof (__u32)
294 * This field is the total length of the notification data, including
295 * the notification header.
297 spc
->spc_length
= sizeof(struct sctp_paddr_change
);
299 /* Sockets API Extensions for SCTP
300 * Section 5.3.1.2 SCTP_PEER_ADDR_CHANGE
302 * spc_flags: 16 bits (unsigned integer)
307 /* Sockets API Extensions for SCTP
308 * Section 5.3.1.2 SCTP_PEER_ADDR_CHANGE
310 * spc_state: 32 bits (signed integer)
312 * This field holds one of a number of values that communicate the
313 * event that happened to the address.
315 spc
->spc_state
= state
;
317 /* Sockets API Extensions for SCTP
318 * Section 5.3.1.2 SCTP_PEER_ADDR_CHANGE
320 * spc_error: 32 bits (signed integer)
322 * If the state was reached due to any error condition (e.g.
323 * ADDRESS_UNREACHABLE) any relevant error information is available in
326 spc
->spc_error
= error
;
328 /* Socket Extensions for SCTP
329 * 5.3.1.1 SCTP_ASSOC_CHANGE
331 * spc_assoc_id: sizeof (sctp_assoc_t)
333 * The association id field, holds the identifier for the association.
334 * All notifications for a given association have the same association
335 * identifier. For TCP style socket, this field is ignored.
337 sctp_ulpevent_set_owner(event
, asoc
);
338 spc
->spc_assoc_id
= sctp_assoc2id(asoc
);
340 /* Sockets API Extensions for SCTP
341 * Section 5.3.1.2 SCTP_PEER_ADDR_CHANGE
343 * spc_aaddr: sizeof (struct sockaddr_storage)
345 * The affected address field, holds the remote peer's address that is
346 * encountering the change of state.
348 memcpy(&spc
->spc_aaddr
, aaddr
, sizeof(struct sockaddr_storage
));
350 /* Map ipv4 address into v4-mapped-on-v6 address. */
351 sctp_get_pf_specific(asoc
->base
.sk
->sk_family
)->addr_v4map(
352 sctp_sk(asoc
->base
.sk
),
353 (union sctp_addr
*)&spc
->spc_aaddr
);
361 /* Create and initialize an SCTP_REMOTE_ERROR notification.
363 * Note: This assumes that the chunk->skb->data already points to the
364 * operation error payload.
366 * Socket Extensions for SCTP - draft-01
367 * 5.3.1.3 SCTP_REMOTE_ERROR
369 * A remote peer may send an Operational Error message to its peer.
370 * This message indicates a variety of error conditions on an
371 * association. The entire error TLV as it appears on the wire is
372 * included in a SCTP_REMOTE_ERROR event. Please refer to the SCTP
373 * specification [SCTP] and any extensions for a list of possible
376 struct sctp_ulpevent
*
377 sctp_ulpevent_make_remote_error(const struct sctp_association
*asoc
,
378 struct sctp_chunk
*chunk
, __u16 flags
,
381 struct sctp_ulpevent
*event
;
382 struct sctp_remote_error
*sre
;
388 ch
= (sctp_errhdr_t
*)(chunk
->skb
->data
);
390 elen
= WORD_ROUND(ntohs(ch
->length
)) - sizeof(sctp_errhdr_t
);
392 /* Pull off the ERROR header. */
393 skb_pull(chunk
->skb
, sizeof(sctp_errhdr_t
));
395 /* Copy the skb to a new skb with room for us to prepend
398 skb
= skb_copy_expand(chunk
->skb
, sizeof(*sre
), 0, gfp
);
400 /* Pull off the rest of the cause TLV from the chunk. */
401 skb_pull(chunk
->skb
, elen
);
405 /* Embed the event fields inside the cloned skb. */
406 event
= sctp_skb2event(skb
);
407 sctp_ulpevent_init(event
, MSG_NOTIFICATION
, skb
->truesize
);
409 sre
= (struct sctp_remote_error
*) skb_push(skb
, sizeof(*sre
));
411 /* Trim the buffer to the right length. */
412 skb_trim(skb
, sizeof(*sre
) + elen
);
414 /* RFC6458, Section 6.1.3. SCTP_REMOTE_ERROR */
415 memset(sre
, 0, sizeof(*sre
));
416 sre
->sre_type
= SCTP_REMOTE_ERROR
;
418 sre
->sre_length
= skb
->len
;
419 sre
->sre_error
= cause
;
420 sctp_ulpevent_set_owner(event
, asoc
);
421 sre
->sre_assoc_id
= sctp_assoc2id(asoc
);
428 /* Create and initialize a SCTP_SEND_FAILED notification.
430 * Socket Extensions for SCTP - draft-01
431 * 5.3.1.4 SCTP_SEND_FAILED
433 struct sctp_ulpevent
*sctp_ulpevent_make_send_failed(
434 const struct sctp_association
*asoc
, struct sctp_chunk
*chunk
,
435 __u16 flags
, __u32 error
, gfp_t gfp
)
437 struct sctp_ulpevent
*event
;
438 struct sctp_send_failed
*ssf
;
441 /* Pull off any padding. */
442 int len
= ntohs(chunk
->chunk_hdr
->length
);
444 /* Make skb with more room so we can prepend notification. */
445 skb
= skb_copy_expand(chunk
->skb
,
446 sizeof(struct sctp_send_failed
), /* headroom */
452 /* Pull off the common chunk header and DATA header. */
453 skb_pull(skb
, sizeof(struct sctp_data_chunk
));
454 len
-= sizeof(struct sctp_data_chunk
);
456 /* Embed the event fields inside the cloned skb. */
457 event
= sctp_skb2event(skb
);
458 sctp_ulpevent_init(event
, MSG_NOTIFICATION
, skb
->truesize
);
460 ssf
= (struct sctp_send_failed
*)
461 skb_push(skb
, sizeof(struct sctp_send_failed
));
463 /* Socket Extensions for SCTP
464 * 5.3.1.4 SCTP_SEND_FAILED
467 * It should be SCTP_SEND_FAILED.
469 ssf
->ssf_type
= SCTP_SEND_FAILED
;
471 /* Socket Extensions for SCTP
472 * 5.3.1.4 SCTP_SEND_FAILED
474 * ssf_flags: 16 bits (unsigned integer)
475 * The flag value will take one of the following values
477 * SCTP_DATA_UNSENT - Indicates that the data was never put on
480 * SCTP_DATA_SENT - Indicates that the data was put on the wire.
481 * Note that this does not necessarily mean that the
482 * data was (or was not) successfully delivered.
484 ssf
->ssf_flags
= flags
;
486 /* Socket Extensions for SCTP
487 * 5.3.1.4 SCTP_SEND_FAILED
489 * ssf_length: sizeof (__u32)
490 * This field is the total length of the notification data, including
491 * the notification header.
493 ssf
->ssf_length
= sizeof(struct sctp_send_failed
) + len
;
494 skb_trim(skb
, ssf
->ssf_length
);
496 /* Socket Extensions for SCTP
497 * 5.3.1.4 SCTP_SEND_FAILED
499 * ssf_error: 16 bits (unsigned integer)
500 * This value represents the reason why the send failed, and if set,
501 * will be a SCTP protocol error code as defined in [SCTP] section
504 ssf
->ssf_error
= error
;
506 /* Socket Extensions for SCTP
507 * 5.3.1.4 SCTP_SEND_FAILED
509 * ssf_info: sizeof (struct sctp_sndrcvinfo)
510 * The original send information associated with the undelivered
513 memcpy(&ssf
->ssf_info
, &chunk
->sinfo
, sizeof(struct sctp_sndrcvinfo
));
515 /* Per TSVWG discussion with Randy. Allow the application to
516 * reassemble a fragmented message.
518 ssf
->ssf_info
.sinfo_flags
= chunk
->chunk_hdr
->flags
;
520 /* Socket Extensions for SCTP
521 * 5.3.1.4 SCTP_SEND_FAILED
523 * ssf_assoc_id: sizeof (sctp_assoc_t)
524 * The association id field, sf_assoc_id, holds the identifier for the
525 * association. All notifications for a given association have the
526 * same association identifier. For TCP style socket, this field is
529 sctp_ulpevent_set_owner(event
, asoc
);
530 ssf
->ssf_assoc_id
= sctp_assoc2id(asoc
);
537 /* Create and initialize a SCTP_SHUTDOWN_EVENT notification.
539 * Socket Extensions for SCTP - draft-01
540 * 5.3.1.5 SCTP_SHUTDOWN_EVENT
542 struct sctp_ulpevent
*sctp_ulpevent_make_shutdown_event(
543 const struct sctp_association
*asoc
,
544 __u16 flags
, gfp_t gfp
)
546 struct sctp_ulpevent
*event
;
547 struct sctp_shutdown_event
*sse
;
550 event
= sctp_ulpevent_new(sizeof(struct sctp_shutdown_event
),
551 MSG_NOTIFICATION
, gfp
);
555 skb
= sctp_event2skb(event
);
556 sse
= (struct sctp_shutdown_event
*)
557 skb_put(skb
, sizeof(struct sctp_shutdown_event
));
559 /* Socket Extensions for SCTP
560 * 5.3.1.5 SCTP_SHUTDOWN_EVENT
563 * It should be SCTP_SHUTDOWN_EVENT
565 sse
->sse_type
= SCTP_SHUTDOWN_EVENT
;
567 /* Socket Extensions for SCTP
568 * 5.3.1.5 SCTP_SHUTDOWN_EVENT
570 * sse_flags: 16 bits (unsigned integer)
575 /* Socket Extensions for SCTP
576 * 5.3.1.5 SCTP_SHUTDOWN_EVENT
578 * sse_length: sizeof (__u32)
579 * This field is the total length of the notification data, including
580 * the notification header.
582 sse
->sse_length
= sizeof(struct sctp_shutdown_event
);
584 /* Socket Extensions for SCTP
585 * 5.3.1.5 SCTP_SHUTDOWN_EVENT
587 * sse_assoc_id: sizeof (sctp_assoc_t)
588 * The association id field, holds the identifier for the association.
589 * All notifications for a given association have the same association
590 * identifier. For TCP style socket, this field is ignored.
592 sctp_ulpevent_set_owner(event
, asoc
);
593 sse
->sse_assoc_id
= sctp_assoc2id(asoc
);
601 /* Create and initialize a SCTP_ADAPTATION_INDICATION notification.
603 * Socket Extensions for SCTP
604 * 5.3.1.6 SCTP_ADAPTATION_INDICATION
606 struct sctp_ulpevent
*sctp_ulpevent_make_adaptation_indication(
607 const struct sctp_association
*asoc
, gfp_t gfp
)
609 struct sctp_ulpevent
*event
;
610 struct sctp_adaptation_event
*sai
;
613 event
= sctp_ulpevent_new(sizeof(struct sctp_adaptation_event
),
614 MSG_NOTIFICATION
, gfp
);
618 skb
= sctp_event2skb(event
);
619 sai
= (struct sctp_adaptation_event
*)
620 skb_put(skb
, sizeof(struct sctp_adaptation_event
));
622 sai
->sai_type
= SCTP_ADAPTATION_INDICATION
;
624 sai
->sai_length
= sizeof(struct sctp_adaptation_event
);
625 sai
->sai_adaptation_ind
= asoc
->peer
.adaptation_ind
;
626 sctp_ulpevent_set_owner(event
, asoc
);
627 sai
->sai_assoc_id
= sctp_assoc2id(asoc
);
635 /* A message has been received. Package this message as a notification
636 * to pass it to the upper layers. Go ahead and calculate the sndrcvinfo
637 * even if filtered out later.
639 * Socket Extensions for SCTP
640 * 5.2.2 SCTP Header Information Structure (SCTP_SNDRCV)
642 struct sctp_ulpevent
*sctp_ulpevent_make_rcvmsg(struct sctp_association
*asoc
,
643 struct sctp_chunk
*chunk
,
646 struct sctp_ulpevent
*event
= NULL
;
652 * check to see if we need to make space for this
653 * new skb, expand the rcvbuffer if needed, or drop
656 if (asoc
->ep
->rcvbuf_policy
)
657 rx_count
= atomic_read(&asoc
->rmem_alloc
);
659 rx_count
= atomic_read(&asoc
->base
.sk
->sk_rmem_alloc
);
661 if (rx_count
>= asoc
->base
.sk
->sk_rcvbuf
) {
663 if ((asoc
->base
.sk
->sk_userlocks
& SOCK_RCVBUF_LOCK
) ||
664 (!sk_rmem_schedule(asoc
->base
.sk
, chunk
->skb
,
665 chunk
->skb
->truesize
)))
669 /* Clone the original skb, sharing the data. */
670 skb
= skb_clone(chunk
->skb
, gfp
);
674 /* Now that all memory allocations for this chunk succeeded, we
675 * can mark it as received so the tsn_map is updated correctly.
677 if (sctp_tsnmap_mark(&asoc
->peer
.tsn_map
,
678 ntohl(chunk
->subh
.data_hdr
->tsn
),
682 /* First calculate the padding, so we don't inadvertently
683 * pass up the wrong length to the user.
685 * RFC 2960 - Section 3.2 Chunk Field Descriptions
687 * The total length of a chunk(including Type, Length and Value fields)
688 * MUST be a multiple of 4 bytes. If the length of the chunk is not a
689 * multiple of 4 bytes, the sender MUST pad the chunk with all zero
690 * bytes and this padding is not included in the chunk length field.
691 * The sender should never pad with more than 3 bytes. The receiver
692 * MUST ignore the padding bytes.
694 len
= ntohs(chunk
->chunk_hdr
->length
);
695 padding
= WORD_ROUND(len
) - len
;
697 /* Fixup cloned skb with just this chunks data. */
698 skb_trim(skb
, chunk
->chunk_end
- padding
- skb
->data
);
700 /* Embed the event fields inside the cloned skb. */
701 event
= sctp_skb2event(skb
);
703 /* Initialize event with flags 0 and correct length
704 * Since this is a clone of the original skb, only account for
705 * the data of this chunk as other chunks will be accounted separately.
707 sctp_ulpevent_init(event
, 0, skb
->len
+ sizeof(struct sk_buff
));
709 sctp_ulpevent_receive_data(event
, asoc
);
711 event
->stream
= ntohs(chunk
->subh
.data_hdr
->stream
);
712 event
->ssn
= ntohs(chunk
->subh
.data_hdr
->ssn
);
713 event
->ppid
= chunk
->subh
.data_hdr
->ppid
;
714 if (chunk
->chunk_hdr
->flags
& SCTP_DATA_UNORDERED
) {
715 event
->flags
|= SCTP_UNORDERED
;
716 event
->cumtsn
= sctp_tsnmap_get_ctsn(&asoc
->peer
.tsn_map
);
718 event
->tsn
= ntohl(chunk
->subh
.data_hdr
->tsn
);
719 event
->msg_flags
|= chunk
->chunk_hdr
->flags
;
720 event
->iif
= sctp_chunk_iif(chunk
);
730 /* Create a partial delivery related event.
732 * 5.3.1.7 SCTP_PARTIAL_DELIVERY_EVENT
734 * When a receiver is engaged in a partial delivery of a
735 * message this notification will be used to indicate
738 struct sctp_ulpevent
*sctp_ulpevent_make_pdapi(
739 const struct sctp_association
*asoc
, __u32 indication
,
742 struct sctp_ulpevent
*event
;
743 struct sctp_pdapi_event
*pd
;
746 event
= sctp_ulpevent_new(sizeof(struct sctp_pdapi_event
),
747 MSG_NOTIFICATION
, gfp
);
751 skb
= sctp_event2skb(event
);
752 pd
= (struct sctp_pdapi_event
*)
753 skb_put(skb
, sizeof(struct sctp_pdapi_event
));
756 * It should be SCTP_PARTIAL_DELIVERY_EVENT
758 * pdapi_flags: 16 bits (unsigned integer)
761 pd
->pdapi_type
= SCTP_PARTIAL_DELIVERY_EVENT
;
764 /* pdapi_length: 32 bits (unsigned integer)
766 * This field is the total length of the notification data, including
767 * the notification header. It will generally be sizeof (struct
770 pd
->pdapi_length
= sizeof(struct sctp_pdapi_event
);
772 /* pdapi_indication: 32 bits (unsigned integer)
774 * This field holds the indication being sent to the application.
776 pd
->pdapi_indication
= indication
;
778 /* pdapi_assoc_id: sizeof (sctp_assoc_t)
780 * The association id field, holds the identifier for the association.
782 sctp_ulpevent_set_owner(event
, asoc
);
783 pd
->pdapi_assoc_id
= sctp_assoc2id(asoc
);
790 struct sctp_ulpevent
*sctp_ulpevent_make_authkey(
791 const struct sctp_association
*asoc
, __u16 key_id
,
792 __u32 indication
, gfp_t gfp
)
794 struct sctp_ulpevent
*event
;
795 struct sctp_authkey_event
*ak
;
798 event
= sctp_ulpevent_new(sizeof(struct sctp_authkey_event
),
799 MSG_NOTIFICATION
, gfp
);
803 skb
= sctp_event2skb(event
);
804 ak
= (struct sctp_authkey_event
*)
805 skb_put(skb
, sizeof(struct sctp_authkey_event
));
807 ak
->auth_type
= SCTP_AUTHENTICATION_EVENT
;
809 ak
->auth_length
= sizeof(struct sctp_authkey_event
);
811 ak
->auth_keynumber
= key_id
;
812 ak
->auth_altkeynumber
= 0;
813 ak
->auth_indication
= indication
;
816 * The association id field, holds the identifier for the association.
818 sctp_ulpevent_set_owner(event
, asoc
);
819 ak
->auth_assoc_id
= sctp_assoc2id(asoc
);
827 * Socket Extensions for SCTP
828 * 6.3.10. SCTP_SENDER_DRY_EVENT
830 struct sctp_ulpevent
*sctp_ulpevent_make_sender_dry_event(
831 const struct sctp_association
*asoc
, gfp_t gfp
)
833 struct sctp_ulpevent
*event
;
834 struct sctp_sender_dry_event
*sdry
;
837 event
= sctp_ulpevent_new(sizeof(struct sctp_sender_dry_event
),
838 MSG_NOTIFICATION
, gfp
);
842 skb
= sctp_event2skb(event
);
843 sdry
= (struct sctp_sender_dry_event
*)
844 skb_put(skb
, sizeof(struct sctp_sender_dry_event
));
846 sdry
->sender_dry_type
= SCTP_SENDER_DRY_EVENT
;
847 sdry
->sender_dry_flags
= 0;
848 sdry
->sender_dry_length
= sizeof(struct sctp_sender_dry_event
);
849 sctp_ulpevent_set_owner(event
, asoc
);
850 sdry
->sender_dry_assoc_id
= sctp_assoc2id(asoc
);
855 /* Return the notification type, assuming this is a notification
858 __u16
sctp_ulpevent_get_notification_type(const struct sctp_ulpevent
*event
)
860 union sctp_notification
*notification
;
863 skb
= sctp_event2skb(event
);
864 notification
= (union sctp_notification
*) skb
->data
;
865 return notification
->sn_header
.sn_type
;
868 /* RFC6458, Section 5.3.2. SCTP Header Information Structure
869 * (SCTP_SNDRCV, DEPRECATED)
871 void sctp_ulpevent_read_sndrcvinfo(const struct sctp_ulpevent
*event
,
872 struct msghdr
*msghdr
)
874 struct sctp_sndrcvinfo sinfo
;
876 if (sctp_ulpevent_is_notification(event
))
879 memset(&sinfo
, 0, sizeof(sinfo
));
880 sinfo
.sinfo_stream
= event
->stream
;
881 sinfo
.sinfo_ssn
= event
->ssn
;
882 sinfo
.sinfo_ppid
= event
->ppid
;
883 sinfo
.sinfo_flags
= event
->flags
;
884 sinfo
.sinfo_tsn
= event
->tsn
;
885 sinfo
.sinfo_cumtsn
= event
->cumtsn
;
886 sinfo
.sinfo_assoc_id
= sctp_assoc2id(event
->asoc
);
887 /* Context value that is set via SCTP_CONTEXT socket option. */
888 sinfo
.sinfo_context
= event
->asoc
->default_rcv_context
;
889 /* These fields are not used while receiving. */
890 sinfo
.sinfo_timetolive
= 0;
892 put_cmsg(msghdr
, IPPROTO_SCTP
, SCTP_SNDRCV
,
893 sizeof(sinfo
), &sinfo
);
896 /* Do accounting for bytes received and hold a reference to the association
899 static void sctp_ulpevent_receive_data(struct sctp_ulpevent
*event
,
900 struct sctp_association
*asoc
)
902 struct sk_buff
*skb
, *frag
;
904 skb
= sctp_event2skb(event
);
905 /* Set the owner and charge rwnd for bytes received. */
906 sctp_ulpevent_set_owner(event
, asoc
);
907 sctp_assoc_rwnd_decrease(asoc
, skb_headlen(skb
));
912 /* Note: Not clearing the entire event struct as this is just a
913 * fragment of the real event. However, we still need to do rwnd
915 * In general, the skb passed from IP can have only 1 level of
916 * fragments. But we allow multiple levels of fragments.
918 skb_walk_frags(skb
, frag
)
919 sctp_ulpevent_receive_data(sctp_skb2event(frag
), asoc
);
922 /* Do accounting for bytes just read by user and release the references to
925 static void sctp_ulpevent_release_data(struct sctp_ulpevent
*event
)
927 struct sk_buff
*skb
, *frag
;
930 /* Current stack structures assume that the rcv buffer is
931 * per socket. For UDP style sockets this is not true as
932 * multiple associations may be on a single UDP-style socket.
933 * Use the local private area of the skb to track the owning
937 skb
= sctp_event2skb(event
);
943 /* Don't forget the fragments. */
944 skb_walk_frags(skb
, frag
) {
945 /* NOTE: skb_shinfos are recursive. Although IP returns
946 * skb's with only 1 level of fragments, SCTP reassembly can
947 * increase the levels.
949 sctp_ulpevent_release_frag_data(sctp_skb2event(frag
));
953 sctp_assoc_rwnd_increase(event
->asoc
, len
);
954 sctp_ulpevent_release_owner(event
);
957 static void sctp_ulpevent_release_frag_data(struct sctp_ulpevent
*event
)
959 struct sk_buff
*skb
, *frag
;
961 skb
= sctp_event2skb(event
);
966 /* Don't forget the fragments. */
967 skb_walk_frags(skb
, frag
) {
968 /* NOTE: skb_shinfos are recursive. Although IP returns
969 * skb's with only 1 level of fragments, SCTP reassembly can
970 * increase the levels.
972 sctp_ulpevent_release_frag_data(sctp_skb2event(frag
));
976 sctp_ulpevent_release_owner(event
);
979 /* Free a ulpevent that has an owner. It includes releasing the reference
980 * to the owner, updating the rwnd in case of a DATA event and freeing the
983 void sctp_ulpevent_free(struct sctp_ulpevent
*event
)
985 if (sctp_ulpevent_is_notification(event
))
986 sctp_ulpevent_release_owner(event
);
988 sctp_ulpevent_release_data(event
);
990 kfree_skb(sctp_event2skb(event
));
993 /* Purge the skb lists holding ulpevents. */
994 unsigned int sctp_queue_purge_ulpevents(struct sk_buff_head
*list
)
997 unsigned int data_unread
= 0;
999 while ((skb
= skb_dequeue(list
)) != NULL
) {
1000 struct sctp_ulpevent
*event
= sctp_skb2event(skb
);
1002 if (!sctp_ulpevent_is_notification(event
))
1003 data_unread
+= skb
->len
;
1005 sctp_ulpevent_free(event
);