xref: /freebsd/sys/dev/mlx5/mlx5_en/mlx5_en_hw_tls.c (revision f9fd7337f63698f33239c58c07bf430198235a22)
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 	union if_snd_tag_alloc_params 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 
307 	/* check if there is no TIS context */
308 	if (ptag->tisn == 0) {
309 		uint32_t value;
310 
311 		value = atomic_fetchadd_32(&priv->tls.num_resources, 1U);
312 
313 		/* check resource limits */
314 		if (value >= priv->tls.max_resources) {
315 			error = ENOMEM;
316 			goto failure;
317 		}
318 	}
319 
320 	en = &params->tls.tls->params;
321 
322 	/* only TLS v1.2 and v1.3 is currently supported */
323 	if (en->tls_vmajor != TLS_MAJOR_VER_ONE ||
324 	    (en->tls_vminor != TLS_MINOR_VER_TWO
325 #ifdef TLS_MINOR_VER_THREE
326 	     && en->tls_vminor != TLS_MINOR_VER_THREE
327 #endif
328 	     )) {
329 		error = EPROTONOSUPPORT;
330 		goto failure;
331 	}
332 
333 	switch (en->cipher_algorithm) {
334 	case CRYPTO_AES_NIST_GCM_16:
335 		switch (en->cipher_key_len) {
336 		case 128 / 8:
337 			if (en->tls_vminor == TLS_MINOR_VER_TWO) {
338 				if (MLX5_CAP_TLS(priv->mdev, tls_1_2_aes_gcm_128) == 0) {
339 					error = EPROTONOSUPPORT;
340 					goto failure;
341 				}
342 			} else {
343 				if (MLX5_CAP_TLS(priv->mdev, tls_1_3_aes_gcm_128) == 0) {
344 					error = EPROTONOSUPPORT;
345 					goto failure;
346 				}
347 			}
348 			error = mlx5e_tls_set_params(ptag->crypto_params, en);
349 			if (error)
350 				goto failure;
351 			break;
352 
353 		case 256 / 8:
354 			if (en->tls_vminor == TLS_MINOR_VER_TWO) {
355 				if (MLX5_CAP_TLS(priv->mdev, tls_1_2_aes_gcm_256) == 0) {
356 					error = EPROTONOSUPPORT;
357 					goto failure;
358 				}
359 			} else {
360 				if (MLX5_CAP_TLS(priv->mdev, tls_1_3_aes_gcm_256) == 0) {
361 					error = EPROTONOSUPPORT;
362 					goto failure;
363 				}
364 			}
365 			error = mlx5e_tls_set_params(ptag->crypto_params, en);
366 			if (error)
367 				goto failure;
368 			break;
369 
370 		default:
371 			error = EINVAL;
372 			goto failure;
373 		}
374 		break;
375 	default:
376 		error = EPROTONOSUPPORT;
377 		goto failure;
378 	}
379 
380 	memset(&rl_params, 0, sizeof(rl_params));
381 	rl_params.hdr = params->hdr;
382 	switch (params->hdr.type) {
383 #ifdef RATELIMIT
384 	case IF_SND_TAG_TYPE_TLS_RATE_LIMIT:
385 		rl_params.hdr.type = IF_SND_TAG_TYPE_RATE_LIMIT;
386 		rl_params.rate_limit.max_rate = params->tls_rate_limit.max_rate;
387 		break;
388 #endif
389 	case IF_SND_TAG_TYPE_TLS:
390 		rl_params.hdr.type = IF_SND_TAG_TYPE_UNLIMITED;
391 		break;
392 	default:
393 		error = EOPNOTSUPP;
394 		goto failure;
395 	}
396 
397 	error = m_snd_tag_alloc(ifp, &rl_params, &ptag->rl_tag);
398 	if (error)
399 		goto failure;
400 
401 	/* store pointer to mbuf tag */
402 	MPASS(ptag->tag.refcount == 0);
403 	m_snd_tag_init(&ptag->tag, ifp, params->hdr.type);
404 	*ppmt = &ptag->tag;
405 
406 	queue_work(priv->tls.wq, &ptag->work);
407 	flush_work(&ptag->work);
408 
409 	return (0);
410 
411 failure:
412 	mlx5e_tls_tag_zfree(ptag);
413 	return (error);
414 }
415 
416 int
417 mlx5e_tls_snd_tag_modify(struct m_snd_tag *pmt, union if_snd_tag_modify_params *params)
418 {
419 #ifdef RATELIMIT
420 	union if_snd_tag_modify_params rl_params;
421 	struct mlx5e_tls_tag *ptag =
422 	    container_of(pmt, struct mlx5e_tls_tag, tag);
423 	int error;
424 #endif
425 
426 	switch (pmt->type) {
427 #ifdef RATELIMIT
428 	case IF_SND_TAG_TYPE_TLS_RATE_LIMIT:
429 		memset(&rl_params, 0, sizeof(rl_params));
430 		rl_params.rate_limit.max_rate = params->tls_rate_limit.max_rate;
431 		error = ptag->rl_tag->ifp->if_snd_tag_modify(ptag->rl_tag,
432 		    &rl_params);
433 		return (error);
434 #endif
435 	default:
436 		return (EOPNOTSUPP);
437 	}
438 }
439 
440 int
441 mlx5e_tls_snd_tag_query(struct m_snd_tag *pmt, union if_snd_tag_query_params *params)
442 {
443 	struct mlx5e_tls_tag *ptag =
444 	    container_of(pmt, struct mlx5e_tls_tag, tag);
445 	int error;
446 
447 	switch (pmt->type) {
448 #ifdef RATELIMIT
449 	case IF_SND_TAG_TYPE_TLS_RATE_LIMIT:
450 #endif
451 	case IF_SND_TAG_TYPE_TLS:
452 		error = ptag->rl_tag->ifp->if_snd_tag_query(ptag->rl_tag,
453 		    params);
454 		break;
455 	default:
456 		error = EOPNOTSUPP;
457 		break;
458 	}
459 	return (error);
460 }
461 
462 void
463 mlx5e_tls_snd_tag_free(struct m_snd_tag *pmt)
464 {
465 	struct mlx5e_tls_tag *ptag =
466 	    container_of(pmt, struct mlx5e_tls_tag, tag);
467 	struct mlx5e_priv *priv;
468 
469 	MPASS(ptag->rl_tag->refcount == 1);
470 	m_snd_tag_rele(ptag->rl_tag);
471 
472 	MLX5E_TLS_TAG_LOCK(ptag);
473 	ptag->state = MLX5E_TLS_ST_FREED;
474 	MLX5E_TLS_TAG_UNLOCK(ptag);
475 
476 	priv = ptag->tag.ifp->if_softc;
477 	queue_work(priv->tls.wq, &ptag->work);
478 }
479 
480 CTASSERT((MLX5_FLD_SZ_BYTES(sw_tls_cntx, param) % 16) == 0);
481 
482 static void
483 mlx5e_tls_send_static_parameters(struct mlx5e_sq *sq, struct mlx5e_tls_tag *ptag)
484 {
485 	const u32 ds_cnt = DIV_ROUND_UP(sizeof(struct mlx5e_tx_umr_wqe) +
486 	    MLX5_FLD_SZ_BYTES(sw_tls_cntx, param), MLX5_SEND_WQE_DS);
487 	struct mlx5e_tx_umr_wqe *wqe;
488 	u16 pi;
489 
490 	pi = sq->pc & sq->wq.sz_m1;
491 	wqe = mlx5_wq_cyc_get_wqe(&sq->wq, pi);
492 
493 	memset(wqe, 0, sizeof(*wqe));
494 
495 	wqe->ctrl.opmod_idx_opcode = cpu_to_be32((sq->pc << 8) |
496 	    MLX5_OPCODE_UMR | (MLX5_OPCODE_MOD_UMR_TLS_TIS_STATIC_PARAMS << 24));
497 	wqe->ctrl.qpn_ds = cpu_to_be32((sq->sqn << 8) | ds_cnt);
498 	wqe->ctrl.imm = cpu_to_be32(ptag->tisn << 8);
499 
500 	if (mlx5e_do_send_cqe(sq))
501 		wqe->ctrl.fm_ce_se = MLX5_WQE_CTRL_CQ_UPDATE | MLX5_FENCE_MODE_INITIATOR_SMALL;
502 	else
503 		wqe->ctrl.fm_ce_se = MLX5_FENCE_MODE_INITIATOR_SMALL;
504 
505 	/* fill out UMR control segment */
506 	wqe->umr.flags = 0x80;	/* inline data */
507 	wqe->umr.bsf_octowords = cpu_to_be16(MLX5_FLD_SZ_BYTES(sw_tls_cntx, param) / 16);
508 
509 	/* copy in the static crypto parameters */
510 	memcpy(wqe + 1, MLX5_ADDR_OF(sw_tls_cntx, ptag->crypto_params, param),
511 	    MLX5_FLD_SZ_BYTES(sw_tls_cntx, param));
512 
513 	/* copy data for doorbell */
514 	memcpy(sq->doorbell.d32, &wqe->ctrl, sizeof(sq->doorbell.d32));
515 
516 	sq->mbuf[pi].mbuf = NULL;
517 	sq->mbuf[pi].num_bytes = 0;
518 	sq->mbuf[pi].num_wqebbs = DIV_ROUND_UP(ds_cnt, MLX5_SEND_WQEBB_NUM_DS);
519 	sq->mbuf[pi].p_refcount = &ptag->refs;
520 	atomic_add_int(&ptag->refs, 1);
521 	sq->pc += sq->mbuf[pi].num_wqebbs;
522 }
523 
524 CTASSERT(MLX5_FLD_SZ_BYTES(sw_tls_cntx, progress) ==
525     sizeof(((struct mlx5e_tx_psv_wqe *)0)->psv));
526 
527 static void
528 mlx5e_tls_send_progress_parameters(struct mlx5e_sq *sq, struct mlx5e_tls_tag *ptag)
529 {
530 	const u32 ds_cnt = DIV_ROUND_UP(sizeof(struct mlx5e_tx_psv_wqe),
531 	    MLX5_SEND_WQE_DS);
532 	struct mlx5e_tx_psv_wqe *wqe;
533 	u16 pi;
534 
535 	pi = sq->pc & sq->wq.sz_m1;
536 	wqe = mlx5_wq_cyc_get_wqe(&sq->wq, pi);
537 
538 	memset(wqe, 0, sizeof(*wqe));
539 
540 	wqe->ctrl.opmod_idx_opcode = cpu_to_be32((sq->pc << 8) |
541 	    MLX5_OPCODE_SET_PSV | (MLX5_OPCODE_MOD_PSV_TLS_TIS_PROGRESS_PARAMS << 24));
542 	wqe->ctrl.qpn_ds = cpu_to_be32((sq->sqn << 8) | ds_cnt);
543 
544 	if (mlx5e_do_send_cqe(sq))
545 		wqe->ctrl.fm_ce_se = MLX5_WQE_CTRL_CQ_UPDATE;
546 
547 	/* copy in the PSV control segment */
548 	memcpy(&wqe->psv, MLX5_ADDR_OF(sw_tls_cntx, ptag->crypto_params, progress),
549 	    sizeof(wqe->psv));
550 
551 	/* copy data for doorbell */
552 	memcpy(sq->doorbell.d32, &wqe->ctrl, sizeof(sq->doorbell.d32));
553 
554 	sq->mbuf[pi].mbuf = NULL;
555 	sq->mbuf[pi].num_bytes = 0;
556 	sq->mbuf[pi].num_wqebbs = DIV_ROUND_UP(ds_cnt, MLX5_SEND_WQEBB_NUM_DS);
557 	sq->mbuf[pi].p_refcount = &ptag->refs;
558 	atomic_add_int(&ptag->refs, 1);
559 	sq->pc += sq->mbuf[pi].num_wqebbs;
560 }
561 
562 static void
563 mlx5e_tls_send_nop(struct mlx5e_sq *sq, struct mlx5e_tls_tag *ptag)
564 {
565 	const u32 ds_cnt = MLX5_SEND_WQEBB_NUM_DS;
566 	struct mlx5e_tx_wqe *wqe;
567 	u16 pi;
568 
569 	pi = sq->pc & sq->wq.sz_m1;
570 	wqe = mlx5_wq_cyc_get_wqe(&sq->wq, pi);
571 
572 	memset(&wqe->ctrl, 0, sizeof(wqe->ctrl));
573 
574 	wqe->ctrl.opmod_idx_opcode = cpu_to_be32((sq->pc << 8) | MLX5_OPCODE_NOP);
575 	wqe->ctrl.qpn_ds = cpu_to_be32((sq->sqn << 8) | ds_cnt);
576 	if (mlx5e_do_send_cqe(sq))
577 		wqe->ctrl.fm_ce_se = MLX5_WQE_CTRL_CQ_UPDATE | MLX5_FENCE_MODE_INITIATOR_SMALL;
578 	else
579 		wqe->ctrl.fm_ce_se = MLX5_FENCE_MODE_INITIATOR_SMALL;
580 
581 	/* Copy data for doorbell */
582 	memcpy(sq->doorbell.d32, &wqe->ctrl, sizeof(sq->doorbell.d32));
583 
584 	sq->mbuf[pi].mbuf = NULL;
585 	sq->mbuf[pi].num_bytes = 0;
586 	sq->mbuf[pi].num_wqebbs = DIV_ROUND_UP(ds_cnt, MLX5_SEND_WQEBB_NUM_DS);
587 	sq->mbuf[pi].p_refcount = &ptag->refs;
588 	atomic_add_int(&ptag->refs, 1);
589 	sq->pc += sq->mbuf[pi].num_wqebbs;
590 }
591 
592 #define	SBTLS_MBUF_NO_DATA ((struct mbuf *)1)
593 
594 static struct mbuf *
595 sbtls_recover_record(struct mbuf *mb, int wait, uint32_t tcp_old, uint32_t *ptcp_seq, bool *pis_start)
596 {
597 	struct mbuf *mr, *top;
598 	uint32_t offset;
599 	uint32_t delta;
600 
601 	/* check format of incoming mbuf */
602 	if (mb->m_next == NULL ||
603 	    (mb->m_next->m_flags & (M_EXTPG | M_EXT)) != (M_EXTPG | M_EXT)) {
604 		top = NULL;
605 		goto done;
606 	}
607 
608 	/* get unmapped data offset */
609 	offset = mtod(mb->m_next, uintptr_t);
610 
611 	/* check if we don't need to re-transmit anything */
612 	if (offset == 0) {
613 		top = SBTLS_MBUF_NO_DATA;
614 		*pis_start = true;
615 		goto done;
616 	}
617 
618 	/* try to get a new  packet header */
619 	top = m_gethdr(wait, MT_DATA);
620 	if (top == NULL)
621 		goto done;
622 
623 	mr = m_get(wait, MT_DATA);
624 	if (mr == NULL) {
625 		m_free(top);
626 		top = NULL;
627 		goto done;
628 	}
629 
630 	top->m_next = mr;
631 
632 	mb_dupcl(mr, mb->m_next);
633 
634 	/* the beginning of the TLS record */
635 	mr->m_data = NULL;
636 
637 	/* setup packet header length */
638 	top->m_pkthdr.len = mr->m_len = offset;
639 	top->m_len = 0;
640 
641 	/* check for partial re-transmit */
642 	delta = *ptcp_seq - tcp_old;
643 
644 	if (delta < offset) {
645 		m_adj(top, offset - delta);
646 		offset = delta;
647 
648 		/* continue where we left off */
649 		*pis_start = false;
650 	} else {
651 		*pis_start = true;
652 	}
653 
654 	/*
655 	 * Rewind the TCP sequence number by the amount of data
656 	 * retransmitted:
657 	 */
658 	*ptcp_seq -= offset;
659 done:
660 	return (top);
661 }
662 
663 static int
664 mlx5e_sq_tls_populate(struct mbuf *mb, uint64_t *pseq)
665 {
666 
667 	for (; mb != NULL; mb = mb->m_next) {
668 		if (!(mb->m_flags & M_EXTPG))
669 			continue;
670 		*pseq = mb->m_epg_seqno;
671 		return (1);
672 	}
673 	return (0);
674 }
675 
676 int
677 mlx5e_sq_tls_xmit(struct mlx5e_sq *sq, struct mlx5e_xmit_args *parg, struct mbuf **ppmb)
678 {
679 	struct mlx5e_tls_tag *ptls_tag;
680 	struct m_snd_tag *ptag;
681 	const struct tcphdr *th;
682 	struct mbuf *mb = *ppmb;
683 	u64 rcd_sn;
684 	u32 header_size;
685 	u32 mb_seq;
686 
687 	if ((mb->m_pkthdr.csum_flags & CSUM_SND_TAG) == 0)
688 		return (MLX5E_TLS_CONTINUE);
689 
690 	ptag = mb->m_pkthdr.snd_tag;
691 
692 	if (
693 #ifdef RATELIMIT
694 	    ptag->type != IF_SND_TAG_TYPE_TLS_RATE_LIMIT &&
695 #endif
696 	    ptag->type != IF_SND_TAG_TYPE_TLS)
697 		return (MLX5E_TLS_CONTINUE);
698 
699 	ptls_tag = container_of(ptag, struct mlx5e_tls_tag, tag);
700 
701 	header_size = mlx5e_get_full_header_size(mb, &th);
702 	if (unlikely(header_size == 0 || th == NULL))
703 		return (MLX5E_TLS_FAILURE);
704 
705 	/*
706 	 * Send non-TLS TCP packets AS-IS:
707 	 */
708 	if (header_size == mb->m_pkthdr.len ||
709 	    mlx5e_sq_tls_populate(mb, &rcd_sn) == 0) {
710 		parg->tisn = 0;
711 		parg->ihs = header_size;
712 		return (MLX5E_TLS_CONTINUE);
713 	}
714 
715 	mb_seq = ntohl(th->th_seq);
716 
717 	MLX5E_TLS_TAG_LOCK(ptls_tag);
718 	switch (ptls_tag->state) {
719 	case MLX5E_TLS_ST_INIT:
720 		MLX5E_TLS_TAG_UNLOCK(ptls_tag);
721 		return (MLX5E_TLS_FAILURE);
722 	case MLX5E_TLS_ST_SETUP:
723 		ptls_tag->state = MLX5E_TLS_ST_TXRDY;
724 		ptls_tag->expected_seq = ~mb_seq;	/* force setup */
725 	default:
726 		MLX5E_TLS_TAG_UNLOCK(ptls_tag);
727 		break;
728 	}
729 
730 	if (unlikely(ptls_tag->expected_seq != mb_seq)) {
731 		bool is_start;
732 		struct mbuf *r_mb;
733 		uint32_t tcp_seq = mb_seq;
734 
735 		r_mb = sbtls_recover_record(mb, M_NOWAIT, ptls_tag->expected_seq, &tcp_seq, &is_start);
736 		if (r_mb == NULL) {
737 			MLX5E_TLS_STAT_INC(ptls_tag, tx_error, 1);
738 			return (MLX5E_TLS_FAILURE);
739 		}
740 
741 		MLX5E_TLS_STAT_INC(ptls_tag, tx_packets_ooo, 1);
742 
743 		/* check if this is the first fragment of a TLS record */
744 		if (is_start) {
745 			/* setup TLS static parameters */
746 			MLX5_SET64(sw_tls_cntx, ptls_tag->crypto_params,
747 			    param.initial_record_number, rcd_sn);
748 
749 			/*
750 			 * NOTE: The sendqueue should have enough room to
751 			 * carry both the static and the progress parameters
752 			 * when we get here!
753 			 */
754 			mlx5e_tls_send_static_parameters(sq, ptls_tag);
755 			mlx5e_tls_send_progress_parameters(sq, ptls_tag);
756 
757 			if (r_mb == SBTLS_MBUF_NO_DATA) {
758 				mlx5e_tls_send_nop(sq, ptls_tag);
759 				ptls_tag->expected_seq = mb_seq;
760 				return (MLX5E_TLS_LOOP);
761 			}
762 		}
763 
764 		MLX5E_TLS_STAT_INC(ptls_tag, tx_bytes_ooo, r_mb->m_pkthdr.len);
765 
766 		/* setup transmit arguments */
767 		parg->tisn = ptls_tag->tisn;
768 		parg->pref = &ptls_tag->refs;
769 
770 		/* try to send DUMP data */
771 		if (mlx5e_sq_dump_xmit(sq, parg, &r_mb) != 0) {
772 			m_freem(r_mb);
773 			ptls_tag->expected_seq = tcp_seq;
774 			return (MLX5E_TLS_FAILURE);
775 		} else {
776 			ptls_tag->expected_seq = mb_seq;
777 			return (MLX5E_TLS_LOOP);
778 		}
779 	} else {
780 		MLX5E_TLS_STAT_INC(ptls_tag, tx_packets, 1);
781 		MLX5E_TLS_STAT_INC(ptls_tag, tx_bytes, mb->m_pkthdr.len);
782 	}
783 	ptls_tag->expected_seq += mb->m_pkthdr.len - header_size;
784 
785 	parg->tisn = ptls_tag->tisn;
786 	parg->ihs = header_size;
787 	parg->pref = &ptls_tag->refs;
788 	return (MLX5E_TLS_CONTINUE);
789 }
790 
791 #else
792 
793 int
794 mlx5e_tls_init(struct mlx5e_priv *priv)
795 {
796 
797 	return (0);
798 }
799 
800 void
801 mlx5e_tls_cleanup(struct mlx5e_priv *priv)
802 {
803 	/* NOP */
804 }
805 
806 #endif		/* KERN_TLS */
807