From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 0C293A0032; Fri, 21 Oct 2022 11:22:00 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id BA12042C36; Fri, 21 Oct 2022 11:21:36 +0200 (CEST) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mails.dpdk.org (Postfix) with ESMTP id 055EE42C4C for ; Fri, 21 Oct 2022 11:21:32 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1666344092; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=QyIo6kZD9HtoT+qh6N0kFdoWdzi8jyx3a/aX0WKDuqw=; b=I6yic2wPjlgATEdIBn1PhLytFK7d0eMAxEPNCNmZ5yaaNXc8wDFKJJ0A5VHmcuXmyHayU2 nIHKaFIAeuMfeuGcTaVRNpSev3AtuxVJkloZuVo8h9wP7rXeH3lubmtbQu0FwJLyvuPBIV IeGh9JV7dCpXQ/UHcTqX/DLuveuHmnI= Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-481-SnsTj9YDOTqH6HINwnGIjA-1; Fri, 21 Oct 2022 05:21:29 -0400 X-MC-Unique: SnsTj9YDOTqH6HINwnGIjA-1 Received: from smtp.corp.redhat.com (int-mx10.intmail.prod.int.rdu2.redhat.com [10.11.54.10]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 0D36E101A54E; Fri, 21 Oct 2022 09:21:29 +0000 (UTC) Received: from [10.39.208.30] (unknown [10.39.208.30]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 52C5040F156; Fri, 21 Oct 2022 09:21:27 +0000 (UTC) Message-ID: <06130f31-d9d5-25f6-fdb0-e6bbce65499a@redhat.com> Date: Fri, 21 Oct 2022 11:21:25 +0200 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101 Thunderbird/102.3.1 Subject: Re: [PATCH v5 20/29] baseband/acc100: update validate LDPC enc/dec To: Hernan Vargas , dev@dpdk.org, gakhil@marvell.com, trix@redhat.com Cc: nicolas.chautru@intel.com, qi.z.zhang@intel.com References: <20221021052102.107141-1-hernan.vargas@intel.com> <20221021052102.107141-21-hernan.vargas@intel.com> From: Maxime Coquelin In-Reply-To: <20221021052102.107141-21-hernan.vargas@intel.com> X-Scanned-By: MIMEDefang 3.1 on 10.11.54.10 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Language: en-US Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 7bit X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org On 10/21/22 07:20, Hernan Vargas wrote: > Update validate functions to check for valid LDPC parameters to avoid > any HW issues. > Adding protection for null corner case and for HARQ inbound size out > of range. > HARQ input size from application may be invalid and causing HW issue. > Add checks to ensure that if HARQ is invalid, set to some valid size to > ensure HW issues do not occur. > > Signed-off-by: Hernan Vargas > --- > doc/guides/bbdevs/acc100.rst | 2 + > drivers/baseband/acc/acc_common.h | 1 + > drivers/baseband/acc/rte_acc100_pmd.c | 285 +++++++++++++++++++++++--- > 3 files changed, 257 insertions(+), 31 deletions(-) > > diff --git a/doc/guides/bbdevs/acc100.rst b/doc/guides/bbdevs/acc100.rst > index db46023044..6c7025e019 100644 > --- a/doc/guides/bbdevs/acc100.rst > +++ b/doc/guides/bbdevs/acc100.rst > @@ -71,6 +71,8 @@ ACC100 and ACC101 5G/4G FEC PMDs support the following BBDEV capabilities: > - ``RTE_LIBRTE_BBDEV_SKIP_VALIDATE`` : option to skip API input validation. > Recommended value is to keep the validation enable by default as a protection for negative > scenarios at a cost of some cycles spent to enforce these checks. > + - ``ACC100_EXT_MEM`` : default option with memory external to CPU on the PCie card DDR itself. > + Alternative build option will use CPU memory (not recommended). > > Installation > ------------ > diff --git a/drivers/baseband/acc/acc_common.h b/drivers/baseband/acc/acc_common.h > index 97d10b8b40..eae7eab4e9 100644 > --- a/drivers/baseband/acc/acc_common.h > +++ b/drivers/baseband/acc/acc_common.h > @@ -121,6 +121,7 @@ > #define ACC_ALGO_SPA 0 > #define ACC_ALGO_MSA 1 > #define ACC_HARQ_ALIGN_64B 64 > +#define ACC_MAX_ZC 384 > > /* Helper macro for logging */ > #define rte_acc_log(level, fmt, ...) \ > diff --git a/drivers/baseband/acc/rte_acc100_pmd.c b/drivers/baseband/acc/rte_acc100_pmd.c > index 4c890b28f1..383f71b6be 100644 > --- a/drivers/baseband/acc/rte_acc100_pmd.c > +++ b/drivers/baseband/acc/rte_acc100_pmd.c > @@ -1954,14 +1954,11 @@ static inline int > validate_ldpc_enc_op(struct rte_bbdev_enc_op *op, struct acc_queue *q) > { > struct rte_bbdev_op_ldpc_enc *ldpc_enc = &op->ldpc_enc; > + int K, N, q_m, crc24; > > if (!validate_op_required(q)) > return 0; > > - if (op->mempool == NULL) { > - rte_bbdev_log(ERR, "Invalid mempool pointer"); > - return -1; > - } > if (ldpc_enc->input.data == NULL) { > rte_bbdev_log(ERR, "Invalid input pointer"); > return -1; > @@ -1970,17 +1967,12 @@ validate_ldpc_enc_op(struct rte_bbdev_enc_op *op, struct acc_queue *q) > rte_bbdev_log(ERR, "Invalid output pointer"); > return -1; > } > - if (ldpc_enc->input.length > > - RTE_BBDEV_LDPC_MAX_CB_SIZE >> 3) { > - rte_bbdev_log(ERR, "CB size (%u) is too big, max: %d", > - ldpc_enc->input.length, > - RTE_BBDEV_LDPC_MAX_CB_SIZE); > + if (ldpc_enc->input.length == 0) { > + rte_bbdev_log(ERR, "CB size (%u) is null", ldpc_enc->input.length); > return -1; > } > if ((ldpc_enc->basegraph > 2) || (ldpc_enc->basegraph == 0)) { > - rte_bbdev_log(ERR, > - "BG (%u) is out of range 1 <= value <= 2", > - ldpc_enc->basegraph); > + rte_bbdev_log(ERR, "BG (%u) is out of range 1 <= value <= 2", ldpc_enc->basegraph); > return -1; > } > if (ldpc_enc->rv_index > 3) { > @@ -1995,13 +1987,89 @@ validate_ldpc_enc_op(struct rte_bbdev_enc_op *op, struct acc_queue *q) > ldpc_enc->code_block_mode); > return -1; > } > - int K = (ldpc_enc->basegraph == 1 ? 22 : 10) * ldpc_enc->z_c; > - if (ldpc_enc->n_filler >= K) { > - rte_bbdev_log(ERR, > - "K and F are not compatible %u %u", > - K, ldpc_enc->n_filler); > + if (ldpc_enc->z_c > ACC_MAX_ZC) { > + rte_bbdev_log(ERR, "Zc (%u) is out of range", ldpc_enc->z_c); > + return -1; > + } > + > + K = (ldpc_enc->basegraph == 1 ? 22 : 10) * ldpc_enc->z_c; > + N = (ldpc_enc->basegraph == 1 ? ACC_N_ZC_1 : ACC_N_ZC_2) * ldpc_enc->z_c; > + q_m = ldpc_enc->q_m; > + crc24 = 0; > + > + if (check_bit(op->ldpc_enc.op_flags, > + RTE_BBDEV_LDPC_CRC_24A_ATTACH) || > + check_bit(op->ldpc_enc.op_flags, > + RTE_BBDEV_LDPC_CRC_24B_ATTACH)) > + crc24 = 24; > + if ((K - ldpc_enc->n_filler) % 8 > 0) { > + rte_bbdev_log(ERR, "K - F not byte aligned %u", K - ldpc_enc->n_filler); > + return -1; > + } > + if (ldpc_enc->n_filler > (K - 2 * ldpc_enc->z_c)) { > + rte_bbdev_log(ERR, "K - F invalid %u %u", K, ldpc_enc->n_filler); > + return -1; > + } > + if ((ldpc_enc->n_cb > N) || (ldpc_enc->n_cb <= K)) { > + rte_bbdev_log(ERR, "Ncb (%u) is out of range K %d N %d", ldpc_enc->n_cb, K, N); > return -1; > } > + if (!check_bit(op->ldpc_enc.op_flags, > + RTE_BBDEV_LDPC_INTERLEAVER_BYPASS) && > + ((q_m == 0) || ((q_m > 2) && ((q_m % 2) == 1)) > + || (q_m > 8))) { > + rte_bbdev_log(ERR, "Qm (%u) is out of range", ldpc_enc->q_m); > + return -1; > + } > + if (ldpc_enc->code_block_mode == RTE_BBDEV_CODE_BLOCK) { > + if (ldpc_enc->cb_params.e == 0) { > + rte_bbdev_log(ERR, "E is null"); > + return -1; > + } > + if (q_m > 0) { > + if (ldpc_enc->cb_params.e % q_m > 0) { > + rte_bbdev_log(ERR, "E not multiple of qm %d", q_m); > + return -1; > + } > + } > + if ((ldpc_enc->z_c <= 11) && (ldpc_enc->cb_params.e > 3456)) { > + rte_bbdev_log(ERR, "E too large for small block"); > + return -1; > + } > + if (ldpc_enc->input.length > > + RTE_BBDEV_LDPC_MAX_CB_SIZE >> 3) { > + rte_bbdev_log(ERR, "CB size (%u) is too big, max: %d", > + ldpc_enc->input.length, > + RTE_BBDEV_LDPC_MAX_CB_SIZE); > + return -1; Indentation? > + } > + if (K < (int) (ldpc_enc->input.length * 8 + ldpc_enc->n_filler) + crc24) { > + rte_bbdev_log(ERR, > + "K and F not matching input size %u %u %u", > + K, ldpc_enc->n_filler, > + ldpc_enc->input.length); > + return -1; > + } > + } else { > + if ((ldpc_enc->tb_params.c == 0) || > + (ldpc_enc->tb_params.ea == 0) || > + (ldpc_enc->tb_params.eb == 0)) { > + rte_bbdev_log(ERR, "TB parameter is null"); > + return -1; > + } > + if (q_m > 0) { > + if ((ldpc_enc->tb_params.ea % q_m > 0) || > + (ldpc_enc->tb_params.eb % q_m > 0)) { > + rte_bbdev_log(ERR, "E not multiple of qm %d", q_m); > + return -1; > + } > + } > + if ((ldpc_enc->z_c <= 11) && (RTE_MAX(ldpc_enc->tb_params.ea, > + ldpc_enc->tb_params.eb) > 3456)) { > + rte_bbdev_log(ERR, "E too large for small block"); > + return -1; > + } > + } > return 0; > } > > @@ -2010,24 +2078,30 @@ static inline int > validate_ldpc_dec_op(struct rte_bbdev_dec_op *op, struct acc_queue *q) > { > struct rte_bbdev_op_ldpc_dec *ldpc_dec = &op->ldpc_dec; > + int K, N, q_m; > + uint32_t min_harq_input; > > if (!validate_op_required(q)) > return 0; > > - if (op->mempool == NULL) { > - rte_bbdev_log(ERR, "Invalid mempool pointer"); > + if (ldpc_dec->input.data == NULL) { > + rte_bbdev_log(ERR, "Invalid input pointer"); > + return -1; > + } > + if (ldpc_dec->hard_output.data == NULL) { > + rte_bbdev_log(ERR, "Invalid output pointer"); > + return -1; > + } > + if (ldpc_dec->input.length == 0) { > + rte_bbdev_log(ERR, "input is null"); > return -1; > } > if ((ldpc_dec->basegraph > 2) || (ldpc_dec->basegraph == 0)) { > - rte_bbdev_log(ERR, > - "BG (%u) is out of range 1 <= value <= 2", > - ldpc_dec->basegraph); > + rte_bbdev_log(ERR, "BG (%u) is out of range 1 <= value <= 2", ldpc_dec->basegraph); > return -1; > } > if (ldpc_dec->iter_max == 0) { > - rte_bbdev_log(ERR, > - "iter_max (%u) is equal to 0", > - ldpc_dec->iter_max); > + rte_bbdev_log(ERR, "iter_max (%u) is equal to 0", ldpc_dec->iter_max); > return -1; > } > if (ldpc_dec->rv_index > 3) { > @@ -2042,13 +2116,162 @@ validate_ldpc_dec_op(struct rte_bbdev_dec_op *op, struct acc_queue *q) > ldpc_dec->code_block_mode); > return -1; > } > - int K = (ldpc_dec->basegraph == 1 ? 22 : 10) * ldpc_dec->z_c; > - if (ldpc_dec->n_filler >= K) { > - rte_bbdev_log(ERR, > - "K and F are not compatible %u %u", > - K, ldpc_dec->n_filler); > + /* Check Zc is valid value. */ > + if ((ldpc_dec->z_c > ACC_MAX_ZC) || (ldpc_dec->z_c < 2)) { > + rte_bbdev_log(ERR, "Zc (%u) is out of range", ldpc_dec->z_c); > + return -1; > + } > + if (ldpc_dec->z_c > 256) { > + if ((ldpc_dec->z_c % 32) != 0) { > + rte_bbdev_log(ERR, "Invalid Zc %d", ldpc_dec->z_c); > + return -1; > + } > + } else if (ldpc_dec->z_c > 128) { > + if ((ldpc_dec->z_c % 16) != 0) { > + rte_bbdev_log(ERR, "Invalid Zc %d", ldpc_dec->z_c); > + return -1; > + } > + } else if (ldpc_dec->z_c > 64) { > + if ((ldpc_dec->z_c % 8) != 0) { > + rte_bbdev_log(ERR, "Invalid Zc %d", ldpc_dec->z_c); > + return -1; > + } > + } else if (ldpc_dec->z_c > 32) { > + if ((ldpc_dec->z_c % 4) != 0) { > + rte_bbdev_log(ERR, "Invalid Zc %d", ldpc_dec->z_c); > + return -1; > + } > + } else if (ldpc_dec->z_c > 16) { > + if ((ldpc_dec->z_c % 2) != 0) { > + rte_bbdev_log(ERR, "Invalid Zc %d", ldpc_dec->z_c); > + return -1; > + } > + } > + > + K = (ldpc_dec->basegraph == 1 ? 22 : 10) * ldpc_dec->z_c; > + N = (ldpc_dec->basegraph == 1 ? ACC_N_ZC_1 : ACC_N_ZC_2) * ldpc_dec->z_c; > + q_m = ldpc_dec->q_m; > + > + if (ldpc_dec->n_filler >= K - 2 * ldpc_dec->z_c) { > + rte_bbdev_log(ERR, "K and F are not compatible %u %u", K, ldpc_dec->n_filler); > + return -1; > + } > + if ((ldpc_dec->n_cb > N) || (ldpc_dec->n_cb <= K)) { > + rte_bbdev_log(ERR, "Ncb (%u) is out of range K %d N %d", ldpc_dec->n_cb, K, N); > + return -1; > + } > + if (((q_m == 0) || ((q_m > 2) && ((q_m % 2) == 1)) > + || (q_m > 8))) { > + rte_bbdev_log(ERR, "Qm (%u) is out of range", ldpc_dec->q_m); > + return -1; > + } > + if (ldpc_dec->code_block_mode == RTE_BBDEV_CODE_BLOCK) { > + if (ldpc_dec->cb_params.e == 0) { > + rte_bbdev_log(ERR, "E is null"); > + return -1; > + } > + if (ldpc_dec->cb_params.e % q_m > 0) { > + rte_bbdev_log(ERR, "E not multiple of qm %d", q_m); > + return -1; > + } > + if (ldpc_dec->cb_params.e > 512 * ldpc_dec->z_c) { > + rte_bbdev_log(ERR, "E too high"); > + return -1; > + } > + } else { > + if ((ldpc_dec->tb_params.c == 0) || > + (ldpc_dec->tb_params.ea == 0) || > + (ldpc_dec->tb_params.eb == 0)) { > + rte_bbdev_log(ERR, "TB parameter is null"); > + return -1; > + } > + if ((ldpc_dec->tb_params.ea % q_m > 0) || > + (ldpc_dec->tb_params.eb % q_m > 0)) { > + rte_bbdev_log(ERR, "E not multiple of qm %d", q_m); > + return -1; > + } > + if ((ldpc_dec->tb_params.ea > 512 * ldpc_dec->z_c) || > + (ldpc_dec->tb_params.eb > 512 * ldpc_dec->z_c)) { > + rte_bbdev_log(ERR, "E too high"); > + return -1; > + } > + } > + if (check_bit(op->ldpc_dec.op_flags, RTE_BBDEV_LDPC_DECODE_BYPASS)) { > + rte_bbdev_log(ERR, "Avoid LDPC Decode bypass"); > + return -1; > + } > + > + /* Avoid HARQ compression for small block size */ > + if ((check_bit(op->ldpc_dec.op_flags, RTE_BBDEV_LDPC_HARQ_6BIT_COMPRESSION)) && (K < 2048)) > + op->ldpc_dec.op_flags ^= RTE_BBDEV_LDPC_HARQ_6BIT_COMPRESSION; > + > + min_harq_input = check_bit(op->ldpc_dec.op_flags, > + RTE_BBDEV_LDPC_HARQ_6BIT_COMPRESSION) ? 256 : 64; > + if (check_bit(op->ldpc_dec.op_flags, > + RTE_BBDEV_LDPC_HQ_COMBINE_IN_ENABLE) && > + ldpc_dec->harq_combined_input.length < > + min_harq_input) { > + rte_bbdev_log(ERR, "HARQ input size is too small %d < %d", > + ldpc_dec->harq_combined_input.length, > + min_harq_input); > return -1; > } > + > + /* Enforce in-range HARQ input size */ > + if (check_bit(op->ldpc_dec.op_flags, RTE_BBDEV_LDPC_HQ_COMBINE_IN_ENABLE)) { > + uint32_t max_harq_input = RTE_ALIGN_CEIL(ldpc_dec->n_cb - ldpc_dec->n_filler, 64); > + > + if (check_bit(op->ldpc_dec.op_flags, RTE_BBDEV_LDPC_HARQ_6BIT_COMPRESSION)) > + max_harq_input = max_harq_input * 3 / 4; > + > + if (ldpc_dec->harq_combined_input.length > max_harq_input) { > + rte_bbdev_log(ERR, > + "HARQ input size out of range %d > %d, Ncb %d F %d K %d N %d", > + ldpc_dec->harq_combined_input.length, > + max_harq_input, ldpc_dec->n_cb, > + ldpc_dec->n_filler, K, N); > + /* Fallback to flush HARQ combine */ > + ldpc_dec->harq_combined_input.length = 0; > + > + if (check_bit(op->ldpc_dec.op_flags, RTE_BBDEV_LDPC_HQ_COMBINE_IN_ENABLE)) > + op->ldpc_dec.op_flags ^= RTE_BBDEV_LDPC_HQ_COMBINE_IN_ENABLE; > + } > + } > + > +#ifdef ACC100_EXT_MEM Same comment as RTE_LIBRTE_SKIP_VALIDATE, ACC100_EXT_MEM should be replaced with a devarg. Can be done in next release. > + /* Enforce in-range HARQ offset */ > + if (check_bit(op->ldpc_dec.op_flags, RTE_BBDEV_LDPC_HQ_COMBINE_IN_ENABLE)) { > + if ((op->ldpc_dec.harq_combined_input.offset >> 10) >= q->d->ddr_size) { > + rte_bbdev_log(ERR, > + "HARQin offset out of range %d > %d", > + op->ldpc_dec.harq_combined_input.offset, > + q->d->ddr_size); > + return -1; > + } > + if ((op->ldpc_dec.harq_combined_input.offset & 0x3FF) > 0) { > + rte_bbdev_log(ERR, > + "HARQin offset not aligned on 1kB %d", > + op->ldpc_dec.harq_combined_input.offset); > + return -1; > + } > + } > + if (check_bit(op->ldpc_dec.op_flags, RTE_BBDEV_LDPC_HQ_COMBINE_OUT_ENABLE)) { > + if ((op->ldpc_dec.harq_combined_output.offset >> 10) >= q->d->ddr_size) { > + rte_bbdev_log(ERR, > + "HARQout offset out of range %d > %d", > + op->ldpc_dec.harq_combined_output.offset, > + q->d->ddr_size); > + return -1; > + } > + if ((op->ldpc_dec.harq_combined_output.offset & 0x3FF) > 0) { > + rte_bbdev_log(ERR, > + "HARQout offset not aligned on 1kB %d", > + op->ldpc_dec.harq_combined_output.offset); > + return -1; > + } > + } > +#endif > + > return 0; > } > #endif > @@ -2686,7 +2909,7 @@ harq_loopback(struct acc_queue *q, struct rte_bbdev_dec_op *op, > memset(fcw, 0, sizeof(struct acc_fcw_ld)); > fcw->FCWversion = ACC_FCW_VER; > fcw->qm = 2; > - fcw->Zc = 384; > + fcw->Zc = ACC_MAX_ZC; > if (harq_in_length < 16 * ACC_N_ZC_1) > fcw->Zc = 16; > fcw->ncb = fcw->Zc * ACC_N_ZC_1; Reviewed-by: Maxime Coquelin Thanks, Maxime