1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /* SCTP kernel implementation
3 * (C) Copyright IBM Corp. 2001, 2004
4 * Copyright (c) 1999-2000 Cisco, Inc.
5 * Copyright (c) 1999-2001 Motorola, Inc.
6 * Copyright (c) 2001 Intel Corp.
7 * Copyright (c) 2001 Nokia, Inc.
8 * Copyright (c) 2001 La Monte H.P. Yarroll
10 * These functions manipulate an sctp event. The struct ulpevent is used
11 * to carry notifications and data to the ULP (sockets).
13 * Please send any bug reports or fixes you make to the
15 * lksctp developers <linux-sctp@vger.kernel.org>
17 * Written or modified by:
18 * Jon Grimm <jgrimm@us.ibm.com>
19 * La Monte H.P. Yarroll <piggy@acm.org>
20 * Ardelle Fan <ardelle.fan@intel.com>
21 * Sridhar Samudrala <sri@us.ibm.com>
24 #include <linux/slab.h>
25 #include <linux/types.h>
26 #include <linux/skbuff.h>
27 #include <net/sctp/structs.h>
28 #include <net/sctp/sctp.h>
29 #include <net/sctp/sm.h>
31 static void sctp_ulpevent_receive_data(struct sctp_ulpevent *event,
32 struct sctp_association *asoc);
33 static void sctp_ulpevent_release_data(struct sctp_ulpevent *event);
34 static void sctp_ulpevent_release_frag_data(struct sctp_ulpevent *event);
37 /* Initialize an ULP event from an given skb. */
38 static void sctp_ulpevent_init(struct sctp_ulpevent *event,
42 memset(event, 0, sizeof(struct sctp_ulpevent));
43 event->msg_flags = msg_flags;
44 event->rmem_len = len;
47 /* Create a new sctp_ulpevent. */
48 static struct sctp_ulpevent *sctp_ulpevent_new(int size, __u16 msg_flags,
51 struct sctp_ulpevent *event;
54 skb = alloc_skb(size, gfp);
58 event = sctp_skb2event(skb);
59 sctp_ulpevent_init(event, msg_flags, skb->truesize);
67 /* Is this a MSG_NOTIFICATION? */
68 int sctp_ulpevent_is_notification(const struct sctp_ulpevent *event)
70 return MSG_NOTIFICATION == (event->msg_flags & MSG_NOTIFICATION);
73 /* Hold the association in case the msg_name needs read out of
76 static inline void sctp_ulpevent_set_owner(struct sctp_ulpevent *event,
77 const struct sctp_association *asoc)
79 struct sctp_chunk *chunk = event->chunk;
82 /* Cast away the const, as we are just wanting to
83 * bump the reference count.
85 sctp_association_hold((struct sctp_association *)asoc);
86 skb = sctp_event2skb(event);
87 event->asoc = (struct sctp_association *)asoc;
88 atomic_add(event->rmem_len, &event->asoc->rmem_alloc);
89 sctp_skb_set_owner_r(skb, asoc->base.sk);
90 if (chunk && chunk->head_skb && !chunk->head_skb->sk)
91 chunk->head_skb->sk = asoc->base.sk;
94 /* A simple destructor to give up the reference to the association. */
95 static inline void sctp_ulpevent_release_owner(struct sctp_ulpevent *event)
97 struct sctp_association *asoc = event->asoc;
99 atomic_sub(event->rmem_len, &asoc->rmem_alloc);
100 sctp_association_put(asoc);
103 /* Create and initialize an SCTP_ASSOC_CHANGE event.
105 * 5.3.1.1 SCTP_ASSOC_CHANGE
107 * Communication notifications inform the ULP that an SCTP association
108 * has either begun or ended. The identifier for a new association is
109 * provided by this notification.
111 * Note: There is no field checking here. If a field is unused it will be
114 struct sctp_ulpevent *sctp_ulpevent_make_assoc_change(
115 const struct sctp_association *asoc,
116 __u16 flags, __u16 state, __u16 error, __u16 outbound,
117 __u16 inbound, struct sctp_chunk *chunk, gfp_t gfp)
119 struct sctp_ulpevent *event;
120 struct sctp_assoc_change *sac;
123 /* If the lower layer passed in the chunk, it will be
124 * an ABORT, so we need to include it in the sac_info.
127 /* Copy the chunk data to a new skb and reserve enough
128 * head room to use as notification.
130 skb = skb_copy_expand(chunk->skb,
131 sizeof(struct sctp_assoc_change), 0, gfp);
136 /* Embed the event fields inside the cloned skb. */
137 event = sctp_skb2event(skb);
138 sctp_ulpevent_init(event, MSG_NOTIFICATION, skb->truesize);
140 /* Include the notification structure */
141 sac = skb_push(skb, sizeof(struct sctp_assoc_change));
143 /* Trim the buffer to the right length. */
144 skb_trim(skb, sizeof(struct sctp_assoc_change) +
145 ntohs(chunk->chunk_hdr->length) -
146 sizeof(struct sctp_chunkhdr));
148 event = sctp_ulpevent_new(sizeof(struct sctp_assoc_change),
149 MSG_NOTIFICATION, gfp);
153 skb = sctp_event2skb(event);
154 sac = skb_put(skb, sizeof(struct sctp_assoc_change));
157 /* Socket Extensions for SCTP
158 * 5.3.1.1 SCTP_ASSOC_CHANGE
161 * It should be SCTP_ASSOC_CHANGE.
163 sac->sac_type = SCTP_ASSOC_CHANGE;
165 /* Socket Extensions for SCTP
166 * 5.3.1.1 SCTP_ASSOC_CHANGE
168 * sac_state: 32 bits (signed integer)
169 * This field holds one of a number of values that communicate the
170 * event that happened to the association.
172 sac->sac_state = state;
174 /* Socket Extensions for SCTP
175 * 5.3.1.1 SCTP_ASSOC_CHANGE
177 * sac_flags: 16 bits (unsigned integer)
182 /* Socket Extensions for SCTP
183 * 5.3.1.1 SCTP_ASSOC_CHANGE
185 * sac_length: sizeof (__u32)
186 * This field is the total length of the notification data, including
187 * the notification header.
189 sac->sac_length = skb->len;
191 /* Socket Extensions for SCTP
192 * 5.3.1.1 SCTP_ASSOC_CHANGE
194 * sac_error: 32 bits (signed integer)
196 * If the state was reached due to a error condition (e.g.
197 * COMMUNICATION_LOST) any relevant error information is available in
198 * this field. This corresponds to the protocol error codes defined in
201 sac->sac_error = error;
203 /* Socket Extensions for SCTP
204 * 5.3.1.1 SCTP_ASSOC_CHANGE
206 * sac_outbound_streams: 16 bits (unsigned integer)
207 * sac_inbound_streams: 16 bits (unsigned integer)
209 * The maximum number of streams allowed in each direction are
210 * available in sac_outbound_streams and sac_inbound streams.
212 sac->sac_outbound_streams = outbound;
213 sac->sac_inbound_streams = inbound;
215 /* Socket Extensions for SCTP
216 * 5.3.1.1 SCTP_ASSOC_CHANGE
218 * sac_assoc_id: sizeof (sctp_assoc_t)
220 * The association id field, holds the identifier for the association.
221 * All notifications for a given association have the same association
222 * identifier. For TCP style socket, this field is ignored.
224 sctp_ulpevent_set_owner(event, asoc);
225 sac->sac_assoc_id = sctp_assoc2id(asoc);
233 /* Create and initialize an SCTP_PEER_ADDR_CHANGE event.
235 * Socket Extensions for SCTP - draft-01
236 * 5.3.1.2 SCTP_PEER_ADDR_CHANGE
238 * When a destination address on a multi-homed peer encounters a change
239 * an interface details event is sent.
241 struct sctp_ulpevent *sctp_ulpevent_make_peer_addr_change(
242 const struct sctp_association *asoc,
243 const struct sockaddr_storage *aaddr,
244 int flags, int state, int error, gfp_t gfp)
246 struct sctp_ulpevent *event;
247 struct sctp_paddr_change *spc;
250 event = sctp_ulpevent_new(sizeof(struct sctp_paddr_change),
251 MSG_NOTIFICATION, gfp);
255 skb = sctp_event2skb(event);
256 spc = skb_put(skb, sizeof(struct sctp_paddr_change));
258 /* Sockets API Extensions for SCTP
259 * Section 5.3.1.2 SCTP_PEER_ADDR_CHANGE
263 * It should be SCTP_PEER_ADDR_CHANGE.
265 spc->spc_type = SCTP_PEER_ADDR_CHANGE;
267 /* Sockets API Extensions for SCTP
268 * Section 5.3.1.2 SCTP_PEER_ADDR_CHANGE
270 * spc_length: sizeof (__u32)
272 * This field is the total length of the notification data, including
273 * the notification header.
275 spc->spc_length = sizeof(struct sctp_paddr_change);
277 /* Sockets API Extensions for SCTP
278 * Section 5.3.1.2 SCTP_PEER_ADDR_CHANGE
280 * spc_flags: 16 bits (unsigned integer)
285 /* Sockets API Extensions for SCTP
286 * Section 5.3.1.2 SCTP_PEER_ADDR_CHANGE
288 * spc_state: 32 bits (signed integer)
290 * This field holds one of a number of values that communicate the
291 * event that happened to the address.
293 spc->spc_state = state;
295 /* Sockets API Extensions for SCTP
296 * Section 5.3.1.2 SCTP_PEER_ADDR_CHANGE
298 * spc_error: 32 bits (signed integer)
300 * If the state was reached due to any error condition (e.g.
301 * ADDRESS_UNREACHABLE) any relevant error information is available in
304 spc->spc_error = error;
306 /* Socket Extensions for SCTP
307 * 5.3.1.1 SCTP_ASSOC_CHANGE
309 * spc_assoc_id: sizeof (sctp_assoc_t)
311 * The association id field, holds the identifier for the association.
312 * All notifications for a given association have the same association
313 * identifier. For TCP style socket, this field is ignored.
315 sctp_ulpevent_set_owner(event, asoc);
316 spc->spc_assoc_id = sctp_assoc2id(asoc);
318 /* Sockets API Extensions for SCTP
319 * Section 5.3.1.2 SCTP_PEER_ADDR_CHANGE
321 * spc_aaddr: sizeof (struct sockaddr_storage)
323 * The affected address field, holds the remote peer's address that is
324 * encountering the change of state.
326 memcpy(&spc->spc_aaddr, aaddr, sizeof(struct sockaddr_storage));
328 /* Map ipv4 address into v4-mapped-on-v6 address. */
329 sctp_get_pf_specific(asoc->base.sk->sk_family)->addr_to_user(
330 sctp_sk(asoc->base.sk),
331 (union sctp_addr *)&spc->spc_aaddr);
339 /* Create and initialize an SCTP_REMOTE_ERROR notification.
341 * Note: This assumes that the chunk->skb->data already points to the
342 * operation error payload.
344 * Socket Extensions for SCTP - draft-01
345 * 5.3.1.3 SCTP_REMOTE_ERROR
347 * A remote peer may send an Operational Error message to its peer.
348 * This message indicates a variety of error conditions on an
349 * association. The entire error TLV as it appears on the wire is
350 * included in a SCTP_REMOTE_ERROR event. Please refer to the SCTP
351 * specification [SCTP] and any extensions for a list of possible
354 struct sctp_ulpevent *
355 sctp_ulpevent_make_remote_error(const struct sctp_association *asoc,
356 struct sctp_chunk *chunk, __u16 flags,
359 struct sctp_remote_error *sre;
360 struct sctp_ulpevent *event;
361 struct sctp_errhdr *ch;
366 ch = (struct sctp_errhdr *)(chunk->skb->data);
368 elen = SCTP_PAD4(ntohs(ch->length)) - sizeof(*ch);
370 /* Pull off the ERROR header. */
371 skb_pull(chunk->skb, sizeof(*ch));
373 /* Copy the skb to a new skb with room for us to prepend
376 skb = skb_copy_expand(chunk->skb, sizeof(*sre), 0, gfp);
378 /* Pull off the rest of the cause TLV from the chunk. */
379 skb_pull(chunk->skb, elen);
383 /* Embed the event fields inside the cloned skb. */
384 event = sctp_skb2event(skb);
385 sctp_ulpevent_init(event, MSG_NOTIFICATION, skb->truesize);
387 sre = skb_push(skb, sizeof(*sre));
389 /* Trim the buffer to the right length. */
390 skb_trim(skb, sizeof(*sre) + elen);
392 /* RFC6458, Section 6.1.3. SCTP_REMOTE_ERROR */
393 memset(sre, 0, sizeof(*sre));
394 sre->sre_type = SCTP_REMOTE_ERROR;
396 sre->sre_length = skb->len;
397 sre->sre_error = cause;
398 sctp_ulpevent_set_owner(event, asoc);
399 sre->sre_assoc_id = sctp_assoc2id(asoc);
406 /* Create and initialize a SCTP_SEND_FAILED notification.
408 * Socket Extensions for SCTP - draft-01
409 * 5.3.1.4 SCTP_SEND_FAILED
411 struct sctp_ulpevent *sctp_ulpevent_make_send_failed(
412 const struct sctp_association *asoc, struct sctp_chunk *chunk,
413 __u16 flags, __u32 error, gfp_t gfp)
415 struct sctp_ulpevent *event;
416 struct sctp_send_failed *ssf;
419 /* Pull off any padding. */
420 int len = ntohs(chunk->chunk_hdr->length);
422 /* Make skb with more room so we can prepend notification. */
423 skb = skb_copy_expand(chunk->skb,
424 sizeof(struct sctp_send_failed), /* headroom */
430 /* Pull off the common chunk header and DATA header. */
431 skb_pull(skb, sctp_datachk_len(&asoc->stream));
432 len -= sctp_datachk_len(&asoc->stream);
434 /* Embed the event fields inside the cloned skb. */
435 event = sctp_skb2event(skb);
436 sctp_ulpevent_init(event, MSG_NOTIFICATION, skb->truesize);
438 ssf = skb_push(skb, sizeof(struct sctp_send_failed));
440 /* Socket Extensions for SCTP
441 * 5.3.1.4 SCTP_SEND_FAILED
444 * It should be SCTP_SEND_FAILED.
446 ssf->ssf_type = SCTP_SEND_FAILED;
448 /* Socket Extensions for SCTP
449 * 5.3.1.4 SCTP_SEND_FAILED
451 * ssf_flags: 16 bits (unsigned integer)
452 * The flag value will take one of the following values
454 * SCTP_DATA_UNSENT - Indicates that the data was never put on
457 * SCTP_DATA_SENT - Indicates that the data was put on the wire.
458 * Note that this does not necessarily mean that the
459 * data was (or was not) successfully delivered.
461 ssf->ssf_flags = flags;
463 /* Socket Extensions for SCTP
464 * 5.3.1.4 SCTP_SEND_FAILED
466 * ssf_length: sizeof (__u32)
467 * This field is the total length of the notification data, including
468 * the notification header.
470 ssf->ssf_length = sizeof(struct sctp_send_failed) + len;
471 skb_trim(skb, ssf->ssf_length);
473 /* Socket Extensions for SCTP
474 * 5.3.1.4 SCTP_SEND_FAILED
476 * ssf_error: 16 bits (unsigned integer)
477 * This value represents the reason why the send failed, and if set,
478 * will be a SCTP protocol error code as defined in [SCTP] section
481 ssf->ssf_error = error;
483 /* Socket Extensions for SCTP
484 * 5.3.1.4 SCTP_SEND_FAILED
486 * ssf_info: sizeof (struct sctp_sndrcvinfo)
487 * The original send information associated with the undelivered
490 memcpy(&ssf->ssf_info, &chunk->sinfo, sizeof(struct sctp_sndrcvinfo));
492 /* Per TSVWG discussion with Randy. Allow the application to
493 * reassemble a fragmented message.
495 ssf->ssf_info.sinfo_flags = chunk->chunk_hdr->flags;
497 /* Socket Extensions for SCTP
498 * 5.3.1.4 SCTP_SEND_FAILED
500 * ssf_assoc_id: sizeof (sctp_assoc_t)
501 * The association id field, sf_assoc_id, holds the identifier for the
502 * association. All notifications for a given association have the
503 * same association identifier. For TCP style socket, this field is
506 sctp_ulpevent_set_owner(event, asoc);
507 ssf->ssf_assoc_id = sctp_assoc2id(asoc);
514 /* Create and initialize a SCTP_SHUTDOWN_EVENT notification.
516 * Socket Extensions for SCTP - draft-01
517 * 5.3.1.5 SCTP_SHUTDOWN_EVENT
519 struct sctp_ulpevent *sctp_ulpevent_make_shutdown_event(
520 const struct sctp_association *asoc,
521 __u16 flags, gfp_t gfp)
523 struct sctp_ulpevent *event;
524 struct sctp_shutdown_event *sse;
527 event = sctp_ulpevent_new(sizeof(struct sctp_shutdown_event),
528 MSG_NOTIFICATION, gfp);
532 skb = sctp_event2skb(event);
533 sse = skb_put(skb, sizeof(struct sctp_shutdown_event));
535 /* Socket Extensions for SCTP
536 * 5.3.1.5 SCTP_SHUTDOWN_EVENT
539 * It should be SCTP_SHUTDOWN_EVENT
541 sse->sse_type = SCTP_SHUTDOWN_EVENT;
543 /* Socket Extensions for SCTP
544 * 5.3.1.5 SCTP_SHUTDOWN_EVENT
546 * sse_flags: 16 bits (unsigned integer)
551 /* Socket Extensions for SCTP
552 * 5.3.1.5 SCTP_SHUTDOWN_EVENT
554 * sse_length: sizeof (__u32)
555 * This field is the total length of the notification data, including
556 * the notification header.
558 sse->sse_length = sizeof(struct sctp_shutdown_event);
560 /* Socket Extensions for SCTP
561 * 5.3.1.5 SCTP_SHUTDOWN_EVENT
563 * sse_assoc_id: sizeof (sctp_assoc_t)
564 * The association id field, holds the identifier for the association.
565 * All notifications for a given association have the same association
566 * identifier. For TCP style socket, this field is ignored.
568 sctp_ulpevent_set_owner(event, asoc);
569 sse->sse_assoc_id = sctp_assoc2id(asoc);
577 /* Create and initialize a SCTP_ADAPTATION_INDICATION notification.
579 * Socket Extensions for SCTP
580 * 5.3.1.6 SCTP_ADAPTATION_INDICATION
582 struct sctp_ulpevent *sctp_ulpevent_make_adaptation_indication(
583 const struct sctp_association *asoc, gfp_t gfp)
585 struct sctp_ulpevent *event;
586 struct sctp_adaptation_event *sai;
589 event = sctp_ulpevent_new(sizeof(struct sctp_adaptation_event),
590 MSG_NOTIFICATION, gfp);
594 skb = sctp_event2skb(event);
595 sai = skb_put(skb, sizeof(struct sctp_adaptation_event));
597 sai->sai_type = SCTP_ADAPTATION_INDICATION;
599 sai->sai_length = sizeof(struct sctp_adaptation_event);
600 sai->sai_adaptation_ind = asoc->peer.adaptation_ind;
601 sctp_ulpevent_set_owner(event, asoc);
602 sai->sai_assoc_id = sctp_assoc2id(asoc);
610 /* A message has been received. Package this message as a notification
611 * to pass it to the upper layers. Go ahead and calculate the sndrcvinfo
612 * even if filtered out later.
614 * Socket Extensions for SCTP
615 * 5.2.2 SCTP Header Information Structure (SCTP_SNDRCV)
617 struct sctp_ulpevent *sctp_ulpevent_make_rcvmsg(struct sctp_association *asoc,
618 struct sctp_chunk *chunk,
621 struct sctp_ulpevent *event = NULL;
622 struct sk_buff *skb = chunk->skb;
623 struct sock *sk = asoc->base.sk;
624 size_t padding, datalen;
628 * check to see if we need to make space for this
629 * new skb, expand the rcvbuffer if needed, or drop
632 if (asoc->ep->rcvbuf_policy)
633 rx_count = atomic_read(&asoc->rmem_alloc);
635 rx_count = atomic_read(&sk->sk_rmem_alloc);
637 datalen = ntohs(chunk->chunk_hdr->length);
639 if (rx_count >= sk->sk_rcvbuf || !sk_rmem_schedule(sk, skb, datalen))
642 /* Clone the original skb, sharing the data. */
643 skb = skb_clone(chunk->skb, gfp);
647 /* Now that all memory allocations for this chunk succeeded, we
648 * can mark it as received so the tsn_map is updated correctly.
650 if (sctp_tsnmap_mark(&asoc->peer.tsn_map,
651 ntohl(chunk->subh.data_hdr->tsn),
655 /* First calculate the padding, so we don't inadvertently
656 * pass up the wrong length to the user.
658 * RFC 2960 - Section 3.2 Chunk Field Descriptions
660 * The total length of a chunk(including Type, Length and Value fields)
661 * MUST be a multiple of 4 bytes. If the length of the chunk is not a
662 * multiple of 4 bytes, the sender MUST pad the chunk with all zero
663 * bytes and this padding is not included in the chunk length field.
664 * The sender should never pad with more than 3 bytes. The receiver
665 * MUST ignore the padding bytes.
667 padding = SCTP_PAD4(datalen) - datalen;
669 /* Fixup cloned skb with just this chunks data. */
670 skb_trim(skb, chunk->chunk_end - padding - skb->data);
672 /* Embed the event fields inside the cloned skb. */
673 event = sctp_skb2event(skb);
675 /* Initialize event with flags 0 and correct length
676 * Since this is a clone of the original skb, only account for
677 * the data of this chunk as other chunks will be accounted separately.
679 sctp_ulpevent_init(event, 0, skb->len + sizeof(struct sk_buff));
681 /* And hold the chunk as we need it for getting the IP headers
684 sctp_chunk_hold(chunk);
685 event->chunk = chunk;
687 sctp_ulpevent_receive_data(event, asoc);
689 event->stream = ntohs(chunk->subh.data_hdr->stream);
690 if (chunk->chunk_hdr->flags & SCTP_DATA_UNORDERED) {
691 event->flags |= SCTP_UNORDERED;
692 event->cumtsn = sctp_tsnmap_get_ctsn(&asoc->peer.tsn_map);
694 event->tsn = ntohl(chunk->subh.data_hdr->tsn);
695 event->msg_flags |= chunk->chunk_hdr->flags;
705 /* Create a partial delivery related event.
707 * 5.3.1.7 SCTP_PARTIAL_DELIVERY_EVENT
709 * When a receiver is engaged in a partial delivery of a
710 * message this notification will be used to indicate
713 struct sctp_ulpevent *sctp_ulpevent_make_pdapi(
714 const struct sctp_association *asoc,
715 __u32 indication, __u32 sid, __u32 seq,
716 __u32 flags, gfp_t gfp)
718 struct sctp_ulpevent *event;
719 struct sctp_pdapi_event *pd;
722 event = sctp_ulpevent_new(sizeof(struct sctp_pdapi_event),
723 MSG_NOTIFICATION, gfp);
727 skb = sctp_event2skb(event);
728 pd = skb_put(skb, sizeof(struct sctp_pdapi_event));
731 * It should be SCTP_PARTIAL_DELIVERY_EVENT
733 * pdapi_flags: 16 bits (unsigned integer)
736 pd->pdapi_type = SCTP_PARTIAL_DELIVERY_EVENT;
737 pd->pdapi_flags = flags;
738 pd->pdapi_stream = sid;
741 /* pdapi_length: 32 bits (unsigned integer)
743 * This field is the total length of the notification data, including
744 * the notification header. It will generally be sizeof (struct
747 pd->pdapi_length = sizeof(struct sctp_pdapi_event);
749 /* pdapi_indication: 32 bits (unsigned integer)
751 * This field holds the indication being sent to the application.
753 pd->pdapi_indication = indication;
755 /* pdapi_assoc_id: sizeof (sctp_assoc_t)
757 * The association id field, holds the identifier for the association.
759 sctp_ulpevent_set_owner(event, asoc);
760 pd->pdapi_assoc_id = sctp_assoc2id(asoc);
767 struct sctp_ulpevent *sctp_ulpevent_make_authkey(
768 const struct sctp_association *asoc, __u16 key_id,
769 __u32 indication, gfp_t gfp)
771 struct sctp_ulpevent *event;
772 struct sctp_authkey_event *ak;
775 event = sctp_ulpevent_new(sizeof(struct sctp_authkey_event),
776 MSG_NOTIFICATION, gfp);
780 skb = sctp_event2skb(event);
781 ak = skb_put(skb, sizeof(struct sctp_authkey_event));
783 ak->auth_type = SCTP_AUTHENTICATION_EVENT;
785 ak->auth_length = sizeof(struct sctp_authkey_event);
787 ak->auth_keynumber = key_id;
788 ak->auth_altkeynumber = 0;
789 ak->auth_indication = indication;
792 * The association id field, holds the identifier for the association.
794 sctp_ulpevent_set_owner(event, asoc);
795 ak->auth_assoc_id = sctp_assoc2id(asoc);
803 * Socket Extensions for SCTP
804 * 6.3.10. SCTP_SENDER_DRY_EVENT
806 struct sctp_ulpevent *sctp_ulpevent_make_sender_dry_event(
807 const struct sctp_association *asoc, gfp_t gfp)
809 struct sctp_ulpevent *event;
810 struct sctp_sender_dry_event *sdry;
813 event = sctp_ulpevent_new(sizeof(struct sctp_sender_dry_event),
814 MSG_NOTIFICATION, gfp);
818 skb = sctp_event2skb(event);
819 sdry = skb_put(skb, sizeof(struct sctp_sender_dry_event));
821 sdry->sender_dry_type = SCTP_SENDER_DRY_EVENT;
822 sdry->sender_dry_flags = 0;
823 sdry->sender_dry_length = sizeof(struct sctp_sender_dry_event);
824 sctp_ulpevent_set_owner(event, asoc);
825 sdry->sender_dry_assoc_id = sctp_assoc2id(asoc);
830 struct sctp_ulpevent *sctp_ulpevent_make_stream_reset_event(
831 const struct sctp_association *asoc, __u16 flags, __u16 stream_num,
832 __be16 *stream_list, gfp_t gfp)
834 struct sctp_stream_reset_event *sreset;
835 struct sctp_ulpevent *event;
839 length = sizeof(struct sctp_stream_reset_event) + 2 * stream_num;
840 event = sctp_ulpevent_new(length, MSG_NOTIFICATION, gfp);
844 skb = sctp_event2skb(event);
845 sreset = skb_put(skb, length);
847 sreset->strreset_type = SCTP_STREAM_RESET_EVENT;
848 sreset->strreset_flags = flags;
849 sreset->strreset_length = length;
850 sctp_ulpevent_set_owner(event, asoc);
851 sreset->strreset_assoc_id = sctp_assoc2id(asoc);
853 for (i = 0; i < stream_num; i++)
854 sreset->strreset_stream_list[i] = ntohs(stream_list[i]);
859 struct sctp_ulpevent *sctp_ulpevent_make_assoc_reset_event(
860 const struct sctp_association *asoc, __u16 flags, __u32 local_tsn,
861 __u32 remote_tsn, gfp_t gfp)
863 struct sctp_assoc_reset_event *areset;
864 struct sctp_ulpevent *event;
867 event = sctp_ulpevent_new(sizeof(struct sctp_assoc_reset_event),
868 MSG_NOTIFICATION, gfp);
872 skb = sctp_event2skb(event);
873 areset = skb_put(skb, sizeof(struct sctp_assoc_reset_event));
875 areset->assocreset_type = SCTP_ASSOC_RESET_EVENT;
876 areset->assocreset_flags = flags;
877 areset->assocreset_length = sizeof(struct sctp_assoc_reset_event);
878 sctp_ulpevent_set_owner(event, asoc);
879 areset->assocreset_assoc_id = sctp_assoc2id(asoc);
880 areset->assocreset_local_tsn = local_tsn;
881 areset->assocreset_remote_tsn = remote_tsn;
886 struct sctp_ulpevent *sctp_ulpevent_make_stream_change_event(
887 const struct sctp_association *asoc, __u16 flags,
888 __u32 strchange_instrms, __u32 strchange_outstrms, gfp_t gfp)
890 struct sctp_stream_change_event *schange;
891 struct sctp_ulpevent *event;
894 event = sctp_ulpevent_new(sizeof(struct sctp_stream_change_event),
895 MSG_NOTIFICATION, gfp);
899 skb = sctp_event2skb(event);
900 schange = skb_put(skb, sizeof(struct sctp_stream_change_event));
902 schange->strchange_type = SCTP_STREAM_CHANGE_EVENT;
903 schange->strchange_flags = flags;
904 schange->strchange_length = sizeof(struct sctp_stream_change_event);
905 sctp_ulpevent_set_owner(event, asoc);
906 schange->strchange_assoc_id = sctp_assoc2id(asoc);
907 schange->strchange_instrms = strchange_instrms;
908 schange->strchange_outstrms = strchange_outstrms;
913 /* Return the notification type, assuming this is a notification
916 __u16 sctp_ulpevent_get_notification_type(const struct sctp_ulpevent *event)
918 union sctp_notification *notification;
921 skb = sctp_event2skb(event);
922 notification = (union sctp_notification *) skb->data;
923 return notification->sn_header.sn_type;
926 /* RFC6458, Section 5.3.2. SCTP Header Information Structure
927 * (SCTP_SNDRCV, DEPRECATED)
929 void sctp_ulpevent_read_sndrcvinfo(const struct sctp_ulpevent *event,
930 struct msghdr *msghdr)
932 struct sctp_sndrcvinfo sinfo;
934 if (sctp_ulpevent_is_notification(event))
937 memset(&sinfo, 0, sizeof(sinfo));
938 sinfo.sinfo_stream = event->stream;
939 sinfo.sinfo_ssn = event->ssn;
940 sinfo.sinfo_ppid = event->ppid;
941 sinfo.sinfo_flags = event->flags;
942 sinfo.sinfo_tsn = event->tsn;
943 sinfo.sinfo_cumtsn = event->cumtsn;
944 sinfo.sinfo_assoc_id = sctp_assoc2id(event->asoc);
945 /* Context value that is set via SCTP_CONTEXT socket option. */
946 sinfo.sinfo_context = event->asoc->default_rcv_context;
947 /* These fields are not used while receiving. */
948 sinfo.sinfo_timetolive = 0;
950 put_cmsg(msghdr, IPPROTO_SCTP, SCTP_SNDRCV,
951 sizeof(sinfo), &sinfo);
954 /* RFC6458, Section 5.3.5 SCTP Receive Information Structure
957 void sctp_ulpevent_read_rcvinfo(const struct sctp_ulpevent *event,
958 struct msghdr *msghdr)
960 struct sctp_rcvinfo rinfo;
962 if (sctp_ulpevent_is_notification(event))
965 memset(&rinfo, 0, sizeof(struct sctp_rcvinfo));
966 rinfo.rcv_sid = event->stream;
967 rinfo.rcv_ssn = event->ssn;
968 rinfo.rcv_ppid = event->ppid;
969 rinfo.rcv_flags = event->flags;
970 rinfo.rcv_tsn = event->tsn;
971 rinfo.rcv_cumtsn = event->cumtsn;
972 rinfo.rcv_assoc_id = sctp_assoc2id(event->asoc);
973 rinfo.rcv_context = event->asoc->default_rcv_context;
975 put_cmsg(msghdr, IPPROTO_SCTP, SCTP_RCVINFO,
976 sizeof(rinfo), &rinfo);
979 /* RFC6458, Section 5.3.6. SCTP Next Receive Information Structure
982 static void __sctp_ulpevent_read_nxtinfo(const struct sctp_ulpevent *event,
983 struct msghdr *msghdr,
984 const struct sk_buff *skb)
986 struct sctp_nxtinfo nxtinfo;
988 memset(&nxtinfo, 0, sizeof(nxtinfo));
989 nxtinfo.nxt_sid = event->stream;
990 nxtinfo.nxt_ppid = event->ppid;
991 nxtinfo.nxt_flags = event->flags;
992 if (sctp_ulpevent_is_notification(event))
993 nxtinfo.nxt_flags |= SCTP_NOTIFICATION;
994 nxtinfo.nxt_length = skb->len;
995 nxtinfo.nxt_assoc_id = sctp_assoc2id(event->asoc);
997 put_cmsg(msghdr, IPPROTO_SCTP, SCTP_NXTINFO,
998 sizeof(nxtinfo), &nxtinfo);
1001 void sctp_ulpevent_read_nxtinfo(const struct sctp_ulpevent *event,
1002 struct msghdr *msghdr,
1005 struct sk_buff *skb;
1008 skb = sctp_skb_recv_datagram(sk, MSG_PEEK, 1, &err);
1010 __sctp_ulpevent_read_nxtinfo(sctp_skb2event(skb),
1012 /* Just release refcount here. */
1017 /* Do accounting for bytes received and hold a reference to the association
1020 static void sctp_ulpevent_receive_data(struct sctp_ulpevent *event,
1021 struct sctp_association *asoc)
1023 struct sk_buff *skb, *frag;
1025 skb = sctp_event2skb(event);
1026 /* Set the owner and charge rwnd for bytes received. */
1027 sctp_ulpevent_set_owner(event, asoc);
1028 sctp_assoc_rwnd_decrease(asoc, skb_headlen(skb));
1033 /* Note: Not clearing the entire event struct as this is just a
1034 * fragment of the real event. However, we still need to do rwnd
1036 * In general, the skb passed from IP can have only 1 level of
1037 * fragments. But we allow multiple levels of fragments.
1039 skb_walk_frags(skb, frag)
1040 sctp_ulpevent_receive_data(sctp_skb2event(frag), asoc);
1043 /* Do accounting for bytes just read by user and release the references to
1046 static void sctp_ulpevent_release_data(struct sctp_ulpevent *event)
1048 struct sk_buff *skb, *frag;
1051 /* Current stack structures assume that the rcv buffer is
1052 * per socket. For UDP style sockets this is not true as
1053 * multiple associations may be on a single UDP-style socket.
1054 * Use the local private area of the skb to track the owning
1058 skb = sctp_event2skb(event);
1064 /* Don't forget the fragments. */
1065 skb_walk_frags(skb, frag) {
1066 /* NOTE: skb_shinfos are recursive. Although IP returns
1067 * skb's with only 1 level of fragments, SCTP reassembly can
1068 * increase the levels.
1070 sctp_ulpevent_release_frag_data(sctp_skb2event(frag));
1074 sctp_assoc_rwnd_increase(event->asoc, len);
1075 sctp_chunk_put(event->chunk);
1076 sctp_ulpevent_release_owner(event);
1079 static void sctp_ulpevent_release_frag_data(struct sctp_ulpevent *event)
1081 struct sk_buff *skb, *frag;
1083 skb = sctp_event2skb(event);
1088 /* Don't forget the fragments. */
1089 skb_walk_frags(skb, frag) {
1090 /* NOTE: skb_shinfos are recursive. Although IP returns
1091 * skb's with only 1 level of fragments, SCTP reassembly can
1092 * increase the levels.
1094 sctp_ulpevent_release_frag_data(sctp_skb2event(frag));
1098 sctp_chunk_put(event->chunk);
1099 sctp_ulpevent_release_owner(event);
1102 /* Free a ulpevent that has an owner. It includes releasing the reference
1103 * to the owner, updating the rwnd in case of a DATA event and freeing the
1106 void sctp_ulpevent_free(struct sctp_ulpevent *event)
1108 if (sctp_ulpevent_is_notification(event))
1109 sctp_ulpevent_release_owner(event);
1111 sctp_ulpevent_release_data(event);
1113 kfree_skb(sctp_event2skb(event));
1116 /* Purge the skb lists holding ulpevents. */
1117 unsigned int sctp_queue_purge_ulpevents(struct sk_buff_head *list)
1119 struct sk_buff *skb;
1120 unsigned int data_unread = 0;
1122 while ((skb = skb_dequeue(list)) != NULL) {
1123 struct sctp_ulpevent *event = sctp_skb2event(skb);
1125 if (!sctp_ulpevent_is_notification(event))
1126 data_unread += skb->len;
1128 sctp_ulpevent_free(event);