]>
Commit | Line | Data |
---|---|---|
47505b8b | 1 | /* SPDX-License-Identifier: GPL-2.0-or-later */ |
60c778b2 | 2 | /* SCTP kernel implementation |
1da177e4 LT |
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 | |
9 | * | |
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 | |
12 | * upwards to the ULP. | |
13 | * | |
60c778b2 | 14 | * This file is part of the SCTP kernel implementation |
1da177e4 | 15 | * |
1da177e4 LT |
16 | * Please send any bug reports or fixes you make to the |
17 | * email address(es): | |
91705c61 | 18 | * lksctp developers <linux-sctp@vger.kernel.org> |
1da177e4 | 19 | * |
1da177e4 LT |
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> | |
1da177e4 LT |
25 | */ |
26 | ||
27 | #ifndef __sctp_ulpevent_h__ | |
28 | #define __sctp_ulpevent_h__ | |
29 | ||
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. | |
bd4d627d XL |
33 | * |
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. | |
1da177e4 LT |
37 | */ |
38 | struct sctp_ulpevent { | |
39 | struct sctp_association *asoc; | |
1f45f78f | 40 | struct sctp_chunk *chunk; |
f5d258e6 | 41 | unsigned int rmem_len; |
bd4d627d XL |
42 | union { |
43 | __u32 mid; | |
44 | __u16 ssn; | |
45 | }; | |
46 | union { | |
47 | __u32 ppid; | |
48 | __u32 fsn; | |
49 | }; | |
1da177e4 LT |
50 | __u32 tsn; |
51 | __u32 cumtsn; | |
f5d258e6 | 52 | __u16 stream; |
f5d258e6 MRL |
53 | __u16 flags; |
54 | __u16 msg_flags; | |
bd4d627d | 55 | } __packed; |
1da177e4 LT |
56 | |
57 | /* Retrieve the skb this event sits inside of. */ | |
ab38fb04 | 58 | static inline struct sk_buff *sctp_event2skb(const struct sctp_ulpevent *ev) |
1da177e4 LT |
59 | { |
60 | return container_of((void *)ev, struct sk_buff, cb); | |
61 | } | |
62 | ||
63 | /* Retrieve & cast the event sitting inside the skb. */ | |
64 | static inline struct sctp_ulpevent *sctp_skb2event(struct sk_buff *skb) | |
65 | { | |
66 | return (struct sctp_ulpevent *)skb->cb; | |
67 | } | |
68 | ||
69 | void sctp_ulpevent_free(struct sctp_ulpevent *); | |
70 | int sctp_ulpevent_is_notification(const struct sctp_ulpevent *); | |
cd4fcc70 | 71 | unsigned int sctp_queue_purge_ulpevents(struct sk_buff_head *list); |
1da177e4 LT |
72 | |
73 | struct sctp_ulpevent *sctp_ulpevent_make_assoc_change( | |
74 | const struct sctp_association *asoc, | |
75 | __u16 flags, | |
76 | __u16 state, | |
77 | __u16 error, | |
78 | __u16 outbound, | |
79 | __u16 inbound, | |
a5a35e76 | 80 | struct sctp_chunk *chunk, |
dd0fc66f | 81 | gfp_t gfp); |
1da177e4 | 82 | |
50ce4c09 | 83 | void sctp_ulpevent_notify_peer_addr_change(struct sctp_transport *transport, |
4b774032 | 84 | int state, int error); |
1da177e4 LT |
85 | |
86 | struct sctp_ulpevent *sctp_ulpevent_make_remote_error( | |
87 | const struct sctp_association *asoc, | |
88 | struct sctp_chunk *chunk, | |
89 | __u16 flags, | |
dd0fc66f | 90 | gfp_t gfp); |
1da177e4 LT |
91 | struct sctp_ulpevent *sctp_ulpevent_make_send_failed( |
92 | const struct sctp_association *asoc, | |
93 | struct sctp_chunk *chunk, | |
94 | __u16 flags, | |
95 | __u32 error, | |
dd0fc66f | 96 | gfp_t gfp); |
1da177e4 | 97 | |
b6e6b5f1 XL |
98 | struct sctp_ulpevent *sctp_ulpevent_make_send_failed_event( |
99 | const struct sctp_association *asoc, | |
100 | struct sctp_chunk *chunk, | |
101 | __u16 flags, | |
102 | __u32 error, | |
103 | gfp_t gfp); | |
104 | ||
1da177e4 LT |
105 | struct sctp_ulpevent *sctp_ulpevent_make_shutdown_event( |
106 | const struct sctp_association *asoc, | |
107 | __u16 flags, | |
dd0fc66f | 108 | gfp_t gfp); |
1da177e4 LT |
109 | |
110 | struct sctp_ulpevent *sctp_ulpevent_make_pdapi( | |
111 | const struct sctp_association *asoc, | |
65f5e357 XL |
112 | __u32 indication, __u32 sid, __u32 seq, |
113 | __u32 flags, gfp_t gfp); | |
1da177e4 | 114 | |
0f3fffd8 | 115 | struct sctp_ulpevent *sctp_ulpevent_make_adaptation_indication( |
dd0fc66f | 116 | const struct sctp_association *asoc, gfp_t gfp); |
1da177e4 LT |
117 | |
118 | struct sctp_ulpevent *sctp_ulpevent_make_rcvmsg(struct sctp_association *asoc, | |
119 | struct sctp_chunk *chunk, | |
dd0fc66f | 120 | gfp_t gfp); |
1da177e4 | 121 | |
65b07e5d VY |
122 | struct sctp_ulpevent *sctp_ulpevent_make_authkey( |
123 | const struct sctp_association *asoc, __u16 key_id, | |
124 | __u32 indication, gfp_t gfp); | |
125 | ||
e1cdd553 WY |
126 | struct sctp_ulpevent *sctp_ulpevent_make_sender_dry_event( |
127 | const struct sctp_association *asoc, gfp_t gfp); | |
35ea82d6 XL |
128 | |
129 | struct sctp_ulpevent *sctp_ulpevent_make_stream_reset_event( | |
130 | const struct sctp_association *asoc, __u16 flags, | |
1da4fc97 | 131 | __u16 stream_num, __be16 *stream_list, gfp_t gfp); |
c95129d1 XL |
132 | |
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); | |
b444153f XL |
136 | |
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); | |
e1cdd553 | 140 | |
bd4d627d XL |
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); | |
144 | ||
1da177e4 | 145 | void sctp_ulpevent_read_sndrcvinfo(const struct sctp_ulpevent *event, |
0d3a421d GOV |
146 | struct msghdr *); |
147 | void sctp_ulpevent_read_rcvinfo(const struct sctp_ulpevent *event, | |
148 | struct msghdr *); | |
2347c80f GOV |
149 | void sctp_ulpevent_read_nxtinfo(const struct sctp_ulpevent *event, |
150 | struct msghdr *, struct sock *sk); | |
0d3a421d | 151 | |
1da177e4 LT |
152 | __u16 sctp_ulpevent_get_notification_type(const struct sctp_ulpevent *event); |
153 | ||
2cc0eeb6 XL |
154 | static inline void sctp_ulpevent_type_set(__u16 *subscribe, |
155 | __u16 sn_type, __u8 on) | |
156 | { | |
157 | if (sn_type > SCTP_SN_TYPE_MAX) | |
158 | return; | |
159 | ||
160 | if (on) | |
161 | *subscribe |= (1 << (sn_type - SCTP_SN_TYPE_BASE)); | |
162 | else | |
163 | *subscribe &= ~(1 << (sn_type - SCTP_SN_TYPE_BASE)); | |
164 | } | |
165 | ||
1da177e4 | 166 | /* Is this event type enabled? */ |
2cc0eeb6 | 167 | static inline bool sctp_ulpevent_type_enabled(__u16 subscribe, __u16 sn_type) |
1da177e4 | 168 | { |
2cc0eeb6 XL |
169 | if (sn_type > SCTP_SN_TYPE_MAX) |
170 | return false; | |
fa5f7b51 | 171 | |
2cc0eeb6 | 172 | return subscribe & (1 << (sn_type - SCTP_SN_TYPE_BASE)); |
1da177e4 LT |
173 | } |
174 | ||
175 | /* Given an event subscription, is this event enabled? */ | |
2cc0eeb6 XL |
176 | static inline bool sctp_ulpevent_is_enabled(const struct sctp_ulpevent *event, |
177 | __u16 subscribe) | |
1da177e4 LT |
178 | { |
179 | __u16 sn_type; | |
1da177e4 | 180 | |
2cc0eeb6 XL |
181 | if (!sctp_ulpevent_is_notification(event)) |
182 | return true; | |
183 | ||
184 | sn_type = sctp_ulpevent_get_notification_type(event); | |
185 | ||
186 | return sctp_ulpevent_type_enabled(subscribe, sn_type); | |
1da177e4 LT |
187 | } |
188 | ||
189 | #endif /* __sctp_ulpevent_h__ */ |