src/plugins/dpdk/ipsec/ipsec.h

   1 /*
   2  * Copyright (c) 2017 Intel 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 __DPDK_IPSEC_H__
  16 #define __DPDK_IPSEC_H__
  17
  18 #include <vnet/vnet.h>
  19 #include <vppinfra/cache.h>
  20 #include <vnet/ipsec/ipsec.h>
  21
  22 #undef always_inline
  23 #include <rte_config.h>
  24 #include <rte_crypto.h>
  25 #include <rte_cryptodev.h>
  26
  27 #if CLIB_DEBUG > 0
  28 #define always_inline static inline
  29 #else
  30 #define always_inline static inline __attribute__ ((__always_inline__))
  31 #endif
  32
  33 #define foreach_dpdk_crypto_input_next          \
  34   _(DROP, "error-drop")                         \
  35   _(IP4_LOOKUP, "ip4-lookup")                   \
  36   _(IP6_LOOKUP, "ip6-lookup")                   \
  37   _(INTERFACE_OUTPUT, "interface-output")       \
  38   _(DECRYPT_POST, "dpdk-esp-decrypt-post")
  39
  40 typedef enum
  41 {
  42 #define _(f,s) DPDK_CRYPTO_INPUT_NEXT_##f,
  43   foreach_dpdk_crypto_input_next
  44 #undef _
  45     DPDK_CRYPTO_INPUT_N_NEXT,
  46 } dpdk_crypto_input_next_t;
  47
  48 #define MAX_QP_PER_LCORE 16
  49
  50 typedef struct
  51 {
  52   u32 salt;
  53   u32 iv[2];
  54   u32 cnt;
  55 } dpdk_gcm_cnt_blk;
  56
  57 typedef struct
  58 {
  59   u32 next;
  60   dpdk_gcm_cnt_blk cb __attribute__ ((aligned (16)));
  61   u8 aad[16];
  62   u8 icv[32];
  63 } dpdk_op_priv_t;
  64
  65 typedef struct
  66 {
  67   u16 *resource_idx;
  68   struct rte_crypto_op **ops;
  69   u16 cipher_resource_idx[IPSEC_CRYPTO_N_ALG];
  70   u16 auth_resource_idx[IPSEC_INTEG_N_ALG];
  71     CLIB_CACHE_LINE_ALIGN_MARK (pad);
  72 } crypto_worker_main_t __attribute__ ((aligned (CLIB_CACHE_LINE_BYTES)));
  73
  74 typedef struct
  75 {
  76   char *name;
  77   enum rte_crypto_sym_xform_type type;
  78   u32 alg;
  79   u8 key_len;
  80   u8 iv_len;
  81   u8 trunc_size;
  82   u8 boundary;
  83   u8 disabled;
  84   u8 resources;
  85 } crypto_alg_t __attribute__ ((aligned (8)));
  86
  87 typedef struct
  88 {
  89   u16 *free_resources;
  90   u16 *used_resources;
  91   u8 cipher_support[IPSEC_CRYPTO_N_ALG];
  92   u8 auth_support[IPSEC_INTEG_N_ALG];
  93   u8 drv_id;
  94   u8 numa;
  95   u16 id;
  96   const i8 *name;
  97   u32 max_qp;
  98   u64 features;
  99 } crypto_dev_t;
 100
 101 typedef struct
 102 {
 103   const i8 *name;
 104   u16 *devs;
 105 } crypto_drv_t;
 106
 107 typedef struct
 108 {
 109   u16 thread_idx;
 110   u8 remove;
 111   u8 drv_id;
 112   u8 dev_id;
 113   u8 numa;
 114   u16 qp_id;
 115   u16 inflights[2];
 116   u16 n_ops;
 117   u16 __unused;
 118   struct rte_crypto_op *ops[VLIB_FRAME_SIZE];
 119   u32 bi[VLIB_FRAME_SIZE];
 120 } crypto_resource_t __attribute__ ((aligned (CLIB_CACHE_LINE_BYTES)));
 121
 122 typedef struct
 123 {
 124   u64 ts;
 125   struct rte_cryptodev_sym_session *session;
 126 } crypto_session_disposal_t;
 127
 128 typedef struct
 129 {
 130   struct rte_mempool *crypto_op;
 131   struct rte_mempool *session_h;
 132   struct rte_mempool **session_drv;
 133   crypto_session_disposal_t *session_disposal;
 134   uword *session_by_sa_index;
 135   uword *session_by_drv_id_and_sa_index;
 136   u64 crypto_op_get_failed;
 137   u64 session_h_failed;
 138   u64 *session_drv_failed;
 139   clib_spinlock_t lockp;
 140 } crypto_data_t;
 141
 142 typedef struct
 143 {
 144   crypto_worker_main_t *workers_main;
 145   struct rte_cryptodev_sym_session **sa_session;
 146   crypto_dev_t *dev;
 147   crypto_resource_t *resource;
 148   crypto_alg_t *cipher_algs;
 149   crypto_alg_t *auth_algs;
 150   crypto_data_t *data;
 151   crypto_drv_t *drv;
 152   u64 session_timeout;          /* nsec */
 153   u8 enabled;
 154 } dpdk_crypto_main_t;
 155
 156 extern dpdk_crypto_main_t dpdk_crypto_main;
 157
 158 static const u8 pad_data[] =
 159   { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 0 };
 160
 161 void crypto_auto_placement (void);
 162
 163 clib_error_t *create_sym_session (struct rte_cryptodev_sym_session **session,
 164                                   u32 sa_idx, crypto_resource_t * res,
 165                                   crypto_worker_main_t * cwm, u8 is_outbound);
 166
 167 static_always_inline u32
 168 crypto_op_len (void)
 169 {
 170   const u32 align = 4;
 171   u32 op_size =
 172     sizeof (struct rte_crypto_op) + sizeof (struct rte_crypto_sym_op);
 173
 174   return ((op_size + align - 1) & ~(align - 1)) + sizeof (dpdk_op_priv_t);
 175 }
 176
 177 static_always_inline u32
 178 crypto_op_get_priv_offset (void)
 179 {
 180   const u32 align = 16;
 181   u32 offset;
 182
 183   offset = sizeof (struct rte_crypto_op) + sizeof (struct rte_crypto_sym_op);
 184   offset = (offset + align - 1) & ~(align - 1);
 185
 186   return offset;
 187 }
 188
 189 static_always_inline dpdk_op_priv_t *
 190 crypto_op_get_priv (struct rte_crypto_op * op)
 191 {
 192   return (dpdk_op_priv_t *) (((u8 *) op) + crypto_op_get_priv_offset ());
 193 }
 194
 195 /* XXX this requires 64 bit builds so hash_xxx macros use u64 key */
 196 typedef union
 197 {
 198   u64 val;
 199   struct
 200   {
 201     u32 drv_id;
 202     u32 sa_idx;
 203   };
 204 } crypto_session_key_t;
 205
 206 static_always_inline clib_error_t *
 207 crypto_get_session (struct rte_cryptodev_sym_session **session,
 208                     u32 sa_idx,
 209                     crypto_resource_t * res,
 210                     crypto_worker_main_t * cwm, u8 is_outbound)
 211 {
 212   dpdk_crypto_main_t *dcm = &dpdk_crypto_main;
 213   crypto_data_t *data;
 214   uword *val;
 215   crypto_session_key_t key = { 0 };
 216
 217   key.drv_id = res->drv_id;
 218   key.sa_idx = sa_idx;
 219
 220   data = vec_elt_at_index (dcm->data, res->numa);
 221   val = hash_get (data->session_by_drv_id_and_sa_index, key.val);
 222
 223   if (PREDICT_FALSE (!val))
 224     return create_sym_session (session, sa_idx, res, cwm, is_outbound);
 225
 226   session[0] = (struct rte_cryptodev_sym_session *) val[0];
 227
 228   return NULL;
 229 }
 230
 231 static_always_inline u16
 232 get_resource (crypto_worker_main_t * cwm, ipsec_sa_t * sa)
 233 {
 234   u16 cipher_res = cwm->cipher_resource_idx[sa->crypto_alg];
 235   u16 auth_res = cwm->auth_resource_idx[sa->integ_alg];
 236   u8 is_aead;
 237
 238   /* Not allowed to setup SA with no-aead-cipher/NULL or NULL/NULL */
 239
 240   is_aead = ((sa->crypto_alg == IPSEC_CRYPTO_ALG_AES_GCM_128) |
 241              (sa->crypto_alg == IPSEC_CRYPTO_ALG_AES_GCM_192) |
 242              (sa->crypto_alg == IPSEC_CRYPTO_ALG_AES_GCM_256));
 243
 244   if (sa->crypto_alg == IPSEC_CRYPTO_ALG_NONE)
 245     return auth_res;
 246
 247   if (cipher_res == auth_res)
 248     return cipher_res;
 249
 250   if (is_aead)
 251     return cipher_res;
 252
 253   return (u16) ~ 0;
 254 }
 255
 256 static_always_inline i32
 257 crypto_alloc_ops (u8 numa, struct rte_crypto_op ** ops, u32 n)
 258 {
 259   dpdk_crypto_main_t *dcm = &dpdk_crypto_main;
 260   crypto_data_t *data = vec_elt_at_index (dcm->data, numa);
 261   i32 ret;
 262
 263   ret = rte_mempool_get_bulk (data->crypto_op, (void **) ops, n);
 264
 265   /* *INDENT-OFF* */
 266   data->crypto_op_get_failed += ! !ret;
 267   /* *INDENT-ON* */
 268
 269   return ret;
 270 }
 271
 272 static_always_inline void
 273 crypto_free_ops (u8 numa, struct rte_crypto_op **ops, u32 n)
 274 {
 275   dpdk_crypto_main_t *dcm = &dpdk_crypto_main;
 276   crypto_data_t *data = vec_elt_at_index (dcm->data, numa);
 277
 278   if (!n)
 279     return;
 280
 281   rte_mempool_put_bulk (data->crypto_op, (void **) ops, n);
 282 }
 283
 284 static_always_inline void
 285 crypto_enqueue_ops (vlib_main_t * vm, crypto_worker_main_t * cwm, u8 outbound,
 286                     u32 node_index, u32 error, u8 numa)
 287 {
 288   dpdk_crypto_main_t *dcm = &dpdk_crypto_main;
 289   crypto_resource_t *res;
 290   u16 *res_idx;
 291
 292   /* *INDENT-OFF* */
 293   vec_foreach (res_idx, cwm->resource_idx)
 294     {
 295       u16 enq;
 296       res = vec_elt_at_index (dcm->resource, res_idx[0]);
 297
 298       if (!res->n_ops)
 299         continue;
 300
 301       enq = rte_cryptodev_enqueue_burst (res->dev_id, res->qp_id + outbound,
 302                                          res->ops, res->n_ops);
 303       res->inflights[outbound] += enq;
 304
 305       if (PREDICT_FALSE (enq < res->n_ops))
 306         {
 307           crypto_free_ops (numa, &res->ops[enq], res->n_ops - enq);
 308           vlib_buffer_free (vm, &res->bi[enq], res->n_ops - enq);
 309
 310           vlib_node_increment_counter (vm, node_index, error,
 311                                        res->n_ops - enq);
 312         }
 313       res->n_ops = 0;
 314     }
 315   /* *INDENT-ON* */
 316 }
 317
 318 static_always_inline void
 319 crypto_set_icb (dpdk_gcm_cnt_blk * icb, u32 salt, u32 seq, u32 seq_hi)
 320 {
 321   icb->salt = salt;
 322   icb->iv[0] = seq;
 323   icb->iv[1] = seq_hi;
 324 }
 325
 326 static_always_inline void
 327 crypto_op_setup (u8 is_aead, struct rte_mbuf *mb0,
 328                  struct rte_crypto_op *op, void *session,
 329                  u32 cipher_off, u32 cipher_len,
 330                  u32 auth_off, u32 auth_len,
 331                  u8 * aad, u8 * digest, u64 digest_paddr)
 332 {
 333   struct rte_crypto_sym_op *sym_op;
 334
 335   sym_op = (struct rte_crypto_sym_op *) (op + 1);
 336
 337   sym_op->m_src = mb0;
 338   sym_op->session = session;
 339
 340   if (is_aead)
 341     {
 342       sym_op->aead.data.offset = cipher_off;
 343       sym_op->aead.data.length = cipher_len;
 344
 345       sym_op->aead.aad.data = aad;
 346       sym_op->aead.aad.phys_addr =
 347         op->phys_addr + (uintptr_t) aad - (uintptr_t) op;
 348
 349       sym_op->aead.digest.data = digest;
 350       sym_op->aead.digest.phys_addr = digest_paddr;
 351     }
 352   else
 353     {
 354       sym_op->cipher.data.offset = cipher_off;
 355       sym_op->cipher.data.length = cipher_len;
 356
 357       sym_op->auth.data.offset = auth_off;
 358       sym_op->auth.data.length = auth_len;
 359
 360       sym_op->auth.digest.data = digest;
 361       sym_op->auth.digest.phys_addr = digest_paddr;
 362     }
 363 }
 364
 365 #endif /* __DPDK_IPSEC_H__ */
 366
 367 /*
 368  * fd.io coding-style-patch-verification: ON
 369  *
 370  * Local Variables:
 371  * eval: (c-set-style "gnu")
 372  * End:
 373  */