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