xref: /linux/include/net/sctp/stream_sched.h (revision a1ff5a7d78a036d6c2178ee5acd6ba4946243800)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /* SCTP kernel implementation
3  * (C) Copyright Red Hat Inc. 2017
4  *
5  * These are definitions used by the stream schedulers, defined in RFC
6  * draft ndata (https://tools.ietf.org/html/draft-ietf-tsvwg-sctp-ndata-11)
7  *
8  * Please send any bug reports or fixes you make to the
9  * email addresses:
10  *    lksctp developers <linux-sctp@vger.kernel.org>
11  *
12  * Written or modified by:
13  *   Marcelo Ricardo Leitner <marcelo.leitner@gmail.com>
14  */
15 
16 #ifndef __sctp_stream_sched_h__
17 #define __sctp_stream_sched_h__
18 
19 struct sctp_sched_ops {
20 	/* Property handling for a given stream */
21 	int (*set)(struct sctp_stream *stream, __u16 sid, __u16 value,
22 		   gfp_t gfp);
23 	int (*get)(struct sctp_stream *stream, __u16 sid, __u16 *value);
24 
25 	/* Init the specific scheduler */
26 	int (*init)(struct sctp_stream *stream);
27 	/* Init a stream */
28 	int (*init_sid)(struct sctp_stream *stream, __u16 sid, gfp_t gfp);
29 	/* free a stream */
30 	void (*free_sid)(struct sctp_stream *stream, __u16 sid);
31 
32 	/* Enqueue a chunk */
33 	void (*enqueue)(struct sctp_outq *q, struct sctp_datamsg *msg);
34 	/* Dequeue a chunk */
35 	struct sctp_chunk *(*dequeue)(struct sctp_outq *q);
36 	/* Called only if the chunk fit the packet */
37 	void (*dequeue_done)(struct sctp_outq *q, struct sctp_chunk *chunk);
38 	/* Schedule all chunks already enqueued */
39 	void (*sched_all)(struct sctp_stream *stream);
40 	/* Unschedule all chunks already enqueued */
41 	void (*unsched_all)(struct sctp_stream *stream);
42 };
43 
44 int sctp_sched_set_sched(struct sctp_association *asoc,
45 			 enum sctp_sched_type sched);
46 int sctp_sched_get_sched(struct sctp_association *asoc);
47 int sctp_sched_set_value(struct sctp_association *asoc, __u16 sid,
48 			 __u16 value, gfp_t gfp);
49 int sctp_sched_get_value(struct sctp_association *asoc, __u16 sid,
50 			 __u16 *value);
51 void sctp_sched_dequeue_done(struct sctp_outq *q, struct sctp_chunk *ch);
52 
53 void sctp_sched_dequeue_common(struct sctp_outq *q, struct sctp_chunk *ch);
54 int sctp_sched_init_sid(struct sctp_stream *stream, __u16 sid, gfp_t gfp);
55 struct sctp_sched_ops *sctp_sched_ops_from_stream(struct sctp_stream *stream);
56 
57 void sctp_sched_ops_register(enum sctp_sched_type sched,
58 			     struct sctp_sched_ops *sched_ops);
59 void sctp_sched_ops_prio_init(void);
60 void sctp_sched_ops_rr_init(void);
61 void sctp_sched_ops_fc_init(void);
62 void sctp_sched_ops_wfq_init(void);
63 
64 #endif /* __sctp_stream_sched_h__ */
65