net/sched/sch_dsmark.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /* net/sched/sch_dsmark.c - Differentiated Services field marker */
   3
   4 /* Written 1998-2000 by Werner Almesberger, EPFL ICA */
   5
   6
   7 #include <linux/module.h>
   8 #include <linux/init.h>
   9 #include <linux/slab.h>
  10 #include <linux/types.h>
  11 #include <linux/string.h>
  12 #include <linux/errno.h>
  13 #include <linux/skbuff.h>
  14 #include <linux/rtnetlink.h>
  15 #include <linux/bitops.h>
  16 #include <net/pkt_sched.h>
  17 #include <net/pkt_cls.h>
  18 #include <net/dsfield.h>
  19 #include <net/inet_ecn.h>
  20 #include <asm/byteorder.h>
  21
  22 /*
  23  * classid      class           marking
  24  * -------      -----           -------
  25  *   n/a          0             n/a
  26  *   x:0          1             use entry [0]
  27  *   ...         ...            ...
  28  *   x:y y>0     y+1            use entry [y]
  29  *   ...         ...            ...
  30  * x:indices-1  indices         use entry [indices-1]
  31  *   ...         ...            ...
  32  *   x:y         y+1            use entry [y & (indices-1)]
  33  *   ...         ...            ...
  34  * 0xffff       0x10000         use entry [indices-1]
  35  */
  36
  37
  38 #define NO_DEFAULT_INDEX        (1 << 16)
  39
  40 struct mask_value {
  41         u8                      mask;
  42         u8                      value;
  43 };
  44
  45 struct dsmark_qdisc_data {
  46         struct Qdisc            *q;
  47         struct tcf_proto __rcu  *filter_list;
  48         struct tcf_block        *block;
  49         struct mask_value       *mv;
  50         u16                     indices;
  51         u8                      set_tc_index;
  52         u32                     default_index;  /* index range is 0...0xffff */
  53 #define DSMARK_EMBEDDED_SZ      16
  54         struct mask_value       embedded[DSMARK_EMBEDDED_SZ];
  55 };
  56
  57 static inline int dsmark_valid_index(struct dsmark_qdisc_data *p, u16 index)
  58 {
  59         return index <= p->indices && index > 0;
  60 }
  61
  62 /* ------------------------- Class/flow operations ------------------------- */
  63
  64 static int dsmark_graft(struct Qdisc *sch, unsigned long arg,
  65                         struct Qdisc *new, struct Qdisc **old,
  66                         struct netlink_ext_ack *extack)
  67 {
  68         struct dsmark_qdisc_data *p = qdisc_priv(sch);
  69
  70         pr_debug("%s(sch %p,[qdisc %p],new %p,old %p)\n",
  71                  __func__, sch, p, new, old);
  72
  73         if (new == NULL) {
  74                 new = qdisc_create_dflt(sch->dev_queue, &pfifo_qdisc_ops,
  75                                         sch->handle, NULL);
  76                 if (new == NULL)
  77                         new = &noop_qdisc;
  78         }
  79
  80         *old = qdisc_replace(sch, new, &p->q);
  81         return 0;
  82 }
  83
  84 static struct Qdisc *dsmark_leaf(struct Qdisc *sch, unsigned long arg)
  85 {
  86         struct dsmark_qdisc_data *p = qdisc_priv(sch);
  87         return p->q;
  88 }
  89
  90 static unsigned long dsmark_find(struct Qdisc *sch, u32 classid)
  91 {
  92         return TC_H_MIN(classid) + 1;
  93 }
  94
  95 static unsigned long dsmark_bind_filter(struct Qdisc *sch,
  96                                         unsigned long parent, u32 classid)
  97 {
  98         pr_debug("%s(sch %p,[qdisc %p],classid %x)\n",
  99                  __func__, sch, qdisc_priv(sch), classid);
 100
 101         return dsmark_find(sch, classid);
 102 }
 103
 104 static void dsmark_unbind_filter(struct Qdisc *sch, unsigned long cl)
 105 {
 106 }
 107
 108 static const struct nla_policy dsmark_policy[TCA_DSMARK_MAX + 1] = {
 109         [TCA_DSMARK_INDICES]            = { .type = NLA_U16 },
 110         [TCA_DSMARK_DEFAULT_INDEX]      = { .type = NLA_U16 },
 111         [TCA_DSMARK_SET_TC_INDEX]       = { .type = NLA_FLAG },
 112         [TCA_DSMARK_MASK]               = { .type = NLA_U8 },
 113         [TCA_DSMARK_VALUE]              = { .type = NLA_U8 },
 114 };
 115
 116 static int dsmark_change(struct Qdisc *sch, u32 classid, u32 parent,
 117                          struct nlattr **tca, unsigned long *arg,
 118                          struct netlink_ext_ack *extack)
 119 {
 120         struct dsmark_qdisc_data *p = qdisc_priv(sch);
 121         struct nlattr *opt = tca[TCA_OPTIONS];
 122         struct nlattr *tb[TCA_DSMARK_MAX + 1];
 123         int err = -EINVAL;
 124
 125         pr_debug("%s(sch %p,[qdisc %p],classid %x,parent %x), arg 0x%lx\n",
 126                  __func__, sch, p, classid, parent, *arg);
 127
 128         if (!dsmark_valid_index(p, *arg)) {
 129                 err = -ENOENT;
 130                 goto errout;
 131         }
 132
 133         if (!opt)
 134                 goto errout;
 135
 136         err = nla_parse_nested_deprecated(tb, TCA_DSMARK_MAX, opt,
 137                                           dsmark_policy, NULL);
 138         if (err < 0)
 139                 goto errout;
 140
 141         if (tb[TCA_DSMARK_VALUE])
 142                 p->mv[*arg - 1].value = nla_get_u8(tb[TCA_DSMARK_VALUE]);
 143
 144         if (tb[TCA_DSMARK_MASK])
 145                 p->mv[*arg - 1].mask = nla_get_u8(tb[TCA_DSMARK_MASK]);
 146
 147         err = 0;
 148
 149 errout:
 150         return err;
 151 }
 152
 153 static int dsmark_delete(struct Qdisc *sch, unsigned long arg,
 154                          struct netlink_ext_ack *extack)
 155 {
 156         struct dsmark_qdisc_data *p = qdisc_priv(sch);
 157
 158         if (!dsmark_valid_index(p, arg))
 159                 return -EINVAL;
 160
 161         p->mv[arg - 1].mask = 0xff;
 162         p->mv[arg - 1].value = 0;
 163
 164         return 0;
 165 }
 166
 167 static void dsmark_walk(struct Qdisc *sch, struct qdisc_walker *walker)
 168 {
 169         struct dsmark_qdisc_data *p = qdisc_priv(sch);
 170         int i;
 171
 172         pr_debug("%s(sch %p,[qdisc %p],walker %p)\n",
 173                  __func__, sch, p, walker);
 174
 175         if (walker->stop)
 176                 return;
 177
 178         for (i = 0; i < p->indices; i++) {
 179                 if (p->mv[i].mask == 0xff && !p->mv[i].value) {
 180                         walker->count++;
 181                         continue;
 182                 }
 183                 if (!tc_qdisc_stats_dump(sch, i + 1, walker))
 184                         break;
 185         }
 186 }
 187
 188 static struct tcf_block *dsmark_tcf_block(struct Qdisc *sch, unsigned long cl,
 189                                           struct netlink_ext_ack *extack)
 190 {
 191         struct dsmark_qdisc_data *p = qdisc_priv(sch);
 192
 193         return p->block;
 194 }
 195
 196 /* --------------------------- Qdisc operations ---------------------------- */
 197
 198 static int dsmark_enqueue(struct sk_buff *skb, struct Qdisc *sch,
 199                           struct sk_buff **to_free)
 200 {
 201         unsigned int len = qdisc_pkt_len(skb);
 202         struct dsmark_qdisc_data *p = qdisc_priv(sch);
 203         int err;
 204
 205         pr_debug("%s(skb %p,sch %p,[qdisc %p])\n", __func__, skb, sch, p);
 206
 207         if (p->set_tc_index) {
 208                 int wlen = skb_network_offset(skb);
 209
 210                 switch (skb_protocol(skb, true)) {
 211                 case htons(ETH_P_IP):
 212                         wlen += sizeof(struct iphdr);
 213                         if (!pskb_may_pull(skb, wlen) ||
 214                             skb_try_make_writable(skb, wlen))
 215                                 goto drop;
 216
 217                         skb->tc_index = ipv4_get_dsfield(ip_hdr(skb))
 218                                 & ~INET_ECN_MASK;
 219                         break;
 220
 221                 case htons(ETH_P_IPV6):
 222                         wlen += sizeof(struct ipv6hdr);
 223                         if (!pskb_may_pull(skb, wlen) ||
 224                             skb_try_make_writable(skb, wlen))
 225                                 goto drop;
 226
 227                         skb->tc_index = ipv6_get_dsfield(ipv6_hdr(skb))
 228                                 & ~INET_ECN_MASK;
 229                         break;
 230                 default:
 231                         skb->tc_index = 0;
 232                         break;
 233                 }
 234         }
 235
 236         if (TC_H_MAJ(skb->priority) == sch->handle)
 237                 skb->tc_index = TC_H_MIN(skb->priority);
 238         else {
 239                 struct tcf_result res;
 240                 struct tcf_proto *fl = rcu_dereference_bh(p->filter_list);
 241                 int result = tcf_classify(skb, NULL, fl, &res, false);
 242
 243                 pr_debug("result %d class 0x%04x\n", result, res.classid);
 244
 245                 switch (result) {
 246 #ifdef CONFIG_NET_CLS_ACT
 247                 case TC_ACT_QUEUED:
 248                 case TC_ACT_STOLEN:
 249                 case TC_ACT_TRAP:
 250                         __qdisc_drop(skb, to_free);
 251                         return NET_XMIT_SUCCESS | __NET_XMIT_STOLEN;
 252
 253                 case TC_ACT_SHOT:
 254                         goto drop;
 255 #endif
 256                 case TC_ACT_OK:
 257                         skb->tc_index = TC_H_MIN(res.classid);
 258                         break;
 259
 260                 default:
 261                         if (p->default_index != NO_DEFAULT_INDEX)
 262                                 skb->tc_index = p->default_index;
 263                         break;
 264                 }
 265         }
 266
 267         err = qdisc_enqueue(skb, p->q, to_free);
 268         if (err != NET_XMIT_SUCCESS) {
 269                 if (net_xmit_drop_count(err))
 270                         qdisc_qstats_drop(sch);
 271                 return err;
 272         }
 273
 274         sch->qstats.backlog += len;
 275         sch->q.qlen++;
 276
 277         return NET_XMIT_SUCCESS;
 278
 279 drop:
 280         qdisc_drop(skb, sch, to_free);
 281         return NET_XMIT_SUCCESS | __NET_XMIT_BYPASS;
 282 }
 283
 284 static struct sk_buff *dsmark_dequeue(struct Qdisc *sch)
 285 {
 286         struct dsmark_qdisc_data *p = qdisc_priv(sch);
 287         struct sk_buff *skb;
 288         u32 index;
 289
 290         pr_debug("%s(sch %p,[qdisc %p])\n", __func__, sch, p);
 291
 292         skb = qdisc_dequeue_peeked(p->q);
 293         if (skb == NULL)
 294                 return NULL;
 295
 296         qdisc_bstats_update(sch, skb);
 297         qdisc_qstats_backlog_dec(sch, skb);
 298         sch->q.qlen--;
 299
 300         index = skb->tc_index & (p->indices - 1);
 301         pr_debug("index %d->%d\n", skb->tc_index, index);
 302
 303         switch (skb_protocol(skb, true)) {
 304         case htons(ETH_P_IP):
 305                 ipv4_change_dsfield(ip_hdr(skb), p->mv[index].mask,
 306                                     p->mv[index].value);
 307                         break;
 308         case htons(ETH_P_IPV6):
 309                 ipv6_change_dsfield(ipv6_hdr(skb), p->mv[index].mask,
 310                                     p->mv[index].value);
 311                         break;
 312         default:
 313                 /*
 314                  * Only complain if a change was actually attempted.
 315                  * This way, we can send non-IP traffic through dsmark
 316                  * and don't need yet another qdisc as a bypass.
 317                  */
 318                 if (p->mv[index].mask != 0xff || p->mv[index].value)
 319                         pr_warn("%s: unsupported protocol %d\n",
 320                                 __func__, ntohs(skb_protocol(skb, true)));
 321                 break;
 322         }
 323
 324         return skb;
 325 }
 326
 327 static struct sk_buff *dsmark_peek(struct Qdisc *sch)
 328 {
 329         struct dsmark_qdisc_data *p = qdisc_priv(sch);
 330
 331         pr_debug("%s(sch %p,[qdisc %p])\n", __func__, sch, p);
 332
 333         return p->q->ops->peek(p->q);
 334 }
 335
 336 static int dsmark_init(struct Qdisc *sch, struct nlattr *opt,
 337                        struct netlink_ext_ack *extack)
 338 {
 339         struct dsmark_qdisc_data *p = qdisc_priv(sch);
 340         struct nlattr *tb[TCA_DSMARK_MAX + 1];
 341         int err = -EINVAL;
 342         u32 default_index = NO_DEFAULT_INDEX;
 343         u16 indices;
 344         int i;
 345
 346         pr_debug("%s(sch %p,[qdisc %p],opt %p)\n", __func__, sch, p, opt);
 347
 348         if (!opt)
 349                 goto errout;
 350
 351         err = tcf_block_get(&p->block, &p->filter_list, sch, extack);
 352         if (err)
 353                 return err;
 354
 355         err = nla_parse_nested_deprecated(tb, TCA_DSMARK_MAX, opt,
 356                                           dsmark_policy, NULL);
 357         if (err < 0)
 358                 goto errout;
 359
 360         err = -EINVAL;
 361         if (!tb[TCA_DSMARK_INDICES])
 362                 goto errout;
 363         indices = nla_get_u16(tb[TCA_DSMARK_INDICES]);
 364
 365         if (hweight32(indices) != 1)
 366                 goto errout;
 367
 368         if (tb[TCA_DSMARK_DEFAULT_INDEX])
 369                 default_index = nla_get_u16(tb[TCA_DSMARK_DEFAULT_INDEX]);
 370
 371         if (indices <= DSMARK_EMBEDDED_SZ)
 372                 p->mv = p->embedded;
 373         else
 374                 p->mv = kmalloc_array(indices, sizeof(*p->mv), GFP_KERNEL);
 375         if (!p->mv) {
 376                 err = -ENOMEM;
 377                 goto errout;
 378         }
 379         for (i = 0; i < indices; i++) {
 380                 p->mv[i].mask = 0xff;
 381                 p->mv[i].value = 0;
 382         }
 383         p->indices = indices;
 384         p->default_index = default_index;
 385         p->set_tc_index = nla_get_flag(tb[TCA_DSMARK_SET_TC_INDEX]);
 386
 387         p->q = qdisc_create_dflt(sch->dev_queue, &pfifo_qdisc_ops, sch->handle,
 388                                  NULL);
 389         if (p->q == NULL)
 390                 p->q = &noop_qdisc;
 391         else
 392                 qdisc_hash_add(p->q, true);
 393
 394         pr_debug("%s: qdisc %p\n", __func__, p->q);
 395
 396         err = 0;
 397 errout:
 398         return err;
 399 }
 400
 401 static void dsmark_reset(struct Qdisc *sch)
 402 {
 403         struct dsmark_qdisc_data *p = qdisc_priv(sch);
 404
 405         pr_debug("%s(sch %p,[qdisc %p])\n", __func__, sch, p);
 406         if (p->q)
 407                 qdisc_reset(p->q);
 408 }
 409
 410 static void dsmark_destroy(struct Qdisc *sch)
 411 {
 412         struct dsmark_qdisc_data *p = qdisc_priv(sch);
 413
 414         pr_debug("%s(sch %p,[qdisc %p])\n", __func__, sch, p);
 415
 416         tcf_block_put(p->block);
 417         qdisc_put(p->q);
 418         if (p->mv != p->embedded)
 419                 kfree(p->mv);
 420 }
 421
 422 static int dsmark_dump_class(struct Qdisc *sch, unsigned long cl,
 423                              struct sk_buff *skb, struct tcmsg *tcm)
 424 {
 425         struct dsmark_qdisc_data *p = qdisc_priv(sch);
 426         struct nlattr *opts = NULL;
 427
 428         pr_debug("%s(sch %p,[qdisc %p],class %ld\n", __func__, sch, p, cl);
 429
 430         if (!dsmark_valid_index(p, cl))
 431                 return -EINVAL;
 432
 433         tcm->tcm_handle = TC_H_MAKE(TC_H_MAJ(sch->handle), cl - 1);
 434         tcm->tcm_info = p->q->handle;
 435
 436         opts = nla_nest_start_noflag(skb, TCA_OPTIONS);
 437         if (opts == NULL)
 438                 goto nla_put_failure;
 439         if (nla_put_u8(skb, TCA_DSMARK_MASK, p->mv[cl - 1].mask) ||
 440             nla_put_u8(skb, TCA_DSMARK_VALUE, p->mv[cl - 1].value))
 441                 goto nla_put_failure;
 442
 443         return nla_nest_end(skb, opts);
 444
 445 nla_put_failure:
 446         nla_nest_cancel(skb, opts);
 447         return -EMSGSIZE;
 448 }
 449
 450 static int dsmark_dump(struct Qdisc *sch, struct sk_buff *skb)
 451 {
 452         struct dsmark_qdisc_data *p = qdisc_priv(sch);
 453         struct nlattr *opts = NULL;
 454
 455         opts = nla_nest_start_noflag(skb, TCA_OPTIONS);
 456         if (opts == NULL)
 457                 goto nla_put_failure;
 458         if (nla_put_u16(skb, TCA_DSMARK_INDICES, p->indices))
 459                 goto nla_put_failure;
 460
 461         if (p->default_index != NO_DEFAULT_INDEX &&
 462             nla_put_u16(skb, TCA_DSMARK_DEFAULT_INDEX, p->default_index))
 463                 goto nla_put_failure;
 464
 465         if (p->set_tc_index &&
 466             nla_put_flag(skb, TCA_DSMARK_SET_TC_INDEX))
 467                 goto nla_put_failure;
 468
 469         return nla_nest_end(skb, opts);
 470
 471 nla_put_failure:
 472         nla_nest_cancel(skb, opts);
 473         return -EMSGSIZE;
 474 }
 475
 476 static const struct Qdisc_class_ops dsmark_class_ops = {
 477         .graft          =       dsmark_graft,
 478         .leaf           =       dsmark_leaf,
 479         .find           =       dsmark_find,
 480         .change         =       dsmark_change,
 481         .delete         =       dsmark_delete,
 482         .walk           =       dsmark_walk,
 483         .tcf_block      =       dsmark_tcf_block,
 484         .bind_tcf       =       dsmark_bind_filter,
 485         .unbind_tcf     =       dsmark_unbind_filter,
 486         .dump           =       dsmark_dump_class,
 487 };
 488
 489 static struct Qdisc_ops dsmark_qdisc_ops __read_mostly = {
 490         .next           =       NULL,
 491         .cl_ops         =       &dsmark_class_ops,
 492         .id             =       "dsmark",
 493         .priv_size      =       sizeof(struct dsmark_qdisc_data),
 494         .enqueue        =       dsmark_enqueue,
 495         .dequeue        =       dsmark_dequeue,
 496         .peek           =       dsmark_peek,
 497         .init           =       dsmark_init,
 498         .reset          =       dsmark_reset,
 499         .destroy        =       dsmark_destroy,
 500         .change         =       NULL,
 501         .dump           =       dsmark_dump,
 502         .owner          =       THIS_MODULE,
 503 };
 504
 505 static int __init dsmark_module_init(void)
 506 {
 507         return register_qdisc(&dsmark_qdisc_ops);
 508 }
 509
 510 static void __exit dsmark_module_exit(void)
 511 {
 512         unregister_qdisc(&dsmark_qdisc_ops);
 513 }
 514
 515 module_init(dsmark_module_init)
 516 module_exit(dsmark_module_exit)
 517
 518 MODULE_LICENSE("GPL");