xref: /freebsd/sys/dev/mlx5/mlx5_en/mlx5_en_hw_tls.c (revision 6132212808e8dccedc9e5d85fea4390c2f38059a)
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_INIT:
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_INIT)
219 			ptag->state = MLX5E_TLS_ST_SETUP;
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 
417 	queue_work(priv->tls.wq, &ptag->work);
418 	flush_work(&ptag->work);
419 
420 	return (0);
421 
422 failure:
423 	mlx5e_tls_tag_zfree(ptag);
424 	return (error);
425 }
426 
427 int
428 mlx5e_tls_snd_tag_modify(struct m_snd_tag *pmt, union if_snd_tag_modify_params *params)
429 {
430 #if defined(RATELIMIT) && defined(IF_SND_TAG_TYPE_TLS_RATE_LIMIT)
431 	struct if_snd_tag_rate_limit_params rl_params;
432 	int error;
433 #endif
434 	struct mlx5e_tls_tag *ptag =
435 	    container_of(pmt, struct mlx5e_tls_tag, tag.m_snd_tag);
436 
437 	switch (ptag->tag.type) {
438 #if defined(RATELIMIT) && defined(IF_SND_TAG_TYPE_TLS_RATE_LIMIT)
439 	case IF_SND_TAG_TYPE_TLS_RATE_LIMIT:
440 		memset(&rl_params, 0, sizeof(rl_params));
441 		rl_params.max_rate = params->tls_rate_limit.max_rate;
442 		error = mlx5e_rl_snd_tag_modify(ptag->rl_tag,
443 		    container_of(&rl_params, union if_snd_tag_modify_params, rate_limit));
444 		return (error);
445 #endif
446 	default:
447 		return (EOPNOTSUPP);
448 	}
449 }
450 
451 int
452 mlx5e_tls_snd_tag_query(struct m_snd_tag *pmt, union if_snd_tag_query_params *params)
453 {
454 	struct mlx5e_tls_tag *ptag =
455 	    container_of(pmt, struct mlx5e_tls_tag, tag.m_snd_tag);
456 	int error;
457 
458 	switch (ptag->tag.type) {
459 #if defined(RATELIMIT) && defined(IF_SND_TAG_TYPE_TLS_RATE_LIMIT)
460 	case IF_SND_TAG_TYPE_TLS_RATE_LIMIT:
461 		error = mlx5e_rl_snd_tag_query(ptag->rl_tag, params);
462 		break;
463 #endif
464 	case IF_SND_TAG_TYPE_TLS:
465 		error = mlx5e_ul_snd_tag_query(ptag->rl_tag, params);
466 		break;
467 	default:
468 		error = EOPNOTSUPP;
469 		break;
470 	}
471 	return (error);
472 }
473 
474 void
475 mlx5e_tls_snd_tag_free(struct m_snd_tag *pmt)
476 {
477 	struct mlx5e_tls_tag *ptag =
478 	    container_of(pmt, struct mlx5e_tls_tag, tag.m_snd_tag);
479 	struct mlx5e_priv *priv;
480 
481 	switch (ptag->tag.type) {
482 #if defined(RATELIMIT) && defined(IF_SND_TAG_TYPE_TLS_RATE_LIMIT)
483 	case IF_SND_TAG_TYPE_TLS_RATE_LIMIT:
484 		mlx5e_rl_snd_tag_free(ptag->rl_tag);
485 		break;
486 #endif
487 	case IF_SND_TAG_TYPE_TLS:
488 		mlx5e_ul_snd_tag_free(ptag->rl_tag);
489 		break;
490 	default:
491 		break;
492 	}
493 
494 	MLX5E_TLS_TAG_LOCK(ptag);
495 	ptag->state = MLX5E_TLS_ST_FREED;
496 	MLX5E_TLS_TAG_UNLOCK(ptag);
497 
498 	priv = ptag->tag.m_snd_tag.ifp->if_softc;
499 	queue_work(priv->tls.wq, &ptag->work);
500 }
501 
502 CTASSERT((MLX5_FLD_SZ_BYTES(sw_tls_cntx, param) % 16) == 0);
503 
504 static void
505 mlx5e_tls_send_static_parameters(struct mlx5e_sq *sq, struct mlx5e_tls_tag *ptag)
506 {
507 	const u32 ds_cnt = DIV_ROUND_UP(sizeof(struct mlx5e_tx_umr_wqe) +
508 	    MLX5_FLD_SZ_BYTES(sw_tls_cntx, param), MLX5_SEND_WQE_DS);
509 	struct mlx5e_tx_umr_wqe *wqe;
510 	u16 pi;
511 
512 	pi = sq->pc & sq->wq.sz_m1;
513 	wqe = mlx5_wq_cyc_get_wqe(&sq->wq, pi);
514 
515 	memset(wqe, 0, sizeof(*wqe));
516 
517 	wqe->ctrl.opmod_idx_opcode = cpu_to_be32((sq->pc << 8) |
518 	    MLX5_OPCODE_UMR | (MLX5_OPCODE_MOD_UMR_TLS_TIS_STATIC_PARAMS << 24));
519 	wqe->ctrl.qpn_ds = cpu_to_be32((sq->sqn << 8) | ds_cnt);
520 	wqe->ctrl.imm = cpu_to_be32(ptag->tisn << 8);
521 
522 	if (mlx5e_do_send_cqe(sq))
523 		wqe->ctrl.fm_ce_se = MLX5_WQE_CTRL_CQ_UPDATE | MLX5_FENCE_MODE_INITIATOR_SMALL;
524 	else
525 		wqe->ctrl.fm_ce_se = MLX5_FENCE_MODE_INITIATOR_SMALL;
526 
527 	/* fill out UMR control segment */
528 	wqe->umr.flags = 0x80;	/* inline data */
529 	wqe->umr.bsf_octowords = cpu_to_be16(MLX5_FLD_SZ_BYTES(sw_tls_cntx, param) / 16);
530 
531 	/* copy in the static crypto parameters */
532 	memcpy(wqe + 1, MLX5_ADDR_OF(sw_tls_cntx, ptag->crypto_params, param),
533 	    MLX5_FLD_SZ_BYTES(sw_tls_cntx, param));
534 
535 	/* copy data for doorbell */
536 	memcpy(sq->doorbell.d32, &wqe->ctrl, sizeof(sq->doorbell.d32));
537 
538 	sq->mbuf[pi].mbuf = NULL;
539 	sq->mbuf[pi].num_bytes = 0;
540 	sq->mbuf[pi].num_wqebbs = DIV_ROUND_UP(ds_cnt, MLX5_SEND_WQEBB_NUM_DS);
541 	sq->mbuf[pi].p_refcount = &ptag->refs;
542 	atomic_add_int(&ptag->refs, 1);
543 	sq->pc += sq->mbuf[pi].num_wqebbs;
544 }
545 
546 CTASSERT(MLX5_FLD_SZ_BYTES(sw_tls_cntx, progress) ==
547     sizeof(((struct mlx5e_tx_psv_wqe *)0)->psv));
548 
549 static void
550 mlx5e_tls_send_progress_parameters(struct mlx5e_sq *sq, struct mlx5e_tls_tag *ptag)
551 {
552 	const u32 ds_cnt = DIV_ROUND_UP(sizeof(struct mlx5e_tx_psv_wqe),
553 	    MLX5_SEND_WQE_DS);
554 	struct mlx5e_tx_psv_wqe *wqe;
555 	u16 pi;
556 
557 	pi = sq->pc & sq->wq.sz_m1;
558 	wqe = mlx5_wq_cyc_get_wqe(&sq->wq, pi);
559 
560 	memset(wqe, 0, sizeof(*wqe));
561 
562 	wqe->ctrl.opmod_idx_opcode = cpu_to_be32((sq->pc << 8) |
563 	    MLX5_OPCODE_SET_PSV | (MLX5_OPCODE_MOD_PSV_TLS_TIS_PROGRESS_PARAMS << 24));
564 	wqe->ctrl.qpn_ds = cpu_to_be32((sq->sqn << 8) | ds_cnt);
565 
566 	if (mlx5e_do_send_cqe(sq))
567 		wqe->ctrl.fm_ce_se = MLX5_WQE_CTRL_CQ_UPDATE;
568 
569 	/* copy in the PSV control segment */
570 	memcpy(&wqe->psv, MLX5_ADDR_OF(sw_tls_cntx, ptag->crypto_params, progress),
571 	    sizeof(wqe->psv));
572 
573 	/* copy data for doorbell */
574 	memcpy(sq->doorbell.d32, &wqe->ctrl, sizeof(sq->doorbell.d32));
575 
576 	sq->mbuf[pi].mbuf = NULL;
577 	sq->mbuf[pi].num_bytes = 0;
578 	sq->mbuf[pi].num_wqebbs = DIV_ROUND_UP(ds_cnt, MLX5_SEND_WQEBB_NUM_DS);
579 	sq->mbuf[pi].p_refcount = &ptag->refs;
580 	atomic_add_int(&ptag->refs, 1);
581 	sq->pc += sq->mbuf[pi].num_wqebbs;
582 }
583 
584 static void
585 mlx5e_tls_send_nop(struct mlx5e_sq *sq, struct mlx5e_tls_tag *ptag)
586 {
587 	const u32 ds_cnt = MLX5_SEND_WQEBB_NUM_DS;
588 	struct mlx5e_tx_wqe *wqe;
589 	u16 pi;
590 
591 	pi = sq->pc & sq->wq.sz_m1;
592 	wqe = mlx5_wq_cyc_get_wqe(&sq->wq, pi);
593 
594 	memset(&wqe->ctrl, 0, sizeof(wqe->ctrl));
595 
596 	wqe->ctrl.opmod_idx_opcode = cpu_to_be32((sq->pc << 8) | MLX5_OPCODE_NOP);
597 	wqe->ctrl.qpn_ds = cpu_to_be32((sq->sqn << 8) | ds_cnt);
598 	if (mlx5e_do_send_cqe(sq))
599 		wqe->ctrl.fm_ce_se = MLX5_WQE_CTRL_CQ_UPDATE | MLX5_FENCE_MODE_INITIATOR_SMALL;
600 	else
601 		wqe->ctrl.fm_ce_se = MLX5_FENCE_MODE_INITIATOR_SMALL;
602 
603 	/* Copy data for doorbell */
604 	memcpy(sq->doorbell.d32, &wqe->ctrl, sizeof(sq->doorbell.d32));
605 
606 	sq->mbuf[pi].mbuf = NULL;
607 	sq->mbuf[pi].num_bytes = 0;
608 	sq->mbuf[pi].num_wqebbs = DIV_ROUND_UP(ds_cnt, MLX5_SEND_WQEBB_NUM_DS);
609 	sq->mbuf[pi].p_refcount = &ptag->refs;
610 	atomic_add_int(&ptag->refs, 1);
611 	sq->pc += sq->mbuf[pi].num_wqebbs;
612 }
613 
614 #define	SBTLS_MBUF_NO_DATA ((struct mbuf *)1)
615 
616 static struct mbuf *
617 sbtls_recover_record(struct mbuf *mb, int wait, uint32_t tcp_old, uint32_t *ptcp_seq, bool *pis_start)
618 {
619 	struct mbuf *mr, *top;
620 	uint32_t offset;
621 	uint32_t delta;
622 
623 	/* check format of incoming mbuf */
624 	if (mb->m_next == NULL ||
625 	    (mb->m_next->m_flags & (M_EXTPG | M_EXT)) != (M_EXTPG | M_EXT)) {
626 		top = NULL;
627 		goto done;
628 	}
629 
630 	/* get unmapped data offset */
631 	offset = mtod(mb->m_next, uintptr_t);
632 
633 	/* check if we don't need to re-transmit anything */
634 	if (offset == 0) {
635 		top = SBTLS_MBUF_NO_DATA;
636 		*pis_start = true;
637 		goto done;
638 	}
639 
640 	/* try to get a new  packet header */
641 	top = m_gethdr(wait, MT_DATA);
642 	if (top == NULL)
643 		goto done;
644 
645 	mr = m_get(wait, MT_DATA);
646 	if (mr == NULL) {
647 		m_free(top);
648 		top = NULL;
649 		goto done;
650 	}
651 
652 	top->m_next = mr;
653 
654 	mb_dupcl(mr, mb->m_next);
655 
656 	/* the beginning of the TLS record */
657 	mr->m_data = NULL;
658 
659 	/* setup packet header length */
660 	top->m_pkthdr.len = mr->m_len = offset;
661 	top->m_len = 0;
662 
663 	/* check for partial re-transmit */
664 	delta = *ptcp_seq - tcp_old;
665 
666 	if (delta < offset) {
667 		m_adj(top, offset - delta);
668 		offset = delta;
669 
670 		/* continue where we left off */
671 		*pis_start = false;
672 	} else {
673 		*pis_start = true;
674 	}
675 
676 	/*
677 	 * Rewind the TCP sequence number by the amount of data
678 	 * retransmitted:
679 	 */
680 	*ptcp_seq -= offset;
681 done:
682 	return (top);
683 }
684 
685 static int
686 mlx5e_sq_tls_populate(struct mbuf *mb, uint64_t *pseq)
687 {
688 
689 	for (; mb != NULL; mb = mb->m_next) {
690 		if (!(mb->m_flags & M_EXTPG))
691 			continue;
692 		*pseq = mb->m_epg_seqno;
693 		return (1);
694 	}
695 	return (0);
696 }
697 
698 int
699 mlx5e_sq_tls_xmit(struct mlx5e_sq *sq, struct mlx5e_xmit_args *parg, struct mbuf **ppmb)
700 {
701 	struct mlx5e_tls_tag *ptls_tag;
702 	struct mlx5e_snd_tag *ptag;
703 	const struct tcphdr *th;
704 	struct mbuf *mb = *ppmb;
705 	u64 rcd_sn;
706 	u32 header_size;
707 	u32 mb_seq;
708 
709 	if ((mb->m_pkthdr.csum_flags & CSUM_SND_TAG) == 0)
710 		return (MLX5E_TLS_CONTINUE);
711 
712 	ptag = container_of(mb->m_pkthdr.snd_tag,
713 	    struct mlx5e_snd_tag, m_snd_tag);
714 
715 	if (
716 #if defined(RATELIMIT) && defined(IF_SND_TAG_TYPE_TLS_RATE_LIMIT)
717 	    ptag->type != IF_SND_TAG_TYPE_TLS_RATE_LIMIT &&
718 #endif
719 	    ptag->type != IF_SND_TAG_TYPE_TLS)
720 		return (MLX5E_TLS_CONTINUE);
721 
722 	ptls_tag = container_of(ptag, struct mlx5e_tls_tag, tag);
723 
724 	header_size = mlx5e_get_full_header_size(mb, &th);
725 	if (unlikely(header_size == 0 || th == NULL))
726 		return (MLX5E_TLS_FAILURE);
727 
728 	/*
729 	 * Send non-TLS TCP packets AS-IS:
730 	 */
731 	if (header_size == mb->m_pkthdr.len ||
732 	    mlx5e_sq_tls_populate(mb, &rcd_sn) == 0) {
733 		parg->tisn = 0;
734 		parg->ihs = header_size;
735 		return (MLX5E_TLS_CONTINUE);
736 	}
737 
738 	mb_seq = ntohl(th->th_seq);
739 
740 	MLX5E_TLS_TAG_LOCK(ptls_tag);
741 	switch (ptls_tag->state) {
742 	case MLX5E_TLS_ST_INIT:
743 		MLX5E_TLS_TAG_UNLOCK(ptls_tag);
744 		return (MLX5E_TLS_FAILURE);
745 	case MLX5E_TLS_ST_SETUP:
746 		ptls_tag->state = MLX5E_TLS_ST_TXRDY;
747 		ptls_tag->expected_seq = ~mb_seq;	/* force setup */
748 	default:
749 		MLX5E_TLS_TAG_UNLOCK(ptls_tag);
750 		break;
751 	}
752 
753 	if (unlikely(ptls_tag->expected_seq != mb_seq)) {
754 		bool is_start;
755 		struct mbuf *r_mb;
756 		uint32_t tcp_seq = mb_seq;
757 
758 		r_mb = sbtls_recover_record(mb, M_NOWAIT, ptls_tag->expected_seq, &tcp_seq, &is_start);
759 		if (r_mb == NULL) {
760 			MLX5E_TLS_STAT_INC(ptls_tag, tx_error, 1);
761 			return (MLX5E_TLS_FAILURE);
762 		}
763 
764 		MLX5E_TLS_STAT_INC(ptls_tag, tx_packets_ooo, 1);
765 
766 		/* check if this is the first fragment of a TLS record */
767 		if (is_start) {
768 			/* setup TLS static parameters */
769 			MLX5_SET64(sw_tls_cntx, ptls_tag->crypto_params,
770 			    param.initial_record_number, rcd_sn);
771 
772 			/*
773 			 * NOTE: The sendqueue should have enough room to
774 			 * carry both the static and the progress parameters
775 			 * when we get here!
776 			 */
777 			mlx5e_tls_send_static_parameters(sq, ptls_tag);
778 			mlx5e_tls_send_progress_parameters(sq, ptls_tag);
779 
780 			if (r_mb == SBTLS_MBUF_NO_DATA) {
781 				mlx5e_tls_send_nop(sq, ptls_tag);
782 				ptls_tag->expected_seq = mb_seq;
783 				return (MLX5E_TLS_LOOP);
784 			}
785 		}
786 
787 		MLX5E_TLS_STAT_INC(ptls_tag, tx_bytes_ooo, r_mb->m_pkthdr.len);
788 
789 		/* setup transmit arguments */
790 		parg->tisn = ptls_tag->tisn;
791 		parg->pref = &ptls_tag->refs;
792 
793 		/* try to send DUMP data */
794 		if (mlx5e_sq_dump_xmit(sq, parg, &r_mb) != 0) {
795 			m_freem(r_mb);
796 			ptls_tag->expected_seq = tcp_seq;
797 			return (MLX5E_TLS_FAILURE);
798 		} else {
799 			ptls_tag->expected_seq = mb_seq;
800 			return (MLX5E_TLS_LOOP);
801 		}
802 	} else {
803 		MLX5E_TLS_STAT_INC(ptls_tag, tx_packets, 1);
804 		MLX5E_TLS_STAT_INC(ptls_tag, tx_bytes, mb->m_pkthdr.len);
805 	}
806 	ptls_tag->expected_seq += mb->m_pkthdr.len - header_size;
807 
808 	parg->tisn = ptls_tag->tisn;
809 	parg->ihs = header_size;
810 	parg->pref = &ptls_tag->refs;
811 	return (MLX5E_TLS_CONTINUE);
812 }
813 
814 #else
815 
816 int
817 mlx5e_tls_init(struct mlx5e_priv *priv)
818 {
819 
820 	return (0);
821 }
822 
823 void
824 mlx5e_tls_cleanup(struct mlx5e_priv *priv)
825 {
826 	/* NOP */
827 }
828 
829 #endif		/* KERN_TLS */
830