net/sctp/stream_sched.c

   1 /* SCTP kernel implementation
   2  * (C) Copyright Red Hat Inc. 2017
   3  *
   4  * This file is part of the SCTP kernel implementation
   5  *
   6  * These functions manipulate sctp stream queue/scheduling.
   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 addresched(es):
  26  *    lksctp developers <linux-sctp@vger.kernel.org>
  27  *
  28  * Written or modified by:
  29  *    Marcelo Ricardo Leitner <marcelo.leitner@gmail.com>
  30  */
  31
  32 #include <linux/list.h>
  33 #include <net/sctp/sctp.h>
  34 #include <net/sctp/sm.h>
  35 #include <net/sctp/stream_sched.h>
  36
  37 /* First Come First Serve (a.k.a. FIFO)
  38  * RFC DRAFT ndata Section 3.1
  39  */
  40 static int sctp_sched_fcfs_set(struct sctp_stream *stream, __u16 sid,
  41                                __u16 value, gfp_t gfp)
  42 {
  43         return 0;
  44 }
  45
  46 static int sctp_sched_fcfs_get(struct sctp_stream *stream, __u16 sid,
  47                                __u16 *value)
  48 {
  49         *value = 0;
  50         return 0;
  51 }
  52
  53 static int sctp_sched_fcfs_init(struct sctp_stream *stream)
  54 {
  55         return 0;
  56 }
  57
  58 static int sctp_sched_fcfs_init_sid(struct sctp_stream *stream, __u16 sid,
  59                                     gfp_t gfp)
  60 {
  61         return 0;
  62 }
  63
  64 static void sctp_sched_fcfs_free(struct sctp_stream *stream)
  65 {
  66 }
  67
  68 static void sctp_sched_fcfs_enqueue(struct sctp_outq *q,
  69                                     struct sctp_datamsg *msg)
  70 {
  71 }
  72
  73 static struct sctp_chunk *sctp_sched_fcfs_dequeue(struct sctp_outq *q)
  74 {
  75         struct sctp_stream *stream = &q->asoc->stream;
  76         struct sctp_chunk *ch = NULL;
  77         struct list_head *entry;
  78
  79         if (list_empty(&q->out_chunk_list))
  80                 goto out;
  81
  82         if (stream->out_curr) {
  83                 ch = list_entry(stream->out_curr->ext->outq.next,
  84                                 struct sctp_chunk, stream_list);
  85         } else {
  86                 entry = q->out_chunk_list.next;
  87                 ch = list_entry(entry, struct sctp_chunk, list);
  88         }
  89
  90         sctp_sched_dequeue_common(q, ch);
  91
  92 out:
  93         return ch;
  94 }
  95
  96 static void sctp_sched_fcfs_dequeue_done(struct sctp_outq *q,
  97                                          struct sctp_chunk *chunk)
  98 {
  99 }
 100
 101 static void sctp_sched_fcfs_sched_all(struct sctp_stream *stream)
 102 {
 103 }
 104
 105 static void sctp_sched_fcfs_unsched_all(struct sctp_stream *stream)
 106 {
 107 }
 108
 109 static struct sctp_sched_ops sctp_sched_fcfs = {
 110         .set = sctp_sched_fcfs_set,
 111         .get = sctp_sched_fcfs_get,
 112         .init = sctp_sched_fcfs_init,
 113         .init_sid = sctp_sched_fcfs_init_sid,
 114         .free = sctp_sched_fcfs_free,
 115         .enqueue = sctp_sched_fcfs_enqueue,
 116         .dequeue = sctp_sched_fcfs_dequeue,
 117         .dequeue_done = sctp_sched_fcfs_dequeue_done,
 118         .sched_all = sctp_sched_fcfs_sched_all,
 119         .unsched_all = sctp_sched_fcfs_unsched_all,
 120 };
 121
 122 /* API to other parts of the stack */
 123
 124 extern struct sctp_sched_ops sctp_sched_prio;
 125 extern struct sctp_sched_ops sctp_sched_rr;
 126
 127 static struct sctp_sched_ops *sctp_sched_ops[] = {
 128         &sctp_sched_fcfs,
 129         &sctp_sched_prio,
 130         &sctp_sched_rr,
 131 };
 132
 133 int sctp_sched_set_sched(struct sctp_association *asoc,
 134                          enum sctp_sched_type sched)
 135 {
 136         struct sctp_sched_ops *n = sctp_sched_ops[sched];
 137         struct sctp_sched_ops *old = asoc->outqueue.sched;
 138         struct sctp_datamsg *msg = NULL;
 139         struct sctp_chunk *ch;
 140         int i, ret = 0;
 141
 142         if (old == n)
 143                 return ret;
 144
 145         if (sched > SCTP_SS_MAX)
 146                 return -EINVAL;
 147
 148         if (old) {
 149                 old->free(&asoc->stream);
 150
 151                 /* Give the next scheduler a clean slate. */
 152                 for (i = 0; i < asoc->stream.outcnt; i++) {
 153                         void *p = asoc->stream.out[i].ext;
 154
 155                         if (!p)
 156                                 continue;
 157
 158                         p += offsetofend(struct sctp_stream_out_ext, outq);
 159                         memset(p, 0, sizeof(struct sctp_stream_out_ext) -
 160                                      offsetofend(struct sctp_stream_out_ext, outq));
 161                 }
 162         }
 163
 164         asoc->outqueue.sched = n;
 165         n->init(&asoc->stream);
 166         for (i = 0; i < asoc->stream.outcnt; i++) {
 167                 if (!asoc->stream.out[i].ext)
 168                         continue;
 169
 170                 ret = n->init_sid(&asoc->stream, i, GFP_KERNEL);
 171                 if (ret)
 172                         goto err;
 173         }
 174
 175         /* We have to requeue all chunks already queued. */
 176         list_for_each_entry(ch, &asoc->outqueue.out_chunk_list, list) {
 177                 if (ch->msg == msg)
 178                         continue;
 179                 msg = ch->msg;
 180                 n->enqueue(&asoc->outqueue, msg);
 181         }
 182
 183         return ret;
 184
 185 err:
 186         n->free(&asoc->stream);
 187         asoc->outqueue.sched = &sctp_sched_fcfs; /* Always safe */
 188
 189         return ret;
 190 }
 191
 192 int sctp_sched_get_sched(struct sctp_association *asoc)
 193 {
 194         int i;
 195
 196         for (i = 0; i <= SCTP_SS_MAX; i++)
 197                 if (asoc->outqueue.sched == sctp_sched_ops[i])
 198                         return i;
 199
 200         return 0;
 201 }
 202
 203 int sctp_sched_set_value(struct sctp_association *asoc, __u16 sid,
 204                          __u16 value, gfp_t gfp)
 205 {
 206         if (sid >= asoc->stream.outcnt)
 207                 return -EINVAL;
 208
 209         if (!asoc->stream.out[sid].ext) {
 210                 int ret;
 211
 212                 ret = sctp_stream_init_ext(&asoc->stream, sid);
 213                 if (ret)
 214                         return ret;
 215         }
 216
 217         return asoc->outqueue.sched->set(&asoc->stream, sid, value, gfp);
 218 }
 219
 220 int sctp_sched_get_value(struct sctp_association *asoc, __u16 sid,
 221                          __u16 *value)
 222 {
 223         if (sid >= asoc->stream.outcnt)
 224                 return -EINVAL;
 225
 226         if (!asoc->stream.out[sid].ext)
 227                 return 0;
 228
 229         return asoc->outqueue.sched->get(&asoc->stream, sid, value);
 230 }
 231
 232 void sctp_sched_dequeue_done(struct sctp_outq *q, struct sctp_chunk *ch)
 233 {
 234         if (!list_is_last(&ch->frag_list, &ch->msg->chunks)) {
 235                 struct sctp_stream_out *sout;
 236                 __u16 sid;
 237
 238                 /* datamsg is not finish, so save it as current one,
 239                  * in case application switch scheduler or a higher
 240                  * priority stream comes in.
 241                  */
 242                 sid = sctp_chunk_stream_no(ch);
 243                 sout = &q->asoc->stream.out[sid];
 244                 q->asoc->stream.out_curr = sout;
 245                 return;
 246         }
 247
 248         q->asoc->stream.out_curr = NULL;
 249         q->sched->dequeue_done(q, ch);
 250 }
 251
 252 /* Auxiliary functions for the schedulers */
 253 void sctp_sched_dequeue_common(struct sctp_outq *q, struct sctp_chunk *ch)
 254 {
 255         list_del_init(&ch->list);
 256         list_del_init(&ch->stream_list);
 257         q->out_qlen -= ch->skb->len;
 258 }
 259
 260 int sctp_sched_init_sid(struct sctp_stream *stream, __u16 sid, gfp_t gfp)
 261 {
 262         struct sctp_sched_ops *sched = sctp_sched_ops_from_stream(stream);
 263
 264         INIT_LIST_HEAD(&stream->out[sid].ext->outq);
 265         return sched->init_sid(stream, sid, gfp);
 266 }
 267
 268 struct sctp_sched_ops *sctp_sched_ops_from_stream(struct sctp_stream *stream)
 269 {
 270         struct sctp_association *asoc;
 271
 272         asoc = container_of(stream, struct sctp_association, stream);
 273
 274         return asoc->outqueue.sched;
 275 }