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, write to
  29  * the Free Software Foundation, 59 Temple Place - Suite 330,
  30  * Boston, MA 02111-1307, USA.
  31  *
  32  * Please send any bug reports or fixes you make to the
  33  * email address(es):
  34  *    lksctp developers <linux-sctp@vger.kernel.org>
  35  *
  36  * Written or modified by:
  37  *   Jon Grimm             <jgrimm@us.ibm.com>
  38  *   La Monte H.P. Yarroll <piggy@acm.org>
  39  *   Karl Knutson          <karl@athena.chicago.il.us>
  40  *   Sridhar Samudrala     <sri@us.ibm.com>
  41  */
  42
  43 #ifndef __sctp_ulpevent_h__
  44 #define __sctp_ulpevent_h__
  45
  46 /* A structure to carry information to the ULP (e.g. Sockets API) */
  47 /* Warning: This sits inside an skb.cb[] area.  Be very careful of
  48  * growing this structure as it is at the maximum limit now.
  49  */
  50 struct sctp_ulpevent {
  51         struct sctp_association *asoc;
  52         __u16 stream;
  53         __u16 ssn;
  54         __u16 flags;
  55         __u32 ppid;
  56         __u32 tsn;
  57         __u32 cumtsn;
  58         int msg_flags;
  59         int iif;
  60         unsigned int rmem_len;
  61 };
  62
  63 /* Retrieve the skb this event sits inside of. */
  64 static inline struct sk_buff *sctp_event2skb(const struct sctp_ulpevent *ev)
  65 {
  66         return container_of((void *)ev, struct sk_buff, cb);
  67 }
  68
  69 /* Retrieve & cast the event sitting inside the skb. */
  70 static inline struct sctp_ulpevent *sctp_skb2event(struct sk_buff *skb)
  71 {
  72         return (struct sctp_ulpevent *)skb->cb;
  73 }
  74
  75 void sctp_ulpevent_free(struct sctp_ulpevent *);
  76 int sctp_ulpevent_is_notification(const struct sctp_ulpevent *);
  77 unsigned int sctp_queue_purge_ulpevents(struct sk_buff_head *list);
  78
  79 struct sctp_ulpevent *sctp_ulpevent_make_assoc_change(
  80         const struct sctp_association *asoc,
  81         __u16 flags,
  82         __u16 state,
  83         __u16 error,
  84         __u16 outbound,
  85         __u16 inbound,
  86         struct sctp_chunk *chunk,
  87         gfp_t gfp);
  88
  89 struct sctp_ulpevent *sctp_ulpevent_make_peer_addr_change(
  90         const struct sctp_association *asoc,
  91         const struct sockaddr_storage *aaddr,
  92         int flags,
  93         int state,
  94         int error,
  95         gfp_t gfp);
  96
  97 struct sctp_ulpevent *sctp_ulpevent_make_remote_error(
  98         const struct sctp_association *asoc,
  99         struct sctp_chunk *chunk,
 100         __u16 flags,
 101         gfp_t gfp);
 102 struct sctp_ulpevent *sctp_ulpevent_make_send_failed(
 103         const struct sctp_association *asoc,
 104         struct sctp_chunk *chunk,
 105         __u16 flags,
 106         __u32 error,
 107         gfp_t gfp);
 108
 109 struct sctp_ulpevent *sctp_ulpevent_make_shutdown_event(
 110         const struct sctp_association *asoc,
 111         __u16 flags,
 112         gfp_t gfp);
 113
 114 struct sctp_ulpevent *sctp_ulpevent_make_pdapi(
 115         const struct sctp_association *asoc,
 116         __u32 indication, gfp_t gfp);
 117
 118 struct sctp_ulpevent *sctp_ulpevent_make_adaptation_indication(
 119         const struct sctp_association *asoc, gfp_t gfp);
 120
 121 struct sctp_ulpevent *sctp_ulpevent_make_rcvmsg(struct sctp_association *asoc,
 122         struct sctp_chunk *chunk,
 123         gfp_t gfp);
 124
 125 struct sctp_ulpevent *sctp_ulpevent_make_authkey(
 126         const struct sctp_association *asoc, __u16 key_id,
 127         __u32 indication, gfp_t gfp);
 128
 129 struct sctp_ulpevent *sctp_ulpevent_make_sender_dry_event(
 130         const struct sctp_association *asoc, gfp_t gfp);
 131
 132 void sctp_ulpevent_read_sndrcvinfo(const struct sctp_ulpevent *event,
 133         struct msghdr *);
 134 __u16 sctp_ulpevent_get_notification_type(const struct sctp_ulpevent *event);
 135
 136 /* Is this event type enabled? */
 137 static inline int sctp_ulpevent_type_enabled(__u16 sn_type,
 138                                              struct sctp_event_subscribe *mask)
 139 {
 140         char *amask = (char *) mask;
 141         return amask[sn_type - SCTP_SN_TYPE_BASE];
 142 }
 143
 144 /* Given an event subscription, is this event enabled? */
 145 static inline int sctp_ulpevent_is_enabled(const struct sctp_ulpevent *event,
 146                                            struct sctp_event_subscribe *mask)
 147 {
 148         __u16 sn_type;
 149         int enabled = 1;
 150
 151         if (sctp_ulpevent_is_notification(event)) {
 152                 sn_type = sctp_ulpevent_get_notification_type(event);
 153                 enabled = sctp_ulpevent_type_enabled(sn_type, mask);
 154         }
 155         return enabled;
 156 }
 157
 158 #endif /* __sctp_ulpevent_h__ */
 159
 160
 161
 162
 163
 164
 165