net/sctp/ulpevent.c

   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
   8  *
   9  * These functions manipulate an sctp event.   The struct ulpevent is used
  10  * to carry notifications and data to the ULP (sockets).
  11  *
  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)
  16  * any later version.
  17  *
  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.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with GNU CC; see the file COPYING.  If not, see
  26  * <http://www.gnu.org/licenses/>.
  27  *
  28  * Please send any bug reports or fixes you make to the
  29  * email address(es):
  30  *    lksctp developers <linux-sctp@vger.kernel.org>
  31  *
  32  * Written or modified by:
  33  *    Jon Grimm             <jgrimm@us.ibm.com>
  34  *    La Monte H.P. Yarroll <piggy@acm.org>
  35  *    Ardelle Fan           <ardelle.fan@intel.com>
  36  *    Sridhar Samudrala     <sri@us.ibm.com>
  37  */
  38
  39 #include <linux/slab.h>
  40 #include <linux/types.h>
  41 #include <linux/skbuff.h>
  42 #include <net/sctp/structs.h>
  43 #include <net/sctp/sctp.h>
  44 #include <net/sctp/sm.h>
  45
  46 static void sctp_ulpevent_receive_data(struct sctp_ulpevent *event,
  47                                        struct sctp_association *asoc);
  48 static void sctp_ulpevent_release_data(struct sctp_ulpevent *event);
  49 static void sctp_ulpevent_release_frag_data(struct sctp_ulpevent *event);
  50
  51
  52 /* Initialize an ULP event from an given skb.  */
  53 static void sctp_ulpevent_init(struct sctp_ulpevent *event,
  54                                __u16 msg_flags,
  55                                unsigned int len)
  56 {
  57         memset(event, 0, sizeof(struct sctp_ulpevent));
  58         event->msg_flags = msg_flags;
  59         event->rmem_len = len;
  60 }
  61
  62 /* Create a new sctp_ulpevent.  */
  63 static struct sctp_ulpevent *sctp_ulpevent_new(int size, __u16 msg_flags,
  64                                                gfp_t gfp)
  65 {
  66         struct sctp_ulpevent *event;
  67         struct sk_buff *skb;
  68
  69         skb = alloc_skb(size, gfp);
  70         if (!skb)
  71                 goto fail;
  72
  73         event = sctp_skb2event(skb);
  74         sctp_ulpevent_init(event, msg_flags, skb->truesize);
  75
  76         return event;
  77
  78 fail:
  79         return NULL;
  80 }
  81
  82 /* Is this a MSG_NOTIFICATION?  */
  83 int sctp_ulpevent_is_notification(const struct sctp_ulpevent *event)
  84 {
  85         return MSG_NOTIFICATION == (event->msg_flags & MSG_NOTIFICATION);
  86 }
  87
  88 /* Hold the association in case the msg_name needs read out of
  89  * the association.
  90  */
  91 static inline void sctp_ulpevent_set_owner(struct sctp_ulpevent *event,
  92                                            const struct sctp_association *asoc)
  93 {
  94         struct sctp_chunk *chunk = event->chunk;
  95         struct sk_buff *skb;
  96
  97         /* Cast away the const, as we are just wanting to
  98          * bump the reference count.
  99          */
 100         sctp_association_hold((struct sctp_association *)asoc);
 101         skb = sctp_event2skb(event);
 102         event->asoc = (struct sctp_association *)asoc;
 103         atomic_add(event->rmem_len, &event->asoc->rmem_alloc);
 104         sctp_skb_set_owner_r(skb, asoc->base.sk);
 105         if (chunk && chunk->head_skb && !chunk->head_skb->sk)
 106                 chunk->head_skb->sk = asoc->base.sk;
 107 }
 108
 109 /* A simple destructor to give up the reference to the association. */
 110 static inline void sctp_ulpevent_release_owner(struct sctp_ulpevent *event)
 111 {
 112         struct sctp_association *asoc = event->asoc;
 113
 114         atomic_sub(event->rmem_len, &asoc->rmem_alloc);
 115         sctp_association_put(asoc);
 116 }
 117
 118 /* Create and initialize an SCTP_ASSOC_CHANGE event.
 119  *
 120  * 5.3.1.1 SCTP_ASSOC_CHANGE
 121  *
 122  * Communication notifications inform the ULP that an SCTP association
 123  * has either begun or ended. The identifier for a new association is
 124  * provided by this notification.
 125  *
 126  * Note: There is no field checking here.  If a field is unused it will be
 127  * zero'd out.
 128  */
 129 struct sctp_ulpevent  *sctp_ulpevent_make_assoc_change(
 130         const struct sctp_association *asoc,
 131         __u16 flags, __u16 state, __u16 error, __u16 outbound,
 132         __u16 inbound, struct sctp_chunk *chunk, gfp_t gfp)
 133 {
 134         struct sctp_ulpevent *event;
 135         struct sctp_assoc_change *sac;
 136         struct sk_buff *skb;
 137
 138         /* If the lower layer passed in the chunk, it will be
 139          * an ABORT, so we need to include it in the sac_info.
 140          */
 141         if (chunk) {
 142                 /* Copy the chunk data to a new skb and reserve enough
 143                  * head room to use as notification.
 144                  */
 145                 skb = skb_copy_expand(chunk->skb,
 146                                       sizeof(struct sctp_assoc_change), 0, gfp);
 147
 148                 if (!skb)
 149                         goto fail;
 150
 151                 /* Embed the event fields inside the cloned skb.  */
 152                 event = sctp_skb2event(skb);
 153                 sctp_ulpevent_init(event, MSG_NOTIFICATION, skb->truesize);
 154
 155                 /* Include the notification structure */
 156                 sac = (struct sctp_assoc_change *)
 157                         skb_push(skb, sizeof(struct sctp_assoc_change));
 158
 159                 /* Trim the buffer to the right length.  */
 160                 skb_trim(skb, sizeof(struct sctp_assoc_change) +
 161                          ntohs(chunk->chunk_hdr->length) -
 162                          sizeof(sctp_chunkhdr_t));
 163         } else {
 164                 event = sctp_ulpevent_new(sizeof(struct sctp_assoc_change),
 165                                   MSG_NOTIFICATION, gfp);
 166                 if (!event)
 167                         goto fail;
 168
 169                 skb = sctp_event2skb(event);
 170                 sac = (struct sctp_assoc_change *) skb_put(skb,
 171                                         sizeof(struct sctp_assoc_change));
 172         }
 173
 174         /* Socket Extensions for SCTP
 175          * 5.3.1.1 SCTP_ASSOC_CHANGE
 176          *
 177          * sac_type:
 178          * It should be SCTP_ASSOC_CHANGE.
 179          */
 180         sac->sac_type = SCTP_ASSOC_CHANGE;
 181
 182         /* Socket Extensions for SCTP
 183          * 5.3.1.1 SCTP_ASSOC_CHANGE
 184          *
 185          * sac_state: 32 bits (signed integer)
 186          * This field holds one of a number of values that communicate the
 187          * event that happened to the association.
 188          */
 189         sac->sac_state = state;
 190
 191         /* Socket Extensions for SCTP
 192          * 5.3.1.1 SCTP_ASSOC_CHANGE
 193          *
 194          * sac_flags: 16 bits (unsigned integer)
 195          * Currently unused.
 196          */
 197         sac->sac_flags = 0;
 198
 199         /* Socket Extensions for SCTP
 200          * 5.3.1.1 SCTP_ASSOC_CHANGE
 201          *
 202          * sac_length: sizeof (__u32)
 203          * This field is the total length of the notification data, including
 204          * the notification header.
 205          */
 206         sac->sac_length = skb->len;
 207
 208         /* Socket Extensions for SCTP
 209          * 5.3.1.1 SCTP_ASSOC_CHANGE
 210          *
 211          * sac_error:  32 bits (signed integer)
 212          *
 213          * If the state was reached due to a error condition (e.g.
 214          * COMMUNICATION_LOST) any relevant error information is available in
 215          * this field. This corresponds to the protocol error codes defined in
 216          * [SCTP].
 217          */
 218         sac->sac_error = error;
 219
 220         /* Socket Extensions for SCTP
 221          * 5.3.1.1 SCTP_ASSOC_CHANGE
 222          *
 223          * sac_outbound_streams:  16 bits (unsigned integer)
 224          * sac_inbound_streams:  16 bits (unsigned integer)
 225          *
 226          * The maximum number of streams allowed in each direction are
 227          * available in sac_outbound_streams and sac_inbound streams.
 228          */
 229         sac->sac_outbound_streams = outbound;
 230         sac->sac_inbound_streams = inbound;
 231
 232         /* Socket Extensions for SCTP
 233          * 5.3.1.1 SCTP_ASSOC_CHANGE
 234          *
 235          * sac_assoc_id: sizeof (sctp_assoc_t)
 236          *
 237          * The association id field, holds the identifier for the association.
 238          * All notifications for a given association have the same association
 239          * identifier.  For TCP style socket, this field is ignored.
 240          */
 241         sctp_ulpevent_set_owner(event, asoc);
 242         sac->sac_assoc_id = sctp_assoc2id(asoc);
 243
 244         return event;
 245
 246 fail:
 247         return NULL;
 248 }
 249
 250 /* Create and initialize an SCTP_PEER_ADDR_CHANGE event.
 251  *
 252  * Socket Extensions for SCTP - draft-01
 253  * 5.3.1.2 SCTP_PEER_ADDR_CHANGE
 254  *
 255  * When a destination address on a multi-homed peer encounters a change
 256  * an interface details event is sent.
 257  */
 258 struct sctp_ulpevent *sctp_ulpevent_make_peer_addr_change(
 259         const struct sctp_association *asoc,
 260         const struct sockaddr_storage *aaddr,
 261         int flags, int state, int error, gfp_t gfp)
 262 {
 263         struct sctp_ulpevent *event;
 264         struct sctp_paddr_change  *spc;
 265         struct sk_buff *skb;
 266
 267         event = sctp_ulpevent_new(sizeof(struct sctp_paddr_change),
 268                                   MSG_NOTIFICATION, gfp);
 269         if (!event)
 270                 goto fail;
 271
 272         skb = sctp_event2skb(event);
 273         spc = (struct sctp_paddr_change *)
 274                 skb_put(skb, sizeof(struct sctp_paddr_change));
 275
 276         /* Sockets API Extensions for SCTP
 277          * Section 5.3.1.2 SCTP_PEER_ADDR_CHANGE
 278          *
 279          * spc_type:
 280          *
 281          *    It should be SCTP_PEER_ADDR_CHANGE.
 282          */
 283         spc->spc_type = SCTP_PEER_ADDR_CHANGE;
 284
 285         /* Sockets API Extensions for SCTP
 286          * Section 5.3.1.2 SCTP_PEER_ADDR_CHANGE
 287          *
 288          * spc_length: sizeof (__u32)
 289          *
 290          * This field is the total length of the notification data, including
 291          * the notification header.
 292          */
 293         spc->spc_length = sizeof(struct sctp_paddr_change);
 294
 295         /* Sockets API Extensions for SCTP
 296          * Section 5.3.1.2 SCTP_PEER_ADDR_CHANGE
 297          *
 298          * spc_flags: 16 bits (unsigned integer)
 299          * Currently unused.
 300          */
 301         spc->spc_flags = 0;
 302
 303         /* Sockets API Extensions for SCTP
 304          * Section 5.3.1.2 SCTP_PEER_ADDR_CHANGE
 305          *
 306          * spc_state:  32 bits (signed integer)
 307          *
 308          * This field holds one of a number of values that communicate the
 309          * event that happened to the address.
 310          */
 311         spc->spc_state = state;
 312
 313         /* Sockets API Extensions for SCTP
 314          * Section 5.3.1.2 SCTP_PEER_ADDR_CHANGE
 315          *
 316          * spc_error:  32 bits (signed integer)
 317          *
 318          * If the state was reached due to any error condition (e.g.
 319          * ADDRESS_UNREACHABLE) any relevant error information is available in
 320          * this field.
 321          */
 322         spc->spc_error = error;
 323
 324         /* Socket Extensions for SCTP
 325          * 5.3.1.1 SCTP_ASSOC_CHANGE
 326          *
 327          * spc_assoc_id: sizeof (sctp_assoc_t)
 328          *
 329          * The association id field, holds the identifier for the association.
 330          * All notifications for a given association have the same association
 331          * identifier.  For TCP style socket, this field is ignored.
 332          */
 333         sctp_ulpevent_set_owner(event, asoc);
 334         spc->spc_assoc_id = sctp_assoc2id(asoc);
 335
 336         /* Sockets API Extensions for SCTP
 337          * Section 5.3.1.2 SCTP_PEER_ADDR_CHANGE
 338          *
 339          * spc_aaddr: sizeof (struct sockaddr_storage)
 340          *
 341          * The affected address field, holds the remote peer's address that is
 342          * encountering the change of state.
 343          */
 344         memcpy(&spc->spc_aaddr, aaddr, sizeof(struct sockaddr_storage));
 345
 346         /* Map ipv4 address into v4-mapped-on-v6 address.  */
 347         sctp_get_pf_specific(asoc->base.sk->sk_family)->addr_to_user(
 348                                         sctp_sk(asoc->base.sk),
 349                                         (union sctp_addr *)&spc->spc_aaddr);
 350
 351         return event;
 352
 353 fail:
 354         return NULL;
 355 }
 356
 357 /* Create and initialize an SCTP_REMOTE_ERROR notification.
 358  *
 359  * Note: This assumes that the chunk->skb->data already points to the
 360  * operation error payload.
 361  *
 362  * Socket Extensions for SCTP - draft-01
 363  * 5.3.1.3 SCTP_REMOTE_ERROR
 364  *
 365  * A remote peer may send an Operational Error message to its peer.
 366  * This message indicates a variety of error conditions on an
 367  * association. The entire error TLV as it appears on the wire is
 368  * included in a SCTP_REMOTE_ERROR event.  Please refer to the SCTP
 369  * specification [SCTP] and any extensions for a list of possible
 370  * error formats.
 371  */
 372 struct sctp_ulpevent *
 373 sctp_ulpevent_make_remote_error(const struct sctp_association *asoc,
 374                                 struct sctp_chunk *chunk, __u16 flags,
 375                                 gfp_t gfp)
 376 {
 377         struct sctp_ulpevent *event;
 378         struct sctp_remote_error *sre;
 379         struct sk_buff *skb;
 380         sctp_errhdr_t *ch;
 381         __be16 cause;
 382         int elen;
 383
 384         ch = (sctp_errhdr_t *)(chunk->skb->data);
 385         cause = ch->cause;
 386         elen = WORD_ROUND(ntohs(ch->length)) - sizeof(sctp_errhdr_t);
 387
 388         /* Pull off the ERROR header.  */
 389         skb_pull(chunk->skb, sizeof(sctp_errhdr_t));
 390
 391         /* Copy the skb to a new skb with room for us to prepend
 392          * notification with.
 393          */
 394         skb = skb_copy_expand(chunk->skb, sizeof(*sre), 0, gfp);
 395
 396         /* Pull off the rest of the cause TLV from the chunk.  */
 397         skb_pull(chunk->skb, elen);
 398         if (!skb)
 399                 goto fail;
 400
 401         /* Embed the event fields inside the cloned skb.  */
 402         event = sctp_skb2event(skb);
 403         sctp_ulpevent_init(event, MSG_NOTIFICATION, skb->truesize);
 404
 405         sre = (struct sctp_remote_error *) skb_push(skb, sizeof(*sre));
 406
 407         /* Trim the buffer to the right length.  */
 408         skb_trim(skb, sizeof(*sre) + elen);
 409
 410         /* RFC6458, Section 6.1.3. SCTP_REMOTE_ERROR */
 411         memset(sre, 0, sizeof(*sre));
 412         sre->sre_type = SCTP_REMOTE_ERROR;
 413         sre->sre_flags = 0;
 414         sre->sre_length = skb->len;
 415         sre->sre_error = cause;
 416         sctp_ulpevent_set_owner(event, asoc);
 417         sre->sre_assoc_id = sctp_assoc2id(asoc);
 418
 419         return event;
 420 fail:
 421         return NULL;
 422 }
 423
 424 /* Create and initialize a SCTP_SEND_FAILED notification.
 425  *
 426  * Socket Extensions for SCTP - draft-01
 427  * 5.3.1.4 SCTP_SEND_FAILED
 428  */
 429 struct sctp_ulpevent *sctp_ulpevent_make_send_failed(
 430         const struct sctp_association *asoc, struct sctp_chunk *chunk,
 431         __u16 flags, __u32 error, gfp_t gfp)
 432 {
 433         struct sctp_ulpevent *event;
 434         struct sctp_send_failed *ssf;
 435         struct sk_buff *skb;
 436
 437         /* Pull off any padding. */
 438         int len = ntohs(chunk->chunk_hdr->length);
 439
 440         /* Make skb with more room so we can prepend notification.  */
 441         skb = skb_copy_expand(chunk->skb,
 442                               sizeof(struct sctp_send_failed), /* headroom */
 443                               0,                               /* tailroom */
 444                               gfp);
 445         if (!skb)
 446                 goto fail;
 447
 448         /* Pull off the common chunk header and DATA header.  */
 449         skb_pull(skb, sizeof(struct sctp_data_chunk));
 450         len -= sizeof(struct sctp_data_chunk);
 451
 452         /* Embed the event fields inside the cloned skb.  */
 453         event = sctp_skb2event(skb);
 454         sctp_ulpevent_init(event, MSG_NOTIFICATION, skb->truesize);
 455
 456         ssf = (struct sctp_send_failed *)
 457                 skb_push(skb, sizeof(struct sctp_send_failed));
 458
 459         /* Socket Extensions for SCTP
 460          * 5.3.1.4 SCTP_SEND_FAILED
 461          *
 462          * ssf_type:
 463          * It should be SCTP_SEND_FAILED.
 464          */
 465         ssf->ssf_type = SCTP_SEND_FAILED;
 466
 467         /* Socket Extensions for SCTP
 468          * 5.3.1.4 SCTP_SEND_FAILED
 469          *
 470          * ssf_flags: 16 bits (unsigned integer)
 471          * The flag value will take one of the following values
 472          *
 473          * SCTP_DATA_UNSENT - Indicates that the data was never put on
 474          *                    the wire.
 475          *
 476          * SCTP_DATA_SENT   - Indicates that the data was put on the wire.
 477          *                    Note that this does not necessarily mean that the
 478          *                    data was (or was not) successfully delivered.
 479          */
 480         ssf->ssf_flags = flags;
 481
 482         /* Socket Extensions for SCTP
 483          * 5.3.1.4 SCTP_SEND_FAILED
 484          *
 485          * ssf_length: sizeof (__u32)
 486          * This field is the total length of the notification data, including
 487          * the notification header.
 488          */
 489         ssf->ssf_length = sizeof(struct sctp_send_failed) + len;
 490         skb_trim(skb, ssf->ssf_length);
 491
 492         /* Socket Extensions for SCTP
 493          * 5.3.1.4 SCTP_SEND_FAILED
 494          *
 495          * ssf_error: 16 bits (unsigned integer)
 496          * This value represents the reason why the send failed, and if set,
 497          * will be a SCTP protocol error code as defined in [SCTP] section
 498          * 3.3.10.
 499          */
 500         ssf->ssf_error = error;
 501
 502         /* Socket Extensions for SCTP
 503          * 5.3.1.4 SCTP_SEND_FAILED
 504          *
 505          * ssf_info: sizeof (struct sctp_sndrcvinfo)
 506          * The original send information associated with the undelivered
 507          * message.
 508          */
 509         memcpy(&ssf->ssf_info, &chunk->sinfo, sizeof(struct sctp_sndrcvinfo));
 510
 511         /* Per TSVWG discussion with Randy. Allow the application to
 512          * reassemble a fragmented message.
 513          */
 514         ssf->ssf_info.sinfo_flags = chunk->chunk_hdr->flags;
 515
 516         /* Socket Extensions for SCTP
 517          * 5.3.1.4 SCTP_SEND_FAILED
 518          *
 519          * ssf_assoc_id: sizeof (sctp_assoc_t)
 520          * The association id field, sf_assoc_id, holds the identifier for the
 521          * association.  All notifications for a given association have the
 522          * same association identifier.  For TCP style socket, this field is
 523          * ignored.
 524          */
 525         sctp_ulpevent_set_owner(event, asoc);
 526         ssf->ssf_assoc_id = sctp_assoc2id(asoc);
 527         return event;
 528
 529 fail:
 530         return NULL;
 531 }
 532
 533 /* Create and initialize a SCTP_SHUTDOWN_EVENT notification.
 534  *
 535  * Socket Extensions for SCTP - draft-01
 536  * 5.3.1.5 SCTP_SHUTDOWN_EVENT
 537  */
 538 struct sctp_ulpevent *sctp_ulpevent_make_shutdown_event(
 539         const struct sctp_association *asoc,
 540         __u16 flags, gfp_t gfp)
 541 {
 542         struct sctp_ulpevent *event;
 543         struct sctp_shutdown_event *sse;
 544         struct sk_buff *skb;
 545
 546         event = sctp_ulpevent_new(sizeof(struct sctp_shutdown_event),
 547                                   MSG_NOTIFICATION, gfp);
 548         if (!event)
 549                 goto fail;
 550
 551         skb = sctp_event2skb(event);
 552         sse = (struct sctp_shutdown_event *)
 553                 skb_put(skb, sizeof(struct sctp_shutdown_event));
 554
 555         /* Socket Extensions for SCTP
 556          * 5.3.1.5 SCTP_SHUTDOWN_EVENT
 557          *
 558          * sse_type
 559          * It should be SCTP_SHUTDOWN_EVENT
 560          */
 561         sse->sse_type = SCTP_SHUTDOWN_EVENT;
 562
 563         /* Socket Extensions for SCTP
 564          * 5.3.1.5 SCTP_SHUTDOWN_EVENT
 565          *
 566          * sse_flags: 16 bits (unsigned integer)
 567          * Currently unused.
 568          */
 569         sse->sse_flags = 0;
 570
 571         /* Socket Extensions for SCTP
 572          * 5.3.1.5 SCTP_SHUTDOWN_EVENT
 573          *
 574          * sse_length: sizeof (__u32)
 575          * This field is the total length of the notification data, including
 576          * the notification header.
 577          */
 578         sse->sse_length = sizeof(struct sctp_shutdown_event);
 579
 580         /* Socket Extensions for SCTP
 581          * 5.3.1.5 SCTP_SHUTDOWN_EVENT
 582          *
 583          * sse_assoc_id: sizeof (sctp_assoc_t)
 584          * The association id field, holds the identifier for the association.
 585          * All notifications for a given association have the same association
 586          * identifier.  For TCP style socket, this field is ignored.
 587          */
 588         sctp_ulpevent_set_owner(event, asoc);
 589         sse->sse_assoc_id = sctp_assoc2id(asoc);
 590
 591         return event;
 592
 593 fail:
 594         return NULL;
 595 }
 596
 597 /* Create and initialize a SCTP_ADAPTATION_INDICATION notification.
 598  *
 599  * Socket Extensions for SCTP
 600  * 5.3.1.6 SCTP_ADAPTATION_INDICATION
 601  */
 602 struct sctp_ulpevent *sctp_ulpevent_make_adaptation_indication(
 603         const struct sctp_association *asoc, gfp_t gfp)
 604 {
 605         struct sctp_ulpevent *event;
 606         struct sctp_adaptation_event *sai;
 607         struct sk_buff *skb;
 608
 609         event = sctp_ulpevent_new(sizeof(struct sctp_adaptation_event),
 610                                   MSG_NOTIFICATION, gfp);
 611         if (!event)
 612                 goto fail;
 613
 614         skb = sctp_event2skb(event);
 615         sai = (struct sctp_adaptation_event *)
 616                 skb_put(skb, sizeof(struct sctp_adaptation_event));
 617
 618         sai->sai_type = SCTP_ADAPTATION_INDICATION;
 619         sai->sai_flags = 0;
 620         sai->sai_length = sizeof(struct sctp_adaptation_event);
 621         sai->sai_adaptation_ind = asoc->peer.adaptation_ind;
 622         sctp_ulpevent_set_owner(event, asoc);
 623         sai->sai_assoc_id = sctp_assoc2id(asoc);
 624
 625         return event;
 626
 627 fail:
 628         return NULL;
 629 }
 630
 631 /* A message has been received.  Package this message as a notification
 632  * to pass it to the upper layers.  Go ahead and calculate the sndrcvinfo
 633  * even if filtered out later.
 634  *
 635  * Socket Extensions for SCTP
 636  * 5.2.2 SCTP Header Information Structure (SCTP_SNDRCV)
 637  */
 638 struct sctp_ulpevent *sctp_ulpevent_make_rcvmsg(struct sctp_association *asoc,
 639                                                 struct sctp_chunk *chunk,
 640                                                 gfp_t gfp)
 641 {
 642         struct sctp_ulpevent *event = NULL;
 643         struct sk_buff *skb;
 644         size_t padding, len;
 645         int rx_count;
 646
 647         /*
 648          * check to see if we need to make space for this
 649          * new skb, expand the rcvbuffer if needed, or drop
 650          * the frame
 651          */
 652         if (asoc->ep->rcvbuf_policy)
 653                 rx_count = atomic_read(&asoc->rmem_alloc);
 654         else
 655                 rx_count = atomic_read(&asoc->base.sk->sk_rmem_alloc);
 656
 657         if (rx_count >= asoc->base.sk->sk_rcvbuf) {
 658
 659                 if ((asoc->base.sk->sk_userlocks & SOCK_RCVBUF_LOCK) ||
 660                     (!sk_rmem_schedule(asoc->base.sk, chunk->skb,
 661                                        chunk->skb->truesize)))
 662                         goto fail;
 663         }
 664
 665         /* Clone the original skb, sharing the data.  */
 666         skb = skb_clone(chunk->skb, gfp);
 667         if (!skb)
 668                 goto fail;
 669
 670         /* Now that all memory allocations for this chunk succeeded, we
 671          * can mark it as received so the tsn_map is updated correctly.
 672          */
 673         if (sctp_tsnmap_mark(&asoc->peer.tsn_map,
 674                              ntohl(chunk->subh.data_hdr->tsn),
 675                              chunk->transport))
 676                 goto fail_mark;
 677
 678         /* First calculate the padding, so we don't inadvertently
 679          * pass up the wrong length to the user.
 680          *
 681          * RFC 2960 - Section 3.2  Chunk Field Descriptions
 682          *
 683          * The total length of a chunk(including Type, Length and Value fields)
 684          * MUST be a multiple of 4 bytes.  If the length of the chunk is not a
 685          * multiple of 4 bytes, the sender MUST pad the chunk with all zero
 686          * bytes and this padding is not included in the chunk length field.
 687          * The sender should never pad with more than 3 bytes.  The receiver
 688          * MUST ignore the padding bytes.
 689          */
 690         len = ntohs(chunk->chunk_hdr->length);
 691         padding = WORD_ROUND(len) - len;
 692
 693         /* Fixup cloned skb with just this chunks data.  */
 694         skb_trim(skb, chunk->chunk_end - padding - skb->data);
 695
 696         /* Embed the event fields inside the cloned skb.  */
 697         event = sctp_skb2event(skb);
 698
 699         /* Initialize event with flags 0  and correct length
 700          * Since this is a clone of the original skb, only account for
 701          * the data of this chunk as other chunks will be accounted separately.
 702          */
 703         sctp_ulpevent_init(event, 0, skb->len + sizeof(struct sk_buff));
 704
 705         sctp_ulpevent_receive_data(event, asoc);
 706
 707         /* And hold the chunk as we need it for getting the IP headers
 708          * later in recvmsg
 709          */
 710         sctp_chunk_hold(chunk);
 711         event->chunk = chunk;
 712
 713         event->stream = ntohs(chunk->subh.data_hdr->stream);
 714         event->ssn = ntohs(chunk->subh.data_hdr->ssn);
 715         event->ppid = chunk->subh.data_hdr->ppid;
 716         if (chunk->chunk_hdr->flags & SCTP_DATA_UNORDERED) {
 717                 event->flags |= SCTP_UNORDERED;
 718                 event->cumtsn = sctp_tsnmap_get_ctsn(&asoc->peer.tsn_map);
 719         }
 720         event->tsn = ntohl(chunk->subh.data_hdr->tsn);
 721         event->msg_flags |= chunk->chunk_hdr->flags;
 722
 723         return event;
 724
 725 fail_mark:
 726         sctp_chunk_put(chunk);
 727         kfree_skb(skb);
 728 fail:
 729         return NULL;
 730 }
 731
 732 /* Create a partial delivery related event.
 733  *
 734  * 5.3.1.7 SCTP_PARTIAL_DELIVERY_EVENT
 735  *
 736  *   When a receiver is engaged in a partial delivery of a
 737  *   message this notification will be used to indicate
 738  *   various events.
 739  */
 740 struct sctp_ulpevent *sctp_ulpevent_make_pdapi(
 741         const struct sctp_association *asoc, __u32 indication,
 742         gfp_t gfp)
 743 {
 744         struct sctp_ulpevent *event;
 745         struct sctp_pdapi_event *pd;
 746         struct sk_buff *skb;
 747
 748         event = sctp_ulpevent_new(sizeof(struct sctp_pdapi_event),
 749                                   MSG_NOTIFICATION, gfp);
 750         if (!event)
 751                 goto fail;
 752
 753         skb = sctp_event2skb(event);
 754         pd = (struct sctp_pdapi_event *)
 755                 skb_put(skb, sizeof(struct sctp_pdapi_event));
 756
 757         /* pdapi_type
 758          *   It should be SCTP_PARTIAL_DELIVERY_EVENT
 759          *
 760          * pdapi_flags: 16 bits (unsigned integer)
 761          *   Currently unused.
 762          */
 763         pd->pdapi_type = SCTP_PARTIAL_DELIVERY_EVENT;
 764         pd->pdapi_flags = 0;
 765
 766         /* pdapi_length: 32 bits (unsigned integer)
 767          *
 768          * This field is the total length of the notification data, including
 769          * the notification header.  It will generally be sizeof (struct
 770          * sctp_pdapi_event).
 771          */
 772         pd->pdapi_length = sizeof(struct sctp_pdapi_event);
 773
 774         /*  pdapi_indication: 32 bits (unsigned integer)
 775          *
 776          * This field holds the indication being sent to the application.
 777          */
 778         pd->pdapi_indication = indication;
 779
 780         /*  pdapi_assoc_id: sizeof (sctp_assoc_t)
 781          *
 782          * The association id field, holds the identifier for the association.
 783          */
 784         sctp_ulpevent_set_owner(event, asoc);
 785         pd->pdapi_assoc_id = sctp_assoc2id(asoc);
 786
 787         return event;
 788 fail:
 789         return NULL;
 790 }
 791
 792 struct sctp_ulpevent *sctp_ulpevent_make_authkey(
 793         const struct sctp_association *asoc, __u16 key_id,
 794         __u32 indication, gfp_t gfp)
 795 {
 796         struct sctp_ulpevent *event;
 797         struct sctp_authkey_event *ak;
 798         struct sk_buff *skb;
 799
 800         event = sctp_ulpevent_new(sizeof(struct sctp_authkey_event),
 801                                   MSG_NOTIFICATION, gfp);
 802         if (!event)
 803                 goto fail;
 804
 805         skb = sctp_event2skb(event);
 806         ak = (struct sctp_authkey_event *)
 807                 skb_put(skb, sizeof(struct sctp_authkey_event));
 808
 809         ak->auth_type = SCTP_AUTHENTICATION_EVENT;
 810         ak->auth_flags = 0;
 811         ak->auth_length = sizeof(struct sctp_authkey_event);
 812
 813         ak->auth_keynumber = key_id;
 814         ak->auth_altkeynumber = 0;
 815         ak->auth_indication = indication;
 816
 817         /*
 818          * The association id field, holds the identifier for the association.
 819          */
 820         sctp_ulpevent_set_owner(event, asoc);
 821         ak->auth_assoc_id = sctp_assoc2id(asoc);
 822
 823         return event;
 824 fail:
 825         return NULL;
 826 }
 827
 828 /*
 829  * Socket Extensions for SCTP
 830  * 6.3.10. SCTP_SENDER_DRY_EVENT
 831  */
 832 struct sctp_ulpevent *sctp_ulpevent_make_sender_dry_event(
 833         const struct sctp_association *asoc, gfp_t gfp)
 834 {
 835         struct sctp_ulpevent *event;
 836         struct sctp_sender_dry_event *sdry;
 837         struct sk_buff *skb;
 838
 839         event = sctp_ulpevent_new(sizeof(struct sctp_sender_dry_event),
 840                                   MSG_NOTIFICATION, gfp);
 841         if (!event)
 842                 return NULL;
 843
 844         skb = sctp_event2skb(event);
 845         sdry = (struct sctp_sender_dry_event *)
 846                 skb_put(skb, sizeof(struct sctp_sender_dry_event));
 847
 848         sdry->sender_dry_type = SCTP_SENDER_DRY_EVENT;
 849         sdry->sender_dry_flags = 0;
 850         sdry->sender_dry_length = sizeof(struct sctp_sender_dry_event);
 851         sctp_ulpevent_set_owner(event, asoc);
 852         sdry->sender_dry_assoc_id = sctp_assoc2id(asoc);
 853
 854         return event;
 855 }
 856
 857 /* Return the notification type, assuming this is a notification
 858  * event.
 859  */
 860 __u16 sctp_ulpevent_get_notification_type(const struct sctp_ulpevent *event)
 861 {
 862         union sctp_notification *notification;
 863         struct sk_buff *skb;
 864
 865         skb = sctp_event2skb(event);
 866         notification = (union sctp_notification *) skb->data;
 867         return notification->sn_header.sn_type;
 868 }
 869
 870 /* RFC6458, Section 5.3.2. SCTP Header Information Structure
 871  * (SCTP_SNDRCV, DEPRECATED)
 872  */
 873 void sctp_ulpevent_read_sndrcvinfo(const struct sctp_ulpevent *event,
 874                                    struct msghdr *msghdr)
 875 {
 876         struct sctp_sndrcvinfo sinfo;
 877
 878         if (sctp_ulpevent_is_notification(event))
 879                 return;
 880
 881         memset(&sinfo, 0, sizeof(sinfo));
 882         sinfo.sinfo_stream = event->stream;
 883         sinfo.sinfo_ssn = event->ssn;
 884         sinfo.sinfo_ppid = event->ppid;
 885         sinfo.sinfo_flags = event->flags;
 886         sinfo.sinfo_tsn = event->tsn;
 887         sinfo.sinfo_cumtsn = event->cumtsn;
 888         sinfo.sinfo_assoc_id = sctp_assoc2id(event->asoc);
 889         /* Context value that is set via SCTP_CONTEXT socket option. */
 890         sinfo.sinfo_context = event->asoc->default_rcv_context;
 891         /* These fields are not used while receiving. */
 892         sinfo.sinfo_timetolive = 0;
 893
 894         put_cmsg(msghdr, IPPROTO_SCTP, SCTP_SNDRCV,
 895                  sizeof(sinfo), &sinfo);
 896 }
 897
 898 /* RFC6458, Section 5.3.5 SCTP Receive Information Structure
 899  * (SCTP_SNDRCV)
 900  */
 901 void sctp_ulpevent_read_rcvinfo(const struct sctp_ulpevent *event,
 902                                 struct msghdr *msghdr)
 903 {
 904         struct sctp_rcvinfo rinfo;
 905
 906         if (sctp_ulpevent_is_notification(event))
 907                 return;
 908
 909         memset(&rinfo, 0, sizeof(struct sctp_rcvinfo));
 910         rinfo.rcv_sid = event->stream;
 911         rinfo.rcv_ssn = event->ssn;
 912         rinfo.rcv_ppid = event->ppid;
 913         rinfo.rcv_flags = event->flags;
 914         rinfo.rcv_tsn = event->tsn;
 915         rinfo.rcv_cumtsn = event->cumtsn;
 916         rinfo.rcv_assoc_id = sctp_assoc2id(event->asoc);
 917         rinfo.rcv_context = event->asoc->default_rcv_context;
 918
 919         put_cmsg(msghdr, IPPROTO_SCTP, SCTP_RCVINFO,
 920                  sizeof(rinfo), &rinfo);
 921 }
 922
 923 /* RFC6458, Section 5.3.6. SCTP Next Receive Information Structure
 924  * (SCTP_NXTINFO)
 925  */
 926 static void __sctp_ulpevent_read_nxtinfo(const struct sctp_ulpevent *event,
 927                                          struct msghdr *msghdr,
 928                                          const struct sk_buff *skb)
 929 {
 930         struct sctp_nxtinfo nxtinfo;
 931
 932         memset(&nxtinfo, 0, sizeof(nxtinfo));
 933         nxtinfo.nxt_sid = event->stream;
 934         nxtinfo.nxt_ppid = event->ppid;
 935         nxtinfo.nxt_flags = event->flags;
 936         if (sctp_ulpevent_is_notification(event))
 937                 nxtinfo.nxt_flags |= SCTP_NOTIFICATION;
 938         nxtinfo.nxt_length = skb->len;
 939         nxtinfo.nxt_assoc_id = sctp_assoc2id(event->asoc);
 940
 941         put_cmsg(msghdr, IPPROTO_SCTP, SCTP_NXTINFO,
 942                  sizeof(nxtinfo), &nxtinfo);
 943 }
 944
 945 void sctp_ulpevent_read_nxtinfo(const struct sctp_ulpevent *event,
 946                                 struct msghdr *msghdr,
 947                                 struct sock *sk)
 948 {
 949         struct sk_buff *skb;
 950         int err;
 951
 952         skb = sctp_skb_recv_datagram(sk, MSG_PEEK, 1, &err);
 953         if (skb != NULL) {
 954                 __sctp_ulpevent_read_nxtinfo(sctp_skb2event(skb),
 955                                              msghdr, skb);
 956                 /* Just release refcount here. */
 957                 kfree_skb(skb);
 958         }
 959 }
 960
 961 /* Do accounting for bytes received and hold a reference to the association
 962  * for each skb.
 963  */
 964 static void sctp_ulpevent_receive_data(struct sctp_ulpevent *event,
 965                                        struct sctp_association *asoc)
 966 {
 967         struct sk_buff *skb, *frag;
 968
 969         skb = sctp_event2skb(event);
 970         /* Set the owner and charge rwnd for bytes received.  */
 971         sctp_ulpevent_set_owner(event, asoc);
 972         sctp_assoc_rwnd_decrease(asoc, skb_headlen(skb));
 973
 974         if (!skb->data_len)
 975                 return;
 976
 977         /* Note:  Not clearing the entire event struct as this is just a
 978          * fragment of the real event.  However, we still need to do rwnd
 979          * accounting.
 980          * In general, the skb passed from IP can have only 1 level of
 981          * fragments. But we allow multiple levels of fragments.
 982          */
 983         skb_walk_frags(skb, frag)
 984                 sctp_ulpevent_receive_data(sctp_skb2event(frag), asoc);
 985 }
 986
 987 /* Do accounting for bytes just read by user and release the references to
 988  * the association.
 989  */
 990 static void sctp_ulpevent_release_data(struct sctp_ulpevent *event)
 991 {
 992         struct sk_buff *skb, *frag;
 993         unsigned int    len;
 994
 995         /* Current stack structures assume that the rcv buffer is
 996          * per socket.   For UDP style sockets this is not true as
 997          * multiple associations may be on a single UDP-style socket.
 998          * Use the local private area of the skb to track the owning
 999          * association.
1000          */
1001
1002         skb = sctp_event2skb(event);
1003         len = skb->len;
1004
1005         if (!skb->data_len)
1006                 goto done;
1007
1008         /* Don't forget the fragments. */
1009         skb_walk_frags(skb, frag) {
1010                 /* NOTE:  skb_shinfos are recursive. Although IP returns
1011                  * skb's with only 1 level of fragments, SCTP reassembly can
1012                  * increase the levels.
1013                  */
1014                 sctp_ulpevent_release_frag_data(sctp_skb2event(frag));
1015         }
1016
1017 done:
1018         sctp_assoc_rwnd_increase(event->asoc, len);
1019         sctp_chunk_put(event->chunk);
1020         sctp_ulpevent_release_owner(event);
1021 }
1022
1023 static void sctp_ulpevent_release_frag_data(struct sctp_ulpevent *event)
1024 {
1025         struct sk_buff *skb, *frag;
1026
1027         skb = sctp_event2skb(event);
1028
1029         if (!skb->data_len)
1030                 goto done;
1031
1032         /* Don't forget the fragments. */
1033         skb_walk_frags(skb, frag) {
1034                 /* NOTE:  skb_shinfos are recursive. Although IP returns
1035                  * skb's with only 1 level of fragments, SCTP reassembly can
1036                  * increase the levels.
1037                  */
1038                 sctp_ulpevent_release_frag_data(sctp_skb2event(frag));
1039         }
1040
1041 done:
1042         sctp_chunk_put(event->chunk);
1043         sctp_ulpevent_release_owner(event);
1044 }
1045
1046 /* Free a ulpevent that has an owner.  It includes releasing the reference
1047  * to the owner, updating the rwnd in case of a DATA event and freeing the
1048  * skb.
1049  */
1050 void sctp_ulpevent_free(struct sctp_ulpevent *event)
1051 {
1052         if (sctp_ulpevent_is_notification(event))
1053                 sctp_ulpevent_release_owner(event);
1054         else
1055                 sctp_ulpevent_release_data(event);
1056
1057         kfree_skb(sctp_event2skb(event));
1058 }
1059
1060 /* Purge the skb lists holding ulpevents. */
1061 unsigned int sctp_queue_purge_ulpevents(struct sk_buff_head *list)
1062 {
1063         struct sk_buff *skb;
1064         unsigned int data_unread = 0;
1065
1066         while ((skb = skb_dequeue(list)) != NULL) {
1067                 struct sctp_ulpevent *event = sctp_skb2event(skb);
1068
1069                 if (!sctp_ulpevent_is_notification(event))
1070                         data_unread += skb->len;
1071
1072                 sctp_ulpevent_free(event);
1073         }
1074
1075         return data_unread;
1076 }