xref: /linux/net/sctp/chunk.c (revision 9a379e77033f02c4a071891afdf0f0a01eff8ccb)
1 /* SCTP kernel implementation
2  * (C) Copyright IBM Corp. 2003, 2004
3  *
4  * This file is part of the SCTP kernel implementation
5  *
6  * This file contains the code relating the chunk abstraction.
7  *
8  * This SCTP implementation is free software;
9  * you can redistribute it and/or modify it under the terms of
10  * the GNU General Public License as published by
11  * the Free Software Foundation; either version 2, or (at your option)
12  * any later version.
13  *
14  * This SCTP implementation is distributed in the hope that it
15  * will be useful, but WITHOUT ANY WARRANTY; without even the implied
16  *                 ************************
17  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
18  * See the GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with GNU CC; see the file COPYING.  If not, see
22  * <http://www.gnu.org/licenses/>.
23  *
24  * Please send any bug reports or fixes you make to the
25  * email address(es):
26  *    lksctp developers <linux-sctp@vger.kernel.org>
27  *
28  * Written or modified by:
29  *    Jon Grimm             <jgrimm@us.ibm.com>
30  *    Sridhar Samudrala     <sri@us.ibm.com>
31  */
32 
33 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
34 
35 #include <linux/types.h>
36 #include <linux/kernel.h>
37 #include <linux/net.h>
38 #include <linux/inet.h>
39 #include <linux/skbuff.h>
40 #include <linux/slab.h>
41 #include <net/sock.h>
42 #include <net/sctp/sctp.h>
43 #include <net/sctp/sm.h>
44 
45 /* This file is mostly in anticipation of future work, but initially
46  * populate with fragment tracking for an outbound message.
47  */
48 
49 /* Initialize datamsg from memory. */
50 static void sctp_datamsg_init(struct sctp_datamsg *msg)
51 {
52 	refcount_set(&msg->refcnt, 1);
53 	msg->send_failed = 0;
54 	msg->send_error = 0;
55 	msg->can_delay = 1;
56 	msg->abandoned = 0;
57 	msg->expires_at = 0;
58 	INIT_LIST_HEAD(&msg->chunks);
59 }
60 
61 /* Allocate and initialize datamsg. */
62 static struct sctp_datamsg *sctp_datamsg_new(gfp_t gfp)
63 {
64 	struct sctp_datamsg *msg;
65 	msg = kmalloc(sizeof(struct sctp_datamsg), gfp);
66 	if (msg) {
67 		sctp_datamsg_init(msg);
68 		SCTP_DBG_OBJCNT_INC(datamsg);
69 	}
70 	return msg;
71 }
72 
73 void sctp_datamsg_free(struct sctp_datamsg *msg)
74 {
75 	struct sctp_chunk *chunk;
76 
77 	/* This doesn't have to be a _safe vairant because
78 	 * sctp_chunk_free() only drops the refs.
79 	 */
80 	list_for_each_entry(chunk, &msg->chunks, frag_list)
81 		sctp_chunk_free(chunk);
82 
83 	sctp_datamsg_put(msg);
84 }
85 
86 /* Final destructruction of datamsg memory. */
87 static void sctp_datamsg_destroy(struct sctp_datamsg *msg)
88 {
89 	struct list_head *pos, *temp;
90 	struct sctp_chunk *chunk;
91 	struct sctp_sock *sp;
92 	struct sctp_ulpevent *ev;
93 	struct sctp_association *asoc = NULL;
94 	int error = 0, notify;
95 
96 	/* If we failed, we may need to notify. */
97 	notify = msg->send_failed ? -1 : 0;
98 
99 	/* Release all references. */
100 	list_for_each_safe(pos, temp, &msg->chunks) {
101 		list_del_init(pos);
102 		chunk = list_entry(pos, struct sctp_chunk, frag_list);
103 		/* Check whether we _really_ need to notify. */
104 		if (notify < 0) {
105 			asoc = chunk->asoc;
106 			if (msg->send_error)
107 				error = msg->send_error;
108 			else
109 				error = asoc->outqueue.error;
110 
111 			sp = sctp_sk(asoc->base.sk);
112 			notify = sctp_ulpevent_type_enabled(SCTP_SEND_FAILED,
113 							    &sp->subscribe);
114 		}
115 
116 		/* Generate a SEND FAILED event only if enabled. */
117 		if (notify > 0) {
118 			int sent;
119 			if (chunk->has_tsn)
120 				sent = SCTP_DATA_SENT;
121 			else
122 				sent = SCTP_DATA_UNSENT;
123 
124 			ev = sctp_ulpevent_make_send_failed(asoc, chunk, sent,
125 							    error, GFP_ATOMIC);
126 			if (ev)
127 				asoc->stream.si->enqueue_event(&asoc->ulpq, ev);
128 		}
129 
130 		sctp_chunk_put(chunk);
131 	}
132 
133 	SCTP_DBG_OBJCNT_DEC(datamsg);
134 	kfree(msg);
135 }
136 
137 /* Hold a reference. */
138 static void sctp_datamsg_hold(struct sctp_datamsg *msg)
139 {
140 	refcount_inc(&msg->refcnt);
141 }
142 
143 /* Release a reference. */
144 void sctp_datamsg_put(struct sctp_datamsg *msg)
145 {
146 	if (refcount_dec_and_test(&msg->refcnt))
147 		sctp_datamsg_destroy(msg);
148 }
149 
150 /* Assign a chunk to this datamsg. */
151 static void sctp_datamsg_assign(struct sctp_datamsg *msg, struct sctp_chunk *chunk)
152 {
153 	sctp_datamsg_hold(msg);
154 	chunk->msg = msg;
155 }
156 
157 
158 /* A data chunk can have a maximum payload of (2^16 - 20).  Break
159  * down any such message into smaller chunks.  Opportunistically, fragment
160  * the chunks down to the current MTU constraints.  We may get refragmented
161  * later if the PMTU changes, but it is _much better_ to fragment immediately
162  * with a reasonable guess than always doing our fragmentation on the
163  * soft-interrupt.
164  */
165 struct sctp_datamsg *sctp_datamsg_from_user(struct sctp_association *asoc,
166 					    struct sctp_sndrcvinfo *sinfo,
167 					    struct iov_iter *from)
168 {
169 	size_t len, first_len, max_data, remaining;
170 	size_t msg_len = iov_iter_count(from);
171 	struct list_head *pos, *temp;
172 	struct sctp_chunk *chunk;
173 	struct sctp_datamsg *msg;
174 	int err;
175 
176 	msg = sctp_datamsg_new(GFP_KERNEL);
177 	if (!msg)
178 		return ERR_PTR(-ENOMEM);
179 
180 	/* Note: Calculate this outside of the loop, so that all fragments
181 	 * have the same expiration.
182 	 */
183 	if (asoc->peer.prsctp_capable && sinfo->sinfo_timetolive &&
184 	    (SCTP_PR_TTL_ENABLED(sinfo->sinfo_flags) ||
185 	     !SCTP_PR_POLICY(sinfo->sinfo_flags)))
186 		msg->expires_at = jiffies +
187 				  msecs_to_jiffies(sinfo->sinfo_timetolive);
188 
189 	/* This is the biggest possible DATA chunk that can fit into
190 	 * the packet
191 	 */
192 	max_data = asoc->pathmtu -
193 		   sctp_sk(asoc->base.sk)->pf->af->net_header_len -
194 		   sizeof(struct sctphdr) - sctp_datachk_len(&asoc->stream);
195 	max_data = SCTP_TRUNC4(max_data);
196 
197 	/* If the the peer requested that we authenticate DATA chunks
198 	 * we need to account for bundling of the AUTH chunks along with
199 	 * DATA.
200 	 */
201 	if (sctp_auth_send_cid(SCTP_CID_DATA, asoc)) {
202 		struct sctp_hmac *hmac_desc = sctp_auth_asoc_get_hmac(asoc);
203 
204 		if (hmac_desc)
205 			max_data -= SCTP_PAD4(sizeof(struct sctp_auth_chunk) +
206 					      hmac_desc->hmac_len);
207 	}
208 
209 	/* Check what's our max considering the above */
210 	max_data = min_t(size_t, max_data, asoc->frag_point);
211 
212 	/* Set first_len and then account for possible bundles on first frag */
213 	first_len = max_data;
214 
215 	/* Check to see if we have a pending SACK and try to let it be bundled
216 	 * with this message.  Do this if we don't have any data queued already.
217 	 * To check that, look at out_qlen and retransmit list.
218 	 * NOTE: we will not reduce to account for SACK, if the message would
219 	 * not have been fragmented.
220 	 */
221 	if (timer_pending(&asoc->timers[SCTP_EVENT_TIMEOUT_SACK]) &&
222 	    asoc->outqueue.out_qlen == 0 &&
223 	    list_empty(&asoc->outqueue.retransmit) &&
224 	    msg_len > max_data)
225 		first_len -= SCTP_PAD4(sizeof(struct sctp_sack_chunk));
226 
227 	/* Encourage Cookie-ECHO bundling. */
228 	if (asoc->state < SCTP_STATE_COOKIE_ECHOED)
229 		first_len -= SCTP_ARBITRARY_COOKIE_ECHO_LEN;
230 
231 	/* Account for a different sized first fragment */
232 	if (msg_len >= first_len) {
233 		msg->can_delay = 0;
234 		SCTP_INC_STATS(sock_net(asoc->base.sk), SCTP_MIB_FRAGUSRMSGS);
235 	} else {
236 		/* Which may be the only one... */
237 		first_len = msg_len;
238 	}
239 
240 	/* Create chunks for all DATA chunks. */
241 	for (remaining = msg_len; remaining; remaining -= len) {
242 		u8 frag = SCTP_DATA_MIDDLE_FRAG;
243 
244 		if (remaining == msg_len) {
245 			/* First frag, which may also be the last */
246 			frag |= SCTP_DATA_FIRST_FRAG;
247 			len = first_len;
248 		} else {
249 			/* Middle frags */
250 			len = max_data;
251 		}
252 
253 		if (len >= remaining) {
254 			/* Last frag, which may also be the first */
255 			len = remaining;
256 			frag |= SCTP_DATA_LAST_FRAG;
257 
258 			/* The application requests to set the I-bit of the
259 			 * last DATA chunk of a user message when providing
260 			 * the user message to the SCTP implementation.
261 			 */
262 			if ((sinfo->sinfo_flags & SCTP_EOF) ||
263 			    (sinfo->sinfo_flags & SCTP_SACK_IMMEDIATELY))
264 				frag |= SCTP_DATA_SACK_IMM;
265 		}
266 
267 		chunk = asoc->stream.si->make_datafrag(asoc, sinfo, len, frag,
268 						       GFP_KERNEL);
269 		if (!chunk) {
270 			err = -ENOMEM;
271 			goto errout;
272 		}
273 
274 		err = sctp_user_addto_chunk(chunk, len, from);
275 		if (err < 0)
276 			goto errout_chunk_free;
277 
278 		/* Put the chunk->skb back into the form expected by send.  */
279 		__skb_pull(chunk->skb, (__u8 *)chunk->chunk_hdr -
280 				       chunk->skb->data);
281 
282 		sctp_datamsg_assign(msg, chunk);
283 		list_add_tail(&chunk->frag_list, &msg->chunks);
284 	}
285 
286 	return msg;
287 
288 errout_chunk_free:
289 	sctp_chunk_free(chunk);
290 
291 errout:
292 	list_for_each_safe(pos, temp, &msg->chunks) {
293 		list_del_init(pos);
294 		chunk = list_entry(pos, struct sctp_chunk, frag_list);
295 		sctp_chunk_free(chunk);
296 	}
297 	sctp_datamsg_put(msg);
298 
299 	return ERR_PTR(err);
300 }
301 
302 /* Check whether this message has expired. */
303 int sctp_chunk_abandoned(struct sctp_chunk *chunk)
304 {
305 	if (!chunk->asoc->peer.prsctp_capable)
306 		return 0;
307 
308 	if (chunk->msg->abandoned)
309 		return 1;
310 
311 	if (!chunk->has_tsn &&
312 	    !(chunk->chunk_hdr->flags & SCTP_DATA_FIRST_FRAG))
313 		return 0;
314 
315 	if (SCTP_PR_TTL_ENABLED(chunk->sinfo.sinfo_flags) &&
316 	    time_after(jiffies, chunk->msg->expires_at)) {
317 		struct sctp_stream_out *streamout =
318 			&chunk->asoc->stream.out[chunk->sinfo.sinfo_stream];
319 
320 		if (chunk->sent_count) {
321 			chunk->asoc->abandoned_sent[SCTP_PR_INDEX(TTL)]++;
322 			streamout->ext->abandoned_sent[SCTP_PR_INDEX(TTL)]++;
323 		} else {
324 			chunk->asoc->abandoned_unsent[SCTP_PR_INDEX(TTL)]++;
325 			streamout->ext->abandoned_unsent[SCTP_PR_INDEX(TTL)]++;
326 		}
327 		chunk->msg->abandoned = 1;
328 		return 1;
329 	} else if (SCTP_PR_RTX_ENABLED(chunk->sinfo.sinfo_flags) &&
330 		   chunk->sent_count > chunk->sinfo.sinfo_timetolive) {
331 		struct sctp_stream_out *streamout =
332 			&chunk->asoc->stream.out[chunk->sinfo.sinfo_stream];
333 
334 		chunk->asoc->abandoned_sent[SCTP_PR_INDEX(RTX)]++;
335 		streamout->ext->abandoned_sent[SCTP_PR_INDEX(RTX)]++;
336 		chunk->msg->abandoned = 1;
337 		return 1;
338 	} else if (!SCTP_PR_POLICY(chunk->sinfo.sinfo_flags) &&
339 		   chunk->msg->expires_at &&
340 		   time_after(jiffies, chunk->msg->expires_at)) {
341 		chunk->msg->abandoned = 1;
342 		return 1;
343 	}
344 	/* PRIO policy is processed by sendmsg, not here */
345 
346 	return 0;
347 }
348 
349 /* This chunk (and consequently entire message) has failed in its sending. */
350 void sctp_chunk_fail(struct sctp_chunk *chunk, int error)
351 {
352 	chunk->msg->send_failed = 1;
353 	chunk->msg->send_error = error;
354 }
355