xref: /freebsd/sys/dev/mlx5/mlx5_en/mlx5_en_hw_tls.c (revision e17f5b1d)
1 /*-
2  * Copyright (c) 2019 Mellanox Technologies. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS `AS IS' AND
14  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16  * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
17  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23  * SUCH DAMAGE.
24  *
25  * $FreeBSD$
26  */
27 
28 #include "opt_kern_tls.h"
29 
30 #include "en.h"
31 
32 #include <dev/mlx5/tls.h>
33 
34 #include <linux/delay.h>
35 #include <sys/ktls.h>
36 #include <opencrypto/cryptodev.h>
37 
38 #ifdef KERN_TLS
39 
40 MALLOC_DEFINE(M_MLX5E_TLS, "MLX5E_TLS", "MLX5 ethernet HW TLS");
41 
42 /* software TLS context */
43 struct mlx5_ifc_sw_tls_cntx_bits {
44 	struct mlx5_ifc_tls_static_params_bits param;
45 	struct mlx5_ifc_tls_progress_params_bits progress;
46 	struct {
47 		uint8_t key_data[8][0x20];
48 		uint8_t key_len[0x20];
49 	} key;
50 };
51 
52 CTASSERT(MLX5_ST_SZ_BYTES(sw_tls_cntx) <= sizeof(((struct mlx5e_tls_tag *)0)->crypto_params));
53 CTASSERT(MLX5_ST_SZ_BYTES(mkc) == sizeof(((struct mlx5e_tx_umr_wqe *)0)->mkc));
54 
55 static const char *mlx5e_tls_stats_desc[] = {
56 	MLX5E_TLS_STATS(MLX5E_STATS_DESC)
57 };
58 
59 static void mlx5e_tls_work(struct work_struct *);
60 
61 static int
62 mlx5e_tls_tag_zinit(void *mem, int size, int flags)
63 {
64 	struct mlx5e_tls_tag *ptag = mem;
65 
66 	MPASS(size == sizeof(*ptag));
67 
68 	memset(ptag, 0, sizeof(*ptag));
69 	mtx_init(&ptag->mtx, "mlx5-tls-tag-mtx", NULL, MTX_DEF);
70 	INIT_WORK(&ptag->work, mlx5e_tls_work);
71 
72 	return (0);
73 }
74 
75 static void
76 mlx5e_tls_tag_zfini(void *mem, int size)
77 {
78 	struct mlx5e_tls_tag *ptag = mem;
79 	struct mlx5e_priv *priv;
80 	struct mlx5e_tls *ptls;
81 
82 	ptls = ptag->tls;
83 	priv = container_of(ptls, struct mlx5e_priv, tls);
84 
85 	flush_work(&ptag->work);
86 
87 	if (ptag->tisn != 0) {
88 		mlx5_tls_close_tis(priv->mdev, ptag->tisn);
89 		atomic_add_32(&ptls->num_resources, -1U);
90 	}
91 
92 	mtx_destroy(&ptag->mtx);
93 }
94 
95 static void
96 mlx5e_tls_tag_zfree(struct mlx5e_tls_tag *ptag)
97 {
98 
99 	/* reset some variables */
100 	ptag->state = MLX5E_TLS_ST_INIT;
101 	ptag->dek_index = 0;
102 	ptag->dek_index_ok = 0;
103 
104 	/* avoid leaking keys */
105 	memset(ptag->crypto_params, 0, sizeof(ptag->crypto_params));
106 
107 	/* update number of TIS contexts */
108 	if (ptag->tisn == 0)
109 		atomic_add_32(&ptag->tls->num_resources, -1U);
110 
111 	/* return tag to UMA */
112 	uma_zfree(ptag->tls->zone, ptag);
113 }
114 
115 int
116 mlx5e_tls_init(struct mlx5e_priv *priv)
117 {
118 	struct mlx5e_tls *ptls = &priv->tls;
119 	struct sysctl_oid *node;
120 	uint32_t x;
121 
122 	if (MLX5_CAP_GEN(priv->mdev, tls_tx) == 0)
123 		return (0);
124 
125 	ptls->wq = create_singlethread_workqueue("mlx5-tls-wq");
126 	if (ptls->wq == NULL)
127 		return (ENOMEM);
128 
129 	sysctl_ctx_init(&ptls->ctx);
130 
131 	snprintf(ptls->zname, sizeof(ptls->zname),
132 	    "mlx5_%u_tls", device_get_unit(priv->mdev->pdev->dev.bsddev));
133 
134 	ptls->zone = uma_zcreate(ptls->zname, sizeof(struct mlx5e_tls_tag),
135 	    NULL, NULL, mlx5e_tls_tag_zinit, mlx5e_tls_tag_zfini, UMA_ALIGN_CACHE, 0);
136 
137 	ptls->max_resources = 1U << MLX5_CAP_GEN(priv->mdev, log_max_dek);
138 
139 	for (x = 0; x != MLX5E_TLS_STATS_NUM; x++)
140 		ptls->stats.arg[x] = counter_u64_alloc(M_WAITOK);
141 
142 	ptls->init = 1;
143 
144 	node = SYSCTL_ADD_NODE(&priv->sysctl_ctx,
145 	    SYSCTL_CHILDREN(priv->sysctl_ifnet), OID_AUTO,
146 	    "tls", CTLFLAG_RW | CTLFLAG_MPSAFE, NULL, "Hardware TLS offload");
147 	if (node == NULL)
148 		return (0);
149 
150 	mlx5e_create_counter_stats(&ptls->ctx,
151 	    SYSCTL_CHILDREN(node), "stats",
152 	    mlx5e_tls_stats_desc, MLX5E_TLS_STATS_NUM,
153 	    ptls->stats.arg);
154 
155 	return (0);
156 }
157 
158 void
159 mlx5e_tls_cleanup(struct mlx5e_priv *priv)
160 {
161 	struct mlx5e_tls *ptls = &priv->tls;
162 	uint32_t x;
163 
164 	if (MLX5_CAP_GEN(priv->mdev, tls_tx) == 0)
165 		return;
166 
167 	ptls->init = 0;
168 	flush_workqueue(ptls->wq);
169 	sysctl_ctx_free(&ptls->ctx);
170 	uma_zdestroy(ptls->zone);
171 	destroy_workqueue(ptls->wq);
172 
173 	/* check if all resources are freed */
174 	MPASS(priv->tls.num_resources == 0);
175 
176 	for (x = 0; x != MLX5E_TLS_STATS_NUM; x++)
177 		counter_u64_free(ptls->stats.arg[x]);
178 }
179 
180 static void
181 mlx5e_tls_work(struct work_struct *work)
182 {
183 	struct mlx5e_tls_tag *ptag;
184 	struct mlx5e_priv *priv;
185 	int err;
186 
187 	ptag = container_of(work, struct mlx5e_tls_tag, work);
188 	priv = container_of(ptag->tls, struct mlx5e_priv, tls);
189 
190 	switch (ptag->state) {
191 	case MLX5E_TLS_ST_SETUP:
192 		/* try to open TIS, if not present */
193 		if (ptag->tisn == 0) {
194 			err = mlx5_tls_open_tis(priv->mdev, 0, priv->tdn,
195 			    priv->pdn, &ptag->tisn);
196 			if (err) {
197 				MLX5E_TLS_STAT_INC(ptag, tx_error, 1);
198 				break;
199 			}
200 		}
201 		MLX5_SET(sw_tls_cntx, ptag->crypto_params, progress.pd, ptag->tisn);
202 
203 		/* try to allocate a DEK context ID */
204 		err = mlx5_encryption_key_create(priv->mdev, priv->pdn,
205 		    MLX5_ADDR_OF(sw_tls_cntx, ptag->crypto_params, key.key_data),
206 		    MLX5_GET(sw_tls_cntx, ptag->crypto_params, key.key_len),
207 		    &ptag->dek_index);
208 		if (err) {
209 			MLX5E_TLS_STAT_INC(ptag, tx_error, 1);
210 			break;
211 		}
212 
213 		MLX5_SET(sw_tls_cntx, ptag->crypto_params, param.dek_index, ptag->dek_index);
214 
215 		ptag->dek_index_ok = 1;
216 
217 		MLX5E_TLS_TAG_LOCK(ptag);
218 		if (ptag->state == MLX5E_TLS_ST_SETUP)
219 			ptag->state = MLX5E_TLS_ST_TXRDY;
220 		MLX5E_TLS_TAG_UNLOCK(ptag);
221 		break;
222 
223 	case MLX5E_TLS_ST_FREED:
224 		/* wait for all refs to go away */
225 		while (ptag->refs != 0)
226 			msleep(1);
227 
228 		/* try to destroy DEK context by ID */
229 		if (ptag->dek_index_ok)
230 			err = mlx5_encryption_key_destroy(priv->mdev, ptag->dek_index);
231 
232 		/* free tag */
233 		mlx5e_tls_tag_zfree(ptag);
234 		break;
235 
236 	default:
237 		break;
238 	}
239 }
240 
241 static int
242 mlx5e_tls_set_params(void *ctx, const struct tls_session_params *en)
243 {
244 
245 	MLX5_SET(sw_tls_cntx, ctx, param.const_2, 2);
246 	if (en->tls_vminor == TLS_MINOR_VER_TWO)
247 		MLX5_SET(sw_tls_cntx, ctx, param.tls_version, 2); /* v1.2 */
248 	else
249 		MLX5_SET(sw_tls_cntx, ctx, param.tls_version, 3); /* v1.3 */
250 	MLX5_SET(sw_tls_cntx, ctx, param.const_1, 1);
251 	MLX5_SET(sw_tls_cntx, ctx, param.encryption_standard, 1); /* TLS */
252 
253 	/* copy the initial vector in place */
254 	switch (en->iv_len) {
255 	case MLX5_FLD_SZ_BYTES(sw_tls_cntx, param.gcm_iv):
256 	case MLX5_FLD_SZ_BYTES(sw_tls_cntx, param.gcm_iv) +
257 	     MLX5_FLD_SZ_BYTES(sw_tls_cntx, param.implicit_iv):
258 		memcpy(MLX5_ADDR_OF(sw_tls_cntx, ctx, param.gcm_iv),
259 		    en->iv, en->iv_len);
260 		break;
261 	default:
262 		return (EINVAL);
263 	}
264 
265 	if (en->cipher_key_len <= MLX5_FLD_SZ_BYTES(sw_tls_cntx, key.key_data)) {
266 		memcpy(MLX5_ADDR_OF(sw_tls_cntx, ctx, key.key_data),
267 		    en->cipher_key, en->cipher_key_len);
268 		MLX5_SET(sw_tls_cntx, ctx, key.key_len, en->cipher_key_len);
269 	} else {
270 		return (EINVAL);
271 	}
272 	return (0);
273 }
274 
275 /* Verify zero default */
276 CTASSERT(MLX5E_TLS_ST_INIT == 0);
277 
278 int
279 mlx5e_tls_snd_tag_alloc(struct ifnet *ifp,
280     union if_snd_tag_alloc_params *params,
281     struct m_snd_tag **ppmt)
282 {
283 	struct if_snd_tag_alloc_rate_limit rl_params;
284 	struct mlx5e_priv *priv;
285 	struct mlx5e_tls_tag *ptag;
286 	const struct tls_session_params *en;
287 	int error;
288 
289 	priv = ifp->if_softc;
290 
291 	if (priv->tls.init == 0)
292 		return (EOPNOTSUPP);
293 
294 	/* allocate new tag from zone, if any */
295 	ptag = uma_zalloc(priv->tls.zone, M_NOWAIT);
296 	if (ptag == NULL)
297 		return (ENOMEM);
298 
299 	/* sanity check default values */
300 	MPASS(ptag->state == MLX5E_TLS_ST_INIT);
301 	MPASS(ptag->dek_index == 0);
302 	MPASS(ptag->dek_index_ok == 0);
303 
304 	/* setup TLS tag */
305 	ptag->tls = &priv->tls;
306 	ptag->tag.type = params->hdr.type;
307 
308 	/* check if there is no TIS context */
309 	if (ptag->tisn == 0) {
310 		uint32_t value;
311 
312 		value = atomic_fetchadd_32(&priv->tls.num_resources, 1U);
313 
314 		/* check resource limits */
315 		if (value >= priv->tls.max_resources) {
316 			error = ENOMEM;
317 			goto failure;
318 		}
319 	}
320 
321 	en = &params->tls.tls->params;
322 
323 	/* only TLS v1.2 and v1.3 is currently supported */
324 	if (en->tls_vmajor != TLS_MAJOR_VER_ONE ||
325 	    (en->tls_vminor != TLS_MINOR_VER_TWO
326 #ifdef TLS_MINOR_VER_THREE
327 	     && en->tls_vminor != TLS_MINOR_VER_THREE
328 #endif
329 	     )) {
330 		error = EPROTONOSUPPORT;
331 		goto failure;
332 	}
333 
334 	switch (en->cipher_algorithm) {
335 	case CRYPTO_AES_NIST_GCM_16:
336 		switch (en->cipher_key_len) {
337 		case 128 / 8:
338 			if (en->tls_vminor == TLS_MINOR_VER_TWO) {
339 				if (MLX5_CAP_TLS(priv->mdev, tls_1_2_aes_gcm_128) == 0) {
340 					error = EPROTONOSUPPORT;
341 					goto failure;
342 				}
343 			} else {
344 				if (MLX5_CAP_TLS(priv->mdev, tls_1_3_aes_gcm_128) == 0) {
345 					error = EPROTONOSUPPORT;
346 					goto failure;
347 				}
348 			}
349 			error = mlx5e_tls_set_params(ptag->crypto_params, en);
350 			if (error)
351 				goto failure;
352 			break;
353 
354 		case 256 / 8:
355 			if (en->tls_vminor == TLS_MINOR_VER_TWO) {
356 				if (MLX5_CAP_TLS(priv->mdev, tls_1_2_aes_gcm_256) == 0) {
357 					error = EPROTONOSUPPORT;
358 					goto failure;
359 				}
360 			} else {
361 				if (MLX5_CAP_TLS(priv->mdev, tls_1_3_aes_gcm_256) == 0) {
362 					error = EPROTONOSUPPORT;
363 					goto failure;
364 				}
365 			}
366 			error = mlx5e_tls_set_params(ptag->crypto_params, en);
367 			if (error)
368 				goto failure;
369 			break;
370 
371 		default:
372 			error = EINVAL;
373 			goto failure;
374 		}
375 		break;
376 	default:
377 		error = EPROTONOSUPPORT;
378 		goto failure;
379 	}
380 
381 	switch (ptag->tag.type) {
382 #if defined(RATELIMIT) && defined(IF_SND_TAG_TYPE_TLS_RATE_LIMIT)
383 	case IF_SND_TAG_TYPE_TLS_RATE_LIMIT:
384 		memset(&rl_params, 0, sizeof(rl_params));
385 		rl_params.hdr = params->tls_rate_limit.hdr;
386 		rl_params.hdr.type = IF_SND_TAG_TYPE_RATE_LIMIT;
387 		rl_params.max_rate = params->tls_rate_limit.max_rate;
388 
389 		error = mlx5e_rl_snd_tag_alloc(ifp,
390 		    container_of(&rl_params, union if_snd_tag_alloc_params, rate_limit),
391 		    &ptag->rl_tag);
392 		if (error)
393 			goto failure;
394 		break;
395 #endif
396 	case IF_SND_TAG_TYPE_TLS:
397 		memset(&rl_params, 0, sizeof(rl_params));
398 		rl_params.hdr = params->tls.hdr;
399 		rl_params.hdr.type = IF_SND_TAG_TYPE_UNLIMITED;
400 
401 		error = mlx5e_ul_snd_tag_alloc(ifp,
402 		    container_of(&rl_params, union if_snd_tag_alloc_params, unlimited),
403 		    &ptag->rl_tag);
404 		if (error)
405 			goto failure;
406 		break;
407 	default:
408 		error = EOPNOTSUPP;
409 		goto failure;
410 	}
411 
412 	/* store pointer to mbuf tag */
413 	MPASS(ptag->tag.m_snd_tag.refcount == 0);
414 	m_snd_tag_init(&ptag->tag.m_snd_tag, ifp);
415 	*ppmt = &ptag->tag.m_snd_tag;
416 	return (0);
417 
418 failure:
419 	mlx5e_tls_tag_zfree(ptag);
420 	return (error);
421 }
422 
423 int
424 mlx5e_tls_snd_tag_modify(struct m_snd_tag *pmt, union if_snd_tag_modify_params *params)
425 {
426 #if defined(RATELIMIT) && defined(IF_SND_TAG_TYPE_TLS_RATE_LIMIT)
427 	struct if_snd_tag_rate_limit_params rl_params;
428 	int error;
429 #endif
430 	struct mlx5e_tls_tag *ptag =
431 	    container_of(pmt, struct mlx5e_tls_tag, tag.m_snd_tag);
432 
433 	switch (ptag->tag.type) {
434 #if defined(RATELIMIT) && defined(IF_SND_TAG_TYPE_TLS_RATE_LIMIT)
435 	case IF_SND_TAG_TYPE_TLS_RATE_LIMIT:
436 		memset(&rl_params, 0, sizeof(rl_params));
437 		rl_params.max_rate = params->tls_rate_limit.max_rate;
438 		error = mlx5e_rl_snd_tag_modify(ptag->rl_tag,
439 		    container_of(&rl_params, union if_snd_tag_modify_params, rate_limit));
440 		return (error);
441 #endif
442 	default:
443 		return (EOPNOTSUPP);
444 	}
445 }
446 
447 int
448 mlx5e_tls_snd_tag_query(struct m_snd_tag *pmt, union if_snd_tag_query_params *params)
449 {
450 	struct mlx5e_tls_tag *ptag =
451 	    container_of(pmt, struct mlx5e_tls_tag, tag.m_snd_tag);
452 	int error;
453 
454 	switch (ptag->tag.type) {
455 #if defined(RATELIMIT) && defined(IF_SND_TAG_TYPE_TLS_RATE_LIMIT)
456 	case IF_SND_TAG_TYPE_TLS_RATE_LIMIT:
457 		error = mlx5e_rl_snd_tag_query(ptag->rl_tag, params);
458 		break;
459 #endif
460 	case IF_SND_TAG_TYPE_TLS:
461 		error = mlx5e_ul_snd_tag_query(ptag->rl_tag, params);
462 		break;
463 	default:
464 		error = EOPNOTSUPP;
465 		break;
466 	}
467 	return (error);
468 }
469 
470 void
471 mlx5e_tls_snd_tag_free(struct m_snd_tag *pmt)
472 {
473 	struct mlx5e_tls_tag *ptag =
474 	    container_of(pmt, struct mlx5e_tls_tag, tag.m_snd_tag);
475 	struct mlx5e_priv *priv;
476 
477 	switch (ptag->tag.type) {
478 #if defined(RATELIMIT) && defined(IF_SND_TAG_TYPE_TLS_RATE_LIMIT)
479 	case IF_SND_TAG_TYPE_TLS_RATE_LIMIT:
480 		mlx5e_rl_snd_tag_free(ptag->rl_tag);
481 		break;
482 #endif
483 	case IF_SND_TAG_TYPE_TLS:
484 		mlx5e_ul_snd_tag_free(ptag->rl_tag);
485 		break;
486 	default:
487 		break;
488 	}
489 
490 	MLX5E_TLS_TAG_LOCK(ptag);
491 	ptag->state = MLX5E_TLS_ST_FREED;
492 	MLX5E_TLS_TAG_UNLOCK(ptag);
493 
494 	priv = ptag->tag.m_snd_tag.ifp->if_softc;
495 	queue_work(priv->tls.wq, &ptag->work);
496 }
497 
498 CTASSERT((MLX5_FLD_SZ_BYTES(sw_tls_cntx, param) % 16) == 0);
499 
500 static void
501 mlx5e_tls_send_static_parameters(struct mlx5e_sq *sq, struct mlx5e_tls_tag *ptag)
502 {
503 	const u32 ds_cnt = DIV_ROUND_UP(sizeof(struct mlx5e_tx_umr_wqe) +
504 	    MLX5_FLD_SZ_BYTES(sw_tls_cntx, param), MLX5_SEND_WQE_DS);
505 	struct mlx5e_tx_umr_wqe *wqe;
506 	u16 pi;
507 
508 	pi = sq->pc & sq->wq.sz_m1;
509 	wqe = mlx5_wq_cyc_get_wqe(&sq->wq, pi);
510 
511 	memset(wqe, 0, sizeof(*wqe));
512 
513 	wqe->ctrl.opmod_idx_opcode = cpu_to_be32((sq->pc << 8) |
514 	    MLX5_OPCODE_UMR | (MLX5_OPCODE_MOD_UMR_TLS_TIS_STATIC_PARAMS << 24));
515 	wqe->ctrl.qpn_ds = cpu_to_be32((sq->sqn << 8) | ds_cnt);
516 	wqe->ctrl.imm = cpu_to_be32(ptag->tisn << 8);
517 
518 	if (mlx5e_do_send_cqe(sq))
519 		wqe->ctrl.fm_ce_se = MLX5_WQE_CTRL_CQ_UPDATE | MLX5_FENCE_MODE_INITIATOR_SMALL;
520 	else
521 		wqe->ctrl.fm_ce_se = MLX5_FENCE_MODE_INITIATOR_SMALL;
522 
523 	/* fill out UMR control segment */
524 	wqe->umr.flags = 0x80;	/* inline data */
525 	wqe->umr.bsf_octowords = cpu_to_be16(MLX5_FLD_SZ_BYTES(sw_tls_cntx, param) / 16);
526 
527 	/* copy in the static crypto parameters */
528 	memcpy(wqe + 1, MLX5_ADDR_OF(sw_tls_cntx, ptag->crypto_params, param),
529 	    MLX5_FLD_SZ_BYTES(sw_tls_cntx, param));
530 
531 	/* copy data for doorbell */
532 	memcpy(sq->doorbell.d32, &wqe->ctrl, sizeof(sq->doorbell.d32));
533 
534 	sq->mbuf[pi].mbuf = NULL;
535 	sq->mbuf[pi].num_bytes = 0;
536 	sq->mbuf[pi].num_wqebbs = DIV_ROUND_UP(ds_cnt, MLX5_SEND_WQEBB_NUM_DS);
537 	sq->mbuf[pi].p_refcount = &ptag->refs;
538 	atomic_add_int(&ptag->refs, 1);
539 	sq->pc += sq->mbuf[pi].num_wqebbs;
540 }
541 
542 CTASSERT(MLX5_FLD_SZ_BYTES(sw_tls_cntx, progress) ==
543     sizeof(((struct mlx5e_tx_psv_wqe *)0)->psv));
544 
545 static void
546 mlx5e_tls_send_progress_parameters(struct mlx5e_sq *sq, struct mlx5e_tls_tag *ptag)
547 {
548 	const u32 ds_cnt = DIV_ROUND_UP(sizeof(struct mlx5e_tx_psv_wqe),
549 	    MLX5_SEND_WQE_DS);
550 	struct mlx5e_tx_psv_wqe *wqe;
551 	u16 pi;
552 
553 	pi = sq->pc & sq->wq.sz_m1;
554 	wqe = mlx5_wq_cyc_get_wqe(&sq->wq, pi);
555 
556 	memset(wqe, 0, sizeof(*wqe));
557 
558 	wqe->ctrl.opmod_idx_opcode = cpu_to_be32((sq->pc << 8) |
559 	    MLX5_OPCODE_SET_PSV | (MLX5_OPCODE_MOD_PSV_TLS_TIS_PROGRESS_PARAMS << 24));
560 	wqe->ctrl.qpn_ds = cpu_to_be32((sq->sqn << 8) | ds_cnt);
561 
562 	if (mlx5e_do_send_cqe(sq))
563 		wqe->ctrl.fm_ce_se = MLX5_WQE_CTRL_CQ_UPDATE;
564 
565 	/* copy in the PSV control segment */
566 	memcpy(&wqe->psv, MLX5_ADDR_OF(sw_tls_cntx, ptag->crypto_params, progress),
567 	    sizeof(wqe->psv));
568 
569 	/* copy data for doorbell */
570 	memcpy(sq->doorbell.d32, &wqe->ctrl, sizeof(sq->doorbell.d32));
571 
572 	sq->mbuf[pi].mbuf = NULL;
573 	sq->mbuf[pi].num_bytes = 0;
574 	sq->mbuf[pi].num_wqebbs = DIV_ROUND_UP(ds_cnt, MLX5_SEND_WQEBB_NUM_DS);
575 	sq->mbuf[pi].p_refcount = &ptag->refs;
576 	atomic_add_int(&ptag->refs, 1);
577 	sq->pc += sq->mbuf[pi].num_wqebbs;
578 }
579 
580 static void
581 mlx5e_tls_send_nop(struct mlx5e_sq *sq, struct mlx5e_tls_tag *ptag)
582 {
583 	const u32 ds_cnt = MLX5_SEND_WQEBB_NUM_DS;
584 	struct mlx5e_tx_wqe *wqe;
585 	u16 pi;
586 
587 	pi = sq->pc & sq->wq.sz_m1;
588 	wqe = mlx5_wq_cyc_get_wqe(&sq->wq, pi);
589 
590 	memset(&wqe->ctrl, 0, sizeof(wqe->ctrl));
591 
592 	wqe->ctrl.opmod_idx_opcode = cpu_to_be32((sq->pc << 8) | MLX5_OPCODE_NOP);
593 	wqe->ctrl.qpn_ds = cpu_to_be32((sq->sqn << 8) | ds_cnt);
594 	if (mlx5e_do_send_cqe(sq))
595 		wqe->ctrl.fm_ce_se = MLX5_WQE_CTRL_CQ_UPDATE | MLX5_FENCE_MODE_INITIATOR_SMALL;
596 	else
597 		wqe->ctrl.fm_ce_se = MLX5_FENCE_MODE_INITIATOR_SMALL;
598 
599 	/* Copy data for doorbell */
600 	memcpy(sq->doorbell.d32, &wqe->ctrl, sizeof(sq->doorbell.d32));
601 
602 	sq->mbuf[pi].mbuf = NULL;
603 	sq->mbuf[pi].num_bytes = 0;
604 	sq->mbuf[pi].num_wqebbs = DIV_ROUND_UP(ds_cnt, MLX5_SEND_WQEBB_NUM_DS);
605 	sq->mbuf[pi].p_refcount = &ptag->refs;
606 	atomic_add_int(&ptag->refs, 1);
607 	sq->pc += sq->mbuf[pi].num_wqebbs;
608 }
609 
610 #define	SBTLS_MBUF_NO_DATA ((struct mbuf *)1)
611 
612 static struct mbuf *
613 sbtls_recover_record(struct mbuf *mb, int wait, uint32_t tcp_old, uint32_t *ptcp_seq, bool *pis_start)
614 {
615 	struct mbuf *mr, *top;
616 	uint32_t offset;
617 	uint32_t delta;
618 
619 	/* check format of incoming mbuf */
620 	if (mb->m_next == NULL ||
621 	    (mb->m_next->m_flags & (M_EXTPG | M_EXT)) != (M_EXTPG | M_EXT)) {
622 		top = NULL;
623 		goto done;
624 	}
625 
626 	/* get unmapped data offset */
627 	offset = mtod(mb->m_next, uintptr_t);
628 
629 	/* check if we don't need to re-transmit anything */
630 	if (offset == 0) {
631 		top = SBTLS_MBUF_NO_DATA;
632 		*pis_start = true;
633 		goto done;
634 	}
635 
636 	/* try to get a new  packet header */
637 	top = m_gethdr(wait, MT_DATA);
638 	if (top == NULL)
639 		goto done;
640 
641 	mr = m_get(wait, MT_DATA);
642 	if (mr == NULL) {
643 		m_free(top);
644 		top = NULL;
645 		goto done;
646 	}
647 
648 	top->m_next = mr;
649 
650 	mb_dupcl(mr, mb->m_next);
651 
652 	/* the beginning of the TLS record */
653 	mr->m_data = NULL;
654 
655 	/* setup packet header length */
656 	top->m_pkthdr.len = mr->m_len = offset;
657 	top->m_len = 0;
658 
659 	/* check for partial re-transmit */
660 	delta = *ptcp_seq - tcp_old;
661 
662 	if (delta < offset) {
663 		m_adj(top, offset - delta);
664 		offset = delta;
665 
666 		/* continue where we left off */
667 		*pis_start = false;
668 	} else {
669 		*pis_start = true;
670 	}
671 
672 	/*
673 	 * Rewind the TCP sequence number by the amount of data
674 	 * retransmitted:
675 	 */
676 	*ptcp_seq -= offset;
677 done:
678 	return (top);
679 }
680 
681 static int
682 mlx5e_sq_tls_populate(struct mbuf *mb, uint64_t *pseq)
683 {
684 
685 	for (; mb != NULL; mb = mb->m_next) {
686 		if (!(mb->m_flags & M_EXTPG))
687 			continue;
688 		*pseq = mb->m_epg_seqno;
689 		return (1);
690 	}
691 	return (0);
692 }
693 
694 int
695 mlx5e_sq_tls_xmit(struct mlx5e_sq *sq, struct mlx5e_xmit_args *parg, struct mbuf **ppmb)
696 {
697 	struct mlx5e_tls_tag *ptls_tag;
698 	struct mlx5e_snd_tag *ptag;
699 	const struct tcphdr *th;
700 	struct mbuf *mb = *ppmb;
701 	u64 rcd_sn;
702 	u32 header_size;
703 	u32 mb_seq;
704 
705 	if ((mb->m_pkthdr.csum_flags & CSUM_SND_TAG) == 0)
706 		return (MLX5E_TLS_CONTINUE);
707 
708 	ptag = container_of(mb->m_pkthdr.snd_tag,
709 	    struct mlx5e_snd_tag, m_snd_tag);
710 
711 	if (
712 #if defined(RATELIMIT) && defined(IF_SND_TAG_TYPE_TLS_RATE_LIMIT)
713 	    ptag->type != IF_SND_TAG_TYPE_TLS_RATE_LIMIT &&
714 #endif
715 	    ptag->type != IF_SND_TAG_TYPE_TLS)
716 		return (MLX5E_TLS_CONTINUE);
717 
718 	ptls_tag = container_of(ptag, struct mlx5e_tls_tag, tag);
719 
720 	header_size = mlx5e_get_full_header_size(mb, &th);
721 	if (unlikely(header_size == 0 || th == NULL))
722 		return (MLX5E_TLS_FAILURE);
723 
724 	/*
725 	 * Send non-TLS TCP packets AS-IS:
726 	 */
727 	if (header_size == mb->m_pkthdr.len ||
728 	    mlx5e_sq_tls_populate(mb, &rcd_sn) == 0) {
729 		parg->tisn = 0;
730 		parg->ihs = header_size;
731 		return (MLX5E_TLS_CONTINUE);
732 	}
733 
734 	mb_seq = ntohl(th->th_seq);
735 
736 	MLX5E_TLS_TAG_LOCK(ptls_tag);
737 	switch (ptls_tag->state) {
738 	case MLX5E_TLS_ST_INIT:
739 		queue_work(sq->priv->tls.wq, &ptls_tag->work);
740 		ptls_tag->state = MLX5E_TLS_ST_SETUP;
741 		ptls_tag->expected_seq = ~mb_seq;	/* force setup */
742 		MLX5E_TLS_TAG_UNLOCK(ptls_tag);
743 		return (MLX5E_TLS_FAILURE);
744 
745 	case MLX5E_TLS_ST_SETUP:
746 		MLX5E_TLS_TAG_UNLOCK(ptls_tag);
747 		return (MLX5E_TLS_FAILURE);
748 
749 	default:
750 		MLX5E_TLS_TAG_UNLOCK(ptls_tag);
751 		break;
752 	}
753 
754 	if (unlikely(ptls_tag->expected_seq != mb_seq)) {
755 		bool is_start;
756 		struct mbuf *r_mb;
757 		uint32_t tcp_seq = mb_seq;
758 
759 		r_mb = sbtls_recover_record(mb, M_NOWAIT, ptls_tag->expected_seq, &tcp_seq, &is_start);
760 		if (r_mb == NULL) {
761 			MLX5E_TLS_STAT_INC(ptls_tag, tx_error, 1);
762 			return (MLX5E_TLS_FAILURE);
763 		}
764 
765 		MLX5E_TLS_STAT_INC(ptls_tag, tx_packets_ooo, 1);
766 
767 		/* check if this is the first fragment of a TLS record */
768 		if (is_start) {
769 			/* setup TLS static parameters */
770 			MLX5_SET64(sw_tls_cntx, ptls_tag->crypto_params,
771 			    param.initial_record_number, rcd_sn);
772 
773 			/*
774 			 * NOTE: The sendqueue should have enough room to
775 			 * carry both the static and the progress parameters
776 			 * when we get here!
777 			 */
778 			mlx5e_tls_send_static_parameters(sq, ptls_tag);
779 			mlx5e_tls_send_progress_parameters(sq, ptls_tag);
780 
781 			if (r_mb == SBTLS_MBUF_NO_DATA) {
782 				mlx5e_tls_send_nop(sq, ptls_tag);
783 				ptls_tag->expected_seq = mb_seq;
784 				return (MLX5E_TLS_LOOP);
785 			}
786 		}
787 
788 		MLX5E_TLS_STAT_INC(ptls_tag, tx_bytes_ooo, r_mb->m_pkthdr.len);
789 
790 		/* setup transmit arguments */
791 		parg->tisn = ptls_tag->tisn;
792 		parg->pref = &ptls_tag->refs;
793 
794 		/* try to send DUMP data */
795 		if (mlx5e_sq_dump_xmit(sq, parg, &r_mb) != 0) {
796 			m_freem(r_mb);
797 			ptls_tag->expected_seq = tcp_seq;
798 			return (MLX5E_TLS_FAILURE);
799 		} else {
800 			ptls_tag->expected_seq = mb_seq;
801 			return (MLX5E_TLS_LOOP);
802 		}
803 	} else {
804 		MLX5E_TLS_STAT_INC(ptls_tag, tx_packets, 1);
805 		MLX5E_TLS_STAT_INC(ptls_tag, tx_bytes, mb->m_pkthdr.len);
806 	}
807 	ptls_tag->expected_seq += mb->m_pkthdr.len - header_size;
808 
809 	parg->tisn = ptls_tag->tisn;
810 	parg->ihs = header_size;
811 	parg->pref = &ptls_tag->refs;
812 	return (MLX5E_TLS_CONTINUE);
813 }
814 
815 #else
816 
817 int
818 mlx5e_tls_init(struct mlx5e_priv *priv)
819 {
820 
821 	return (0);
822 }
823 
824 void
825 mlx5e_tls_cleanup(struct mlx5e_priv *priv)
826 {
827 	/* NOP */
828 }
829 
830 #endif		/* KERN_TLS */
831