]>
git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blob - include/net/sctp/ulpevent.h
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /* SCTP kernel implementation
3 * (C) Copyright IBM Corp. 2001, 2004
4 * Copyright (c) 1999-2000 Cisco, Inc.
5 * Copyright (c) 1999-2001 Motorola, Inc.
6 * Copyright (c) 2001 Intel Corp.
7 * Copyright (c) 2001 Nokia, Inc.
8 * Copyright (c) 2001 La Monte H.P. Yarroll
10 * These are the definitions needed for the sctp_ulpevent type. The
11 * sctp_ulpevent type is used to carry information from the state machine
14 * This file is part of the SCTP kernel implementation
16 * Please send any bug reports or fixes you make to the
18 * lksctp developers <linux-sctp@vger.kernel.org>
20 * Written or modified by:
21 * Jon Grimm <jgrimm@us.ibm.com>
22 * La Monte H.P. Yarroll <piggy@acm.org>
23 * Karl Knutson <karl@athena.chicago.il.us>
24 * Sridhar Samudrala <sri@us.ibm.com>
27 #ifndef __sctp_ulpevent_h__
28 #define __sctp_ulpevent_h__
30 /* A structure to carry information to the ULP (e.g. Sockets API) */
31 /* Warning: This sits inside an skb.cb[] area. Be very careful of
32 * growing this structure as it is at the maximum limit now.
34 * sctp_ulpevent is saved in sk->cb(48 bytes), whose last 4 bytes
35 * have been taken by sock_skb_cb, So here it has to use 'packed'
36 * to make sctp_ulpevent fit into the rest 44 bytes.
38 struct sctp_ulpevent
{
39 struct sctp_association
*asoc
;
40 struct sctp_chunk
*chunk
;
41 unsigned int rmem_len
;
57 /* Retrieve the skb this event sits inside of. */
58 static inline struct sk_buff
*sctp_event2skb(const struct sctp_ulpevent
*ev
)
60 return container_of((void *)ev
, struct sk_buff
, cb
);
63 /* Retrieve & cast the event sitting inside the skb. */
64 static inline struct sctp_ulpevent
*sctp_skb2event(struct sk_buff
*skb
)
66 return (struct sctp_ulpevent
*)skb
->cb
;
69 void sctp_ulpevent_free(struct sctp_ulpevent
*);
70 int sctp_ulpevent_is_notification(const struct sctp_ulpevent
*);
71 unsigned int sctp_queue_purge_ulpevents(struct sk_buff_head
*list
);
73 struct sctp_ulpevent
*sctp_ulpevent_make_assoc_change(
74 const struct sctp_association
*asoc
,
80 struct sctp_chunk
*chunk
,
83 void sctp_ulpevent_nofity_peer_addr_change(struct sctp_transport
*transport
,
84 int state
, int error
);
86 struct sctp_ulpevent
*sctp_ulpevent_make_remote_error(
87 const struct sctp_association
*asoc
,
88 struct sctp_chunk
*chunk
,
91 struct sctp_ulpevent
*sctp_ulpevent_make_send_failed(
92 const struct sctp_association
*asoc
,
93 struct sctp_chunk
*chunk
,
98 struct sctp_ulpevent
*sctp_ulpevent_make_send_failed_event(
99 const struct sctp_association
*asoc
,
100 struct sctp_chunk
*chunk
,
105 struct sctp_ulpevent
*sctp_ulpevent_make_shutdown_event(
106 const struct sctp_association
*asoc
,
110 struct sctp_ulpevent
*sctp_ulpevent_make_pdapi(
111 const struct sctp_association
*asoc
,
112 __u32 indication
, __u32 sid
, __u32 seq
,
113 __u32 flags
, gfp_t gfp
);
115 struct sctp_ulpevent
*sctp_ulpevent_make_adaptation_indication(
116 const struct sctp_association
*asoc
, gfp_t gfp
);
118 struct sctp_ulpevent
*sctp_ulpevent_make_rcvmsg(struct sctp_association
*asoc
,
119 struct sctp_chunk
*chunk
,
122 struct sctp_ulpevent
*sctp_ulpevent_make_authkey(
123 const struct sctp_association
*asoc
, __u16 key_id
,
124 __u32 indication
, gfp_t gfp
);
126 struct sctp_ulpevent
*sctp_ulpevent_make_sender_dry_event(
127 const struct sctp_association
*asoc
, gfp_t gfp
);
129 struct sctp_ulpevent
*sctp_ulpevent_make_stream_reset_event(
130 const struct sctp_association
*asoc
, __u16 flags
,
131 __u16 stream_num
, __be16
*stream_list
, gfp_t gfp
);
133 struct sctp_ulpevent
*sctp_ulpevent_make_assoc_reset_event(
134 const struct sctp_association
*asoc
, __u16 flags
,
135 __u32 local_tsn
, __u32 remote_tsn
, gfp_t gfp
);
137 struct sctp_ulpevent
*sctp_ulpevent_make_stream_change_event(
138 const struct sctp_association
*asoc
, __u16 flags
,
139 __u32 strchange_instrms
, __u32 strchange_outstrms
, gfp_t gfp
);
141 struct sctp_ulpevent
*sctp_make_reassembled_event(
142 struct net
*net
, struct sk_buff_head
*queue
,
143 struct sk_buff
*f_frag
, struct sk_buff
*l_frag
);
145 void sctp_ulpevent_read_sndrcvinfo(const struct sctp_ulpevent
*event
,
147 void sctp_ulpevent_read_rcvinfo(const struct sctp_ulpevent
*event
,
149 void sctp_ulpevent_read_nxtinfo(const struct sctp_ulpevent
*event
,
150 struct msghdr
*, struct sock
*sk
);
152 __u16
sctp_ulpevent_get_notification_type(const struct sctp_ulpevent
*event
);
154 static inline void sctp_ulpevent_type_set(__u16
*subscribe
,
155 __u16 sn_type
, __u8 on
)
157 if (sn_type
> SCTP_SN_TYPE_MAX
)
161 *subscribe
|= (1 << (sn_type
- SCTP_SN_TYPE_BASE
));
163 *subscribe
&= ~(1 << (sn_type
- SCTP_SN_TYPE_BASE
));
166 /* Is this event type enabled? */
167 static inline bool sctp_ulpevent_type_enabled(__u16 subscribe
, __u16 sn_type
)
169 if (sn_type
> SCTP_SN_TYPE_MAX
)
172 return subscribe
& (1 << (sn_type
- SCTP_SN_TYPE_BASE
));
175 /* Given an event subscription, is this event enabled? */
176 static inline bool sctp_ulpevent_is_enabled(const struct sctp_ulpevent
*event
,
181 if (!sctp_ulpevent_is_notification(event
))
184 sn_type
= sctp_ulpevent_get_notification_type(event
);
186 return sctp_ulpevent_type_enabled(subscribe
, sn_type
);
189 #endif /* __sctp_ulpevent_h__ */