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 char *name;
  97   u32 max_qp;
  98   u64 features;
  99 } crypto_dev_t;
 100
 101 typedef struct
 102 {
 103   const char *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_cryptodev_sym_session *session;
 131   u64 dev_mask;
 132 } crypto_session_by_drv_t;
 133
 134 typedef struct
 135 {
 136   /* Required for vec_validate_aligned */
 137   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 138   struct rte_mempool *crypto_op;
 139   struct rte_mempool *session_h;
 140   struct rte_mempool **session_drv;
 141   crypto_session_disposal_t *session_disposal;
 142   uword *session_by_sa_index;
 143   u64 crypto_op_get_failed;
 144   u64 session_h_failed;
 145   u64 *session_drv_failed;
 146   crypto_session_by_drv_t *session_by_drv_id_and_sa_index;
 147   clib_spinlock_t lockp;
 148 } crypto_data_t;
 149
 150 typedef struct
 151 {
 152   crypto_worker_main_t *workers_main;
 153   crypto_dev_t *dev;
 154   crypto_resource_t *resource;
 155   crypto_alg_t *cipher_algs;
 156   crypto_alg_t *auth_algs;
 157   crypto_data_t *data;
 158   crypto_drv_t *drv;
 159   u64 session_timeout;          /* nsec */
 160   u8 enabled;
 161 } dpdk_crypto_main_t;
 162
 163 extern dpdk_crypto_main_t dpdk_crypto_main;
 164
 165 static const u8 pad_data[] =
 166   { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 0 };
 167
 168 void crypto_auto_placement (void);
 169
 170 clib_error_t *create_sym_session (struct rte_cryptodev_sym_session **session,
 171                                   u32 sa_idx, crypto_resource_t * res,
 172                                   crypto_worker_main_t * cwm, u8 is_outbound);
 173
 174 static_always_inline u32
 175 crypto_op_len (void)
 176 {
 177   const u32 align = 4;
 178   u32 op_size =
 179     sizeof (struct rte_crypto_op) + sizeof (struct rte_crypto_sym_op);
 180
 181   return ((op_size + align - 1) & ~(align - 1)) + sizeof (dpdk_op_priv_t);
 182 }
 183
 184 static_always_inline u32
 185 crypto_op_get_priv_offset (void)
 186 {
 187   const u32 align = 16;
 188   u32 offset;
 189
 190   offset = sizeof (struct rte_crypto_op) + sizeof (struct rte_crypto_sym_op);
 191   offset = (offset + align - 1) & ~(align - 1);
 192
 193   return offset;
 194 }
 195
 196 static_always_inline dpdk_op_priv_t *
 197 crypto_op_get_priv (struct rte_crypto_op * op)
 198 {
 199   return (dpdk_op_priv_t *) (((u8 *) op) + crypto_op_get_priv_offset ());
 200 }
 201
 202
 203 static_always_inline void
 204 add_session_by_drv_and_sa_idx (struct rte_cryptodev_sym_session *session,
 205                                crypto_data_t * data, u32 drv_id, u32 sa_idx)
 206 {
 207   crypto_session_by_drv_t *sbd;
 208   vec_validate_aligned (data->session_by_drv_id_and_sa_index, sa_idx,
 209                         CLIB_CACHE_LINE_BYTES);
 210   sbd = vec_elt_at_index (data->session_by_drv_id_and_sa_index, sa_idx);
 211   sbd->dev_mask |= 1L << drv_id;
 212   sbd->session = session;
 213 }
 214
 215 static_always_inline struct rte_cryptodev_sym_session *
 216 get_session_by_drv_and_sa_idx (crypto_data_t * data, u32 drv_id, u32 sa_idx)
 217 {
 218   crypto_session_by_drv_t *sess_by_sa;
 219   if (_vec_len (data->session_by_drv_id_and_sa_index) <= sa_idx)
 220     return NULL;
 221   sess_by_sa =
 222     vec_elt_at_index (data->session_by_drv_id_and_sa_index, sa_idx);
 223   return (sess_by_sa->dev_mask & (1L << drv_id)) ? sess_by_sa->session : NULL;
 224 }
 225
 226 static_always_inline clib_error_t *
 227 crypto_get_session (struct rte_cryptodev_sym_session ** session,
 228                     u32 sa_idx,
 229                     crypto_resource_t * res,
 230                     crypto_worker_main_t * cwm, u8 is_outbound)
 231 {
 232   dpdk_crypto_main_t *dcm = &dpdk_crypto_main;
 233   crypto_data_t *data;
 234   struct rte_cryptodev_sym_session *sess;
 235
 236   data = vec_elt_at_index (dcm->data, res->numa);
 237   sess = get_session_by_drv_and_sa_idx (data, res->drv_id, sa_idx);
 238
 239   if (PREDICT_FALSE (!sess))
 240     return create_sym_session (session, sa_idx, res, cwm, is_outbound);
 241
 242   session[0] = sess;
 243
 244   return NULL;
 245 }
 246
 247 static_always_inline u16
 248 get_resource (crypto_worker_main_t * cwm, ipsec_sa_t * sa)
 249 {
 250   u16 cipher_res = cwm->cipher_resource_idx[sa->crypto_alg];
 251   u16 auth_res = cwm->auth_resource_idx[sa->integ_alg];
 252   u8 is_aead;
 253
 254   /* Not allowed to setup SA with no-aead-cipher/NULL or NULL/NULL */
 255
 256   is_aead = ((sa->crypto_alg == IPSEC_CRYPTO_ALG_AES_GCM_128) ||
 257              (sa->crypto_alg == IPSEC_CRYPTO_ALG_AES_GCM_192) ||
 258              (sa->crypto_alg == IPSEC_CRYPTO_ALG_AES_GCM_256));
 259
 260   if (sa->crypto_alg == IPSEC_CRYPTO_ALG_NONE)
 261     return auth_res;
 262
 263   if (cipher_res == auth_res)
 264     return cipher_res;
 265
 266   if (is_aead)
 267     return cipher_res;
 268
 269   return (u16) ~ 0;
 270 }
 271
 272 static_always_inline i32
 273 crypto_alloc_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   i32 ret;
 278
 279   ret = rte_mempool_get_bulk (data->crypto_op, (void **) ops, n);
 280
 281   /* *INDENT-OFF* */
 282   data->crypto_op_get_failed += ! !ret;
 283   /* *INDENT-ON* */
 284
 285   return ret;
 286 }
 287
 288 static_always_inline void
 289 crypto_free_ops (u8 numa, struct rte_crypto_op **ops, u32 n)
 290 {
 291   dpdk_crypto_main_t *dcm = &dpdk_crypto_main;
 292   crypto_data_t *data = vec_elt_at_index (dcm->data, numa);
 293
 294   if (!n)
 295     return;
 296
 297   rte_mempool_put_bulk (data->crypto_op, (void **) ops, n);
 298 }
 299
 300 static_always_inline void
 301 crypto_enqueue_ops (vlib_main_t * vm, crypto_worker_main_t * cwm, u8 outbound,
 302                     u32 node_index, u32 error, u8 numa)
 303 {
 304   dpdk_crypto_main_t *dcm = &dpdk_crypto_main;
 305   crypto_resource_t *res;
 306   u16 *res_idx;
 307
 308   /* *INDENT-OFF* */
 309   vec_foreach (res_idx, cwm->resource_idx)
 310     {
 311       u16 enq;
 312       res = vec_elt_at_index (dcm->resource, res_idx[0]);
 313
 314       if (!res->n_ops)
 315         continue;
 316
 317       enq = rte_cryptodev_enqueue_burst (res->dev_id, res->qp_id + outbound,
 318                                          res->ops, res->n_ops);
 319       res->inflights[outbound] += enq;
 320
 321       if (PREDICT_FALSE (enq < res->n_ops))
 322         {
 323           crypto_free_ops (numa, &res->ops[enq], res->n_ops - enq);
 324           vlib_buffer_free (vm, &res->bi[enq], res->n_ops - enq);
 325
 326           vlib_node_increment_counter (vm, node_index, error,
 327                                        res->n_ops - enq);
 328         }
 329       res->n_ops = 0;
 330     }
 331   /* *INDENT-ON* */
 332 }
 333
 334 static_always_inline void
 335 crypto_set_icb (dpdk_gcm_cnt_blk * icb, u32 salt, u32 seq, u32 seq_hi)
 336 {
 337   icb->salt = salt;
 338   icb->iv[0] = seq;
 339   icb->iv[1] = seq_hi;
 340 }
 341
 342 static_always_inline void
 343 crypto_op_setup (u8 is_aead, struct rte_mbuf *mb0,
 344                  struct rte_crypto_op *op, void *session,
 345                  u32 cipher_off, u32 cipher_len,
 346                  u32 auth_off, u32 auth_len,
 347                  u8 * aad, u8 * digest, u64 digest_paddr)
 348 {
 349   struct rte_crypto_sym_op *sym_op;
 350
 351   sym_op = (struct rte_crypto_sym_op *) (op + 1);
 352
 353   sym_op->m_src = mb0;
 354   sym_op->session = session;
 355
 356   if (is_aead)
 357     {
 358       sym_op->aead.data.offset = cipher_off;
 359       sym_op->aead.data.length = cipher_len;
 360
 361       sym_op->aead.aad.data = aad;
 362       sym_op->aead.aad.phys_addr =
 363         op->phys_addr + (uintptr_t) aad - (uintptr_t) op;
 364
 365       sym_op->aead.digest.data = digest;
 366       sym_op->aead.digest.phys_addr = digest_paddr;
 367     }
 368   else
 369     {
 370       sym_op->cipher.data.offset = cipher_off;
 371       sym_op->cipher.data.length = cipher_len;
 372
 373       sym_op->auth.data.offset = auth_off;
 374       sym_op->auth.data.length = auth_len;
 375
 376       sym_op->auth.digest.data = digest;
 377       sym_op->auth.digest.phys_addr = digest_paddr;
 378     }
 379 }
 380
 381 #endif /* __DPDK_IPSEC_H__ */
 382
 383 /*
 384  * fd.io coding-style-patch-verification: ON
 385  *
 386  * Local Variables:
 387  * eval: (c-set-style "gnu")
 388  * End:
 389  */