src/vnet/policer/police.h

   1 /*
   2  * Copyright (c) 2015 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 #ifndef __POLICE_H__
  16 #define __POLICE_H__
  17
  18 typedef enum
  19 {
  20   POLICE_CONFORM = 0,
  21   POLICE_EXCEED = 1,
  22   POLICE_VIOLATE = 2,
  23 } policer_result_e;
  24
  25 // This is the hardware representation of the policer.
  26 // To be multithread-safe, the policer is accessed through a spin-lock
  27 // on the lock field. (For a policer update operation, 24B needs to be
  28 // modified and this would be a challenge to do with atomic instructions.)
  29 // The structure is padded so that no other data is put into the same
  30 // 64B cache-line. This reduces cache-thrashing between threads.
  31 //
  32 // A note on scale:
  33 // The HW TSC tick is roughly one CPU clock cycle.
  34 // This is shifted to create a larger period, with a goal to be around 50usec.
  35 // The period time will vary based on CPU clock speed.
  36 // CPU speeds of 1Ghz to 8Ghz are targetted.
  37 // The shift amount is a constant 17 bits, resulting in a period between
  38 // 16usec (8Ghz CPU) and 131usec (1Ghz CPU).
  39 // The token_per_period computation takes into account the clock speed.
  40 //
  41 // The 32-bit bucket/limit supports about 850ms of burst on a 40GE port,
  42 // or 340ms on a 100GE port. If a larger burst is configured, then the
  43 // programmed value is simply capped at 2^32-1. If we needed to support
  44 // more than that, the bucket and limit fields could be expanded.
  45 //
  46 // tokens_per_period should be > 1000 to support 0.1% granularity.
  47 // To support lower rates (which would not meet this requirement), the packet
  48 // length, bucket, and limit values can be scaled. The scale is a power of 2
  49 // so the multiplication can be implemented as a shift. The control plane
  50 // computes the shift amount be the largest possible that still supports the
  51 // burst size. This makes the rate accuracy as high as possible.
  52 //
  53 // The 64-bit last_update_time supports a 4Ghz CPU without rollover for 100
  54 // years
  55 //
  56 // The lock field should be used for a spin-lock on the struct. Alternatively,
  57 // a thread index field is provided so that policed packets may be handed
  58 // off to a single worker thread.
  59
  60 #define POLICER_TICKS_PER_PERIOD_SHIFT 17
  61 #define POLICER_TICKS_PER_PERIOD       (1 << POLICER_TICKS_PER_PERIOD_SHIFT)
  62
  63 typedef struct
  64 {
  65
  66   u32 lock;                     // for exclusive access to the struct
  67
  68   u32 single_rate;              // 1 = single rate policer, 0 = two rate policer
  69   u32 color_aware;              // for hierarchical policing
  70   u32 scale;                    // power-of-2 shift amount for lower rates
  71   u8 action[3];
  72   u8 mark_dscp[3];
  73   u8 pad[2];
  74
  75   // Fields are marked as 2R if they are only used for a 2-rate policer,
  76   // and MOD if they are modified as part of the update operation.
  77   // 1 token = 1 byte.
  78
  79   u32 cir_tokens_per_period;    // # of tokens for each period
  80   u32 pir_tokens_per_period;    // 2R
  81
  82   u32 current_limit;
  83   u32 current_bucket;           // MOD
  84   u32 extended_limit;
  85   u32 extended_bucket;          // MOD
  86
  87   u64 last_update_time;         // MOD
  88   u32 thread_index;             // Tie policer to a thread, rather than lock
  89   u32 pad32;
  90
  91 } policer_read_response_type_st;
  92
  93 static inline policer_result_e
  94 vnet_police_packet (policer_read_response_type_st * policer,
  95                     u32 packet_length,
  96                     policer_result_e packet_color, u64 time)
  97 {
  98   u64 n_periods;
  99   u64 current_tokens, extended_tokens;
 100   policer_result_e result;
 101
 102   // Scale packet length to support a wide range of speeds
 103   packet_length = packet_length << policer->scale;
 104
 105   // Compute the number of policer periods that have passed since the last
 106   // operation.
 107   n_periods = time - policer->last_update_time;
 108   policer->last_update_time = time;
 109
 110   // Since there is no background last-update-time adjustment, n_periods
 111   // could grow large if the policer is idle for a long time. This could
 112   // cause a 64-bit overflow when computing tokens_per_period * num_periods.
 113   // It will overflow if log2(n_periods) + log2(tokens_per_period) > 64.
 114   //
 115   // To mitigate this, the policer configuration algorithm insures that
 116   // tokens_per_period is less than 2^22, i.e. this is a 22 bit value not
 117   // a 32-bit value. Thus overflow will only occur if n_periods > 64-22 or
 118   // 42. 2^42 min-sized periods is 16us * 2^42, or 2 years. So this can
 119   // rarely occur. If overflow does happen, the only effect will be that
 120   // fewer tokens than the max burst will be added to the bucket for this
 121   // packet. This constraint on tokens_per_period lets the ucode omit
 122   // code to dynamically check for or prevent the overflow.
 123
 124   if (policer->single_rate)
 125     {
 126
 127       // Compute number of tokens for this time period
 128       current_tokens =
 129         policer->current_bucket + n_periods * policer->cir_tokens_per_period;
 130       if (current_tokens > policer->current_limit)
 131         {
 132           current_tokens = policer->current_limit;
 133         }
 134
 135       extended_tokens =
 136         policer->extended_bucket + n_periods * policer->cir_tokens_per_period;
 137       if (extended_tokens > policer->extended_limit)
 138         {
 139           extended_tokens = policer->extended_limit;
 140         }
 141
 142       // Determine color
 143
 144       if ((!policer->color_aware || (packet_color == POLICE_CONFORM))
 145           && (current_tokens >= packet_length))
 146         {
 147           policer->current_bucket = current_tokens - packet_length;
 148           policer->extended_bucket = extended_tokens - packet_length;
 149           result = POLICE_CONFORM;
 150         }
 151       else if ((!policer->color_aware || (packet_color != POLICE_VIOLATE))
 152                && (extended_tokens >= packet_length))
 153         {
 154           policer->current_bucket = current_tokens;
 155           policer->extended_bucket = extended_tokens - packet_length;
 156           result = POLICE_EXCEED;
 157         }
 158       else
 159         {
 160           policer->current_bucket = current_tokens;
 161           policer->extended_bucket = extended_tokens;
 162           result = POLICE_VIOLATE;
 163         }
 164
 165     }
 166   else
 167     {
 168       // Two-rate policer
 169
 170       // Compute number of tokens for this time period
 171       current_tokens =
 172         policer->current_bucket + n_periods * policer->cir_tokens_per_period;
 173       extended_tokens =
 174         policer->extended_bucket + n_periods * policer->pir_tokens_per_period;
 175       if (current_tokens > policer->current_limit)
 176         {
 177           current_tokens = policer->current_limit;
 178         }
 179       if (extended_tokens > policer->extended_limit)
 180         {
 181           extended_tokens = policer->extended_limit;
 182         }
 183
 184       // Determine color
 185
 186       if ((policer->color_aware && (packet_color == POLICE_VIOLATE))
 187           || (extended_tokens < packet_length))
 188         {
 189           policer->current_bucket = current_tokens;
 190           policer->extended_bucket = extended_tokens;
 191           result = POLICE_VIOLATE;
 192         }
 193       else if ((policer->color_aware && (packet_color == POLICE_EXCEED))
 194                || (current_tokens < packet_length))
 195         {
 196           policer->current_bucket = current_tokens;
 197           policer->extended_bucket = extended_tokens - packet_length;
 198           result = POLICE_EXCEED;
 199         }
 200       else
 201         {
 202           policer->current_bucket = current_tokens - packet_length;
 203           policer->extended_bucket = extended_tokens - packet_length;
 204           result = POLICE_CONFORM;
 205         }
 206     }
 207   return result;
 208 }
 209
 210 #endif // __POLICE_H__
 211
 212 /*
 213  * fd.io coding-style-patch-verification: ON
 214  *
 215  * Local Variables:
 216  * eval: (c-set-style "gnu")
 217  * End:
 218  */