LXR linux/include/net/sctp/ulpevent.h

   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 are the definitions needed for the sctp_ulpevent type.  The
  10 * sctp_ulpevent type is used to carry information from the state machine
  11 * upwards to the ULP.
  12 *
  13 * This file is part of the SCTP kernel implementation
  14 *
  15 * This SCTP implementation is free software;
  16 * you can redistribute it and/or modify it under the terms of
  17 * the GNU General Public License as published by
  18 * the Free Software Foundation; either version 2, or (at your option)
  19 * any later version.
  20 *
  21 * This SCTP implementation is distributed in the hope that it
  22 * will be useful, but WITHOUT ANY WARRANTY; without even the implied
  23 *                 ************************
  24 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  25 * See the GNU General Public License for more details.
  26 *
  27 * You should have received a copy of the GNU General Public License
  28 * along with GNU CC; see the file COPYING.  If not, see
  29 * <http://www.gnu.org/licenses/>.
  30 *
  31 * Please send any bug reports or fixes you make to the
  32 * email address(es):
  33 *    lksctp developers <linux-sctp@vger.kernel.org>
  34 *
  35 * Written or modified by:
  36 *   Jon Grimm             <jgrimm@us.ibm.com>
  37 *   La Monte H.P. Yarroll <piggy@acm.org>
  38 *   Karl Knutson          <karl@athena.chicago.il.us>
  39 *   Sridhar Samudrala     <sri@us.ibm.com>
  40 */
  41
  42#ifndef __sctp_ulpevent_h__
  43#define __sctp_ulpevent_h__
  44
  45/* A structure to carry information to the ULP (e.g. Sockets API) */
  46/* Warning: This sits inside an skb.cb[] area.  Be very careful of
  47 * growing this structure as it is at the maximum limit now.
  48 */
  49struct sctp_ulpevent {
  50        struct sctp_association *asoc;
  51        struct sctp_chunk *chunk;
  52        unsigned int rmem_len;
  53        __u32 ppid;
  54        __u32 tsn;
  55        __u32 cumtsn;
  56        __u16 stream;
  57        __u16 ssn;
  58        __u16 flags;
  59        __u16 msg_flags;
  60};
  61
  62/* Retrieve the skb this event sits inside of. */
  63static inline struct sk_buff *sctp_event2skb(const struct sctp_ulpevent *ev)
  64{
  65        return container_of((void *)ev, struct sk_buff, cb);
  66}
  67
  68/* Retrieve & cast the event sitting inside the skb. */
  69static inline struct sctp_ulpevent *sctp_skb2event(struct sk_buff *skb)
  70{
  71        return (struct sctp_ulpevent *)skb->cb;
  72}
  73
  74void sctp_ulpevent_free(struct sctp_ulpevent *);
  75int sctp_ulpevent_is_notification(const struct sctp_ulpevent *);
  76unsigned int sctp_queue_purge_ulpevents(struct sk_buff_head *list);
  77
  78struct sctp_ulpevent *sctp_ulpevent_make_assoc_change(
  79        const struct sctp_association *asoc,
  80        __u16 flags,
  81        __u16 state,
  82        __u16 error,
  83        __u16 outbound,
  84        __u16 inbound,
  85        struct sctp_chunk *chunk,
  86        gfp_t gfp);
  87
  88struct sctp_ulpevent *sctp_ulpevent_make_peer_addr_change(
  89        const struct sctp_association *asoc,
  90        const struct sockaddr_storage *aaddr,
  91        int flags,
  92        int state,
  93        int error,
  94        gfp_t gfp);
  95
  96struct sctp_ulpevent *sctp_ulpevent_make_remote_error(
  97        const struct sctp_association *asoc,
  98        struct sctp_chunk *chunk,
  99        __u16 flags,
 100        gfp_t gfp);
 101struct sctp_ulpevent *sctp_ulpevent_make_send_failed(
 102        const struct sctp_association *asoc,
 103        struct sctp_chunk *chunk,
 104        __u16 flags,
 105        __u32 error,
 106        gfp_t gfp);
 107
 108struct sctp_ulpevent *sctp_ulpevent_make_shutdown_event(
 109        const struct sctp_association *asoc,
 110        __u16 flags,
 111        gfp_t gfp);
 112
 113struct sctp_ulpevent *sctp_ulpevent_make_pdapi(
 114        const struct sctp_association *asoc,
 115        __u32 indication, gfp_t gfp);
 116
 117struct sctp_ulpevent *sctp_ulpevent_make_adaptation_indication(
 118        const struct sctp_association *asoc, gfp_t gfp);
 119
 120struct sctp_ulpevent *sctp_ulpevent_make_rcvmsg(struct sctp_association *asoc,
 121        struct sctp_chunk *chunk,
 122        gfp_t gfp);
 123
 124struct sctp_ulpevent *sctp_ulpevent_make_authkey(
 125        const struct sctp_association *asoc, __u16 key_id,
 126        __u32 indication, gfp_t gfp);
 127
 128struct sctp_ulpevent *sctp_ulpevent_make_sender_dry_event(
 129        const struct sctp_association *asoc, gfp_t gfp);
 130
 131struct sctp_ulpevent *sctp_ulpevent_make_stream_reset_event(
 132        const struct sctp_association *asoc, __u16 flags,
 133        __u16 stream_num, __be16 *stream_list, gfp_t gfp);
 134
 135struct sctp_ulpevent *sctp_ulpevent_make_assoc_reset_event(
 136        const struct sctp_association *asoc, __u16 flags,
 137         __u32 local_tsn, __u32 remote_tsn, gfp_t gfp);
 138
 139struct sctp_ulpevent *sctp_ulpevent_make_stream_change_event(
 140        const struct sctp_association *asoc, __u16 flags,
 141        __u32 strchange_instrms, __u32 strchange_outstrms, gfp_t gfp);
 142
 143void sctp_ulpevent_read_sndrcvinfo(const struct sctp_ulpevent *event,
 144                                   struct msghdr *);
 145void sctp_ulpevent_read_rcvinfo(const struct sctp_ulpevent *event,
 146                                struct msghdr *);
 147void sctp_ulpevent_read_nxtinfo(const struct sctp_ulpevent *event,
 148                                struct msghdr *, struct sock *sk);
 149
 150__u16 sctp_ulpevent_get_notification_type(const struct sctp_ulpevent *event);
 151
 152/* Is this event type enabled? */
 153static inline int sctp_ulpevent_type_enabled(__u16 sn_type,
 154                                             struct sctp_event_subscribe *mask)
 155{
 156        int offset = sn_type - SCTP_SN_TYPE_BASE;
 157        char *amask = (char *) mask;
 158
 159        if (offset >= sizeof(struct sctp_event_subscribe))
 160                return 0;
 161        return amask[offset];
 162}
 163
 164/* Given an event subscription, is this event enabled? */
 165static inline int sctp_ulpevent_is_enabled(const struct sctp_ulpevent *event,
 166                                           struct sctp_event_subscribe *mask)
 167{
 168        __u16 sn_type;
 169        int enabled = 1;
 170
 171        if (sctp_ulpevent_is_notification(event)) {
 172                sn_type = sctp_ulpevent_get_notification_type(event);
 173                enabled = sctp_ulpevent_type_enabled(sn_type, mask);
 174        }
 175        return enabled;
 176}
 177
 178#endif /* __sctp_ulpevent_h__ */
 179