1/* SCTP kernel implementation
 2 * (C) Copyright Red Hat Inc. 2017
 3 *
 4 * These are definitions used by the stream schedulers, defined in RFC
 5 * draft ndata (https://tools.ietf.org/html/draft-ietf-tsvwg-sctp-ndata-11)
 6 *
 7 * This SCTP implementation is free software;
 8 * you can redistribute it and/or modify it under the terms of
 9 * the GNU General Public License as published by
10 * the Free Software Foundation; either version 2, or (at your option)
11 * any later version.
12 *
13 * This SCTP implementation  is distributed in the hope that it
14 * will be useful, but WITHOUT ANY WARRANTY; without even the implied
15 *                 ************************
16 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
17 * See the GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with GNU CC; see the file COPYING.  If not, see
21 * <http://www.gnu.org/licenses/>.
22 *
23 * Please send any bug reports or fixes you make to the
24 * email addresses:
25 *    lksctp developers <linux-sctp@vger.kernel.org>
26 *
27 * Written or modified by:
28 *   Marcelo Ricardo Leitner <marcelo.leitner@gmail.com>
29 */
30
31#ifndef __sctp_stream_sched_h__
32#define __sctp_stream_sched_h__
33
34struct sctp_sched_ops {
35	/* Property handling for a given stream */
36	int (*set)(struct sctp_stream *stream, __u16 sid, __u16 value,
37		   gfp_t gfp);
38	int (*get)(struct sctp_stream *stream, __u16 sid, __u16 *value);
39
40	/* Init the specific scheduler */
41	int (*init)(struct sctp_stream *stream);
42	/* Init a stream */
43	int (*init_sid)(struct sctp_stream *stream, __u16 sid, gfp_t gfp);
44	/* Frees the entire thing */
45	void (*free)(struct sctp_stream *stream);
46
47	/* Enqueue a chunk */
48	void (*enqueue)(struct sctp_outq *q, struct sctp_datamsg *msg);
49	/* Dequeue a chunk */
50	struct sctp_chunk *(*dequeue)(struct sctp_outq *q);
51	/* Called only if the chunk fit the packet */
52	void (*dequeue_done)(struct sctp_outq *q, struct sctp_chunk *chunk);
53	/* Sched all chunks already enqueued */
54	void (*sched_all)(struct sctp_stream *steam);
55	/* Unched all chunks already enqueued */
56	void (*unsched_all)(struct sctp_stream *steam);
57};
58
59int sctp_sched_set_sched(struct sctp_association *asoc,
60			 enum sctp_sched_type sched);
61int sctp_sched_get_sched(struct sctp_association *asoc);
62int sctp_sched_set_value(struct sctp_association *asoc, __u16 sid,
63			 __u16 value, gfp_t gfp);
64int sctp_sched_get_value(struct sctp_association *asoc, __u16 sid,
65			 __u16 *value);
66void sctp_sched_dequeue_done(struct sctp_outq *q, struct sctp_chunk *ch);
67
68void sctp_sched_dequeue_common(struct sctp_outq *q, struct sctp_chunk *ch);
69int sctp_sched_init_sid(struct sctp_stream *stream, __u16 sid, gfp_t gfp);
70struct sctp_sched_ops *sctp_sched_ops_from_stream(struct sctp_stream *stream);
71
72void sctp_sched_ops_register(enum sctp_sched_type sched,
73			     struct sctp_sched_ops *sched_ops);
74void sctp_sched_ops_prio_init(void);
75void sctp_sched_ops_rr_init(void);
76
77#endif /* __sctp_stream_sched_h__ */