include/net/inet_ecn.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _INET_ECN_H_
   3 #define _INET_ECN_H_
   4
   5 #include <linux/ip.h>
   6 #include <linux/skbuff.h>
   7 #include <linux/if_vlan.h>
   8
   9 #include <net/inet_sock.h>
  10 #include <net/dsfield.h>
  11
  12 enum {
  13         INET_ECN_NOT_ECT = 0,
  14         INET_ECN_ECT_1 = 1,
  15         INET_ECN_ECT_0 = 2,
  16         INET_ECN_CE = 3,
  17         INET_ECN_MASK = 3,
  18 };
  19
  20 extern int sysctl_tunnel_ecn_log;
  21
  22 static inline int INET_ECN_is_ce(__u8 dsfield)
  23 {
  24         return (dsfield & INET_ECN_MASK) == INET_ECN_CE;
  25 }
  26
  27 static inline int INET_ECN_is_not_ect(__u8 dsfield)
  28 {
  29         return (dsfield & INET_ECN_MASK) == INET_ECN_NOT_ECT;
  30 }
  31
  32 static inline int INET_ECN_is_capable(__u8 dsfield)
  33 {
  34         return dsfield & INET_ECN_ECT_0;
  35 }
  36
  37 /*
  38  * RFC 3168 9.1.1
  39  *  The full-functionality option for ECN encapsulation is to copy the
  40  *  ECN codepoint of the inside header to the outside header on
  41  *  encapsulation if the inside header is not-ECT or ECT, and to set the
  42  *  ECN codepoint of the outside header to ECT(0) if the ECN codepoint of
  43  *  the inside header is CE.
  44  */
  45 static inline __u8 INET_ECN_encapsulate(__u8 outer, __u8 inner)
  46 {
  47         outer &= ~INET_ECN_MASK;
  48         outer |= !INET_ECN_is_ce(inner) ? (inner & INET_ECN_MASK) :
  49                                           INET_ECN_ECT_0;
  50         return outer;
  51 }
  52
  53 static inline void INET_ECN_xmit(struct sock *sk)
  54 {
  55         inet_sk(sk)->tos |= INET_ECN_ECT_0;
  56         if (inet6_sk(sk) != NULL)
  57                 inet6_sk(sk)->tclass |= INET_ECN_ECT_0;
  58 }
  59
  60 static inline void INET_ECN_dontxmit(struct sock *sk)
  61 {
  62         inet_sk(sk)->tos &= ~INET_ECN_MASK;
  63         if (inet6_sk(sk) != NULL)
  64                 inet6_sk(sk)->tclass &= ~INET_ECN_MASK;
  65 }
  66
  67 #define IP6_ECN_flow_init(label) do {           \
  68       (label) &= ~htonl(INET_ECN_MASK << 20);   \
  69     } while (0)
  70
  71 #define IP6_ECN_flow_xmit(sk, label) do {                               \
  72         if (INET_ECN_is_capable(inet6_sk(sk)->tclass))                  \
  73                 (label) |= htonl(INET_ECN_ECT_0 << 20);                 \
  74     } while (0)
  75
  76 static inline int IP_ECN_set_ce(struct iphdr *iph)
  77 {
  78         u32 check = (__force u32)iph->check;
  79         u32 ecn = (iph->tos + 1) & INET_ECN_MASK;
  80
  81         /*
  82          * After the last operation we have (in binary):
  83          * INET_ECN_NOT_ECT => 01
  84          * INET_ECN_ECT_1   => 10
  85          * INET_ECN_ECT_0   => 11
  86          * INET_ECN_CE      => 00
  87          */
  88         if (!(ecn & 2))
  89                 return !ecn;
  90
  91         /*
  92          * The following gives us:
  93          * INET_ECN_ECT_1 => check += htons(0xFFFD)
  94          * INET_ECN_ECT_0 => check += htons(0xFFFE)
  95          */
  96         check += (__force u16)htons(0xFFFB) + (__force u16)htons(ecn);
  97
  98         iph->check = (__force __sum16)(check + (check>=0xFFFF));
  99         iph->tos |= INET_ECN_CE;
 100         return 1;
 101 }
 102
 103 static inline void IP_ECN_clear(struct iphdr *iph)
 104 {
 105         iph->tos &= ~INET_ECN_MASK;
 106 }
 107
 108 static inline void ipv4_copy_dscp(unsigned int dscp, struct iphdr *inner)
 109 {
 110         dscp &= ~INET_ECN_MASK;
 111         ipv4_change_dsfield(inner, INET_ECN_MASK, dscp);
 112 }
 113
 114 struct ipv6hdr;
 115
 116 /* Note:
 117  * IP_ECN_set_ce() has to tweak IPV4 checksum when setting CE,
 118  * meaning both changes have no effect on skb->csum if/when CHECKSUM_COMPLETE
 119  * In IPv6 case, no checksum compensates the change in IPv6 header,
 120  * so we have to update skb->csum.
 121  */
 122 static inline int IP6_ECN_set_ce(struct sk_buff *skb, struct ipv6hdr *iph)
 123 {
 124         __be32 from, to;
 125
 126         if (INET_ECN_is_not_ect(ipv6_get_dsfield(iph)))
 127                 return 0;
 128
 129         from = *(__be32 *)iph;
 130         to = from | htonl(INET_ECN_CE << 20);
 131         *(__be32 *)iph = to;
 132         if (skb->ip_summed == CHECKSUM_COMPLETE)
 133                 skb->csum = csum_add(csum_sub(skb->csum, (__force __wsum)from),
 134                                      (__force __wsum)to);
 135         return 1;
 136 }
 137
 138 static inline void IP6_ECN_clear(struct ipv6hdr *iph)
 139 {
 140         *(__be32*)iph &= ~htonl(INET_ECN_MASK << 20);
 141 }
 142
 143 static inline void ipv6_copy_dscp(unsigned int dscp, struct ipv6hdr *inner)
 144 {
 145         dscp &= ~INET_ECN_MASK;
 146         ipv6_change_dsfield(inner, INET_ECN_MASK, dscp);
 147 }
 148
 149 static inline int INET_ECN_set_ce(struct sk_buff *skb)
 150 {
 151         switch (skb->protocol) {
 152         case cpu_to_be16(ETH_P_IP):
 153                 if (skb_network_header(skb) + sizeof(struct iphdr) <=
 154                     skb_tail_pointer(skb))
 155                         return IP_ECN_set_ce(ip_hdr(skb));
 156                 break;
 157
 158         case cpu_to_be16(ETH_P_IPV6):
 159                 if (skb_network_header(skb) + sizeof(struct ipv6hdr) <=
 160                     skb_tail_pointer(skb))
 161                         return IP6_ECN_set_ce(skb, ipv6_hdr(skb));
 162                 break;
 163         }
 164
 165         return 0;
 166 }
 167
 168 /*
 169  * RFC 6040 4.2
 170  *  To decapsulate the inner header at the tunnel egress, a compliant
 171  *  tunnel egress MUST set the outgoing ECN field to the codepoint at the
 172  *  intersection of the appropriate arriving inner header (row) and outer
 173  *  header (column) in Figure 4
 174  *
 175  *      +---------+------------------------------------------------+
 176  *      |Arriving |            Arriving Outer Header               |
 177  *      |   Inner +---------+------------+------------+------------+
 178  *      |  Header | Not-ECT | ECT(0)     | ECT(1)     |     CE     |
 179  *      +---------+---------+------------+------------+------------+
 180  *      | Not-ECT | Not-ECT |Not-ECT(!!!)|Not-ECT(!!!)| <drop>(!!!)|
 181  *      |  ECT(0) |  ECT(0) | ECT(0)     | ECT(1)     |     CE     |
 182  *      |  ECT(1) |  ECT(1) | ECT(1) (!) | ECT(1)     |     CE     |
 183  *      |    CE   |      CE |     CE     |     CE(!!!)|     CE     |
 184  *      +---------+---------+------------+------------+------------+
 185  *
 186  *             Figure 4: New IP in IP Decapsulation Behaviour
 187  *
 188  *  returns 0 on success
 189  *          1 if something is broken and should be logged (!!! above)
 190  *          2 if packet should be dropped
 191  */
 192 static inline int INET_ECN_decapsulate(struct sk_buff *skb,
 193                                        __u8 outer, __u8 inner)
 194 {
 195         if (INET_ECN_is_not_ect(inner)) {
 196                 switch (outer & INET_ECN_MASK) {
 197                 case INET_ECN_NOT_ECT:
 198                         return 0;
 199                 case INET_ECN_ECT_0:
 200                 case INET_ECN_ECT_1:
 201                         return 1;
 202                 case INET_ECN_CE:
 203                         return 2;
 204                 }
 205         }
 206
 207         if (INET_ECN_is_ce(outer))
 208                 INET_ECN_set_ce(skb);
 209
 210         return 0;
 211 }
 212
 213 static inline int IP_ECN_decapsulate(const struct iphdr *oiph,
 214                                      struct sk_buff *skb)
 215 {
 216         __u8 inner;
 217
 218         if (skb->protocol == htons(ETH_P_IP))
 219                 inner = ip_hdr(skb)->tos;
 220         else if (skb->protocol == htons(ETH_P_IPV6))
 221                 inner = ipv6_get_dsfield(ipv6_hdr(skb));
 222         else
 223                 return 0;
 224
 225         return INET_ECN_decapsulate(skb, oiph->tos, inner);
 226 }
 227
 228 static inline int IP6_ECN_decapsulate(const struct ipv6hdr *oipv6h,
 229                                       struct sk_buff *skb)
 230 {
 231         __u8 inner;
 232
 233         if (skb->protocol == htons(ETH_P_IP))
 234                 inner = ip_hdr(skb)->tos;
 235         else if (skb->protocol == htons(ETH_P_IPV6))
 236                 inner = ipv6_get_dsfield(ipv6_hdr(skb));
 237         else
 238                 return 0;
 239
 240         return INET_ECN_decapsulate(skb, ipv6_get_dsfield(oipv6h), inner);
 241 }
 242 #endif