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