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