From: "André Przywara" <andre.przywara@arm.com>
To: Leo Yan <leo.yan@linaro.org>,
Arnaldo Carvalho de Melo <acme@kernel.org>,
Dave Martin <Dave.Martin@arm.com>,
James Clark <james.clark@arm.com>,
Peter Zijlstra <peterz@infradead.org>,
Ingo Molnar <mingo@redhat.com>,
Mark Rutland <mark.rutland@arm.com>,
Alexander Shishkin <alexander.shishkin@linux.intel.com>,
Jiri Olsa <jolsa@redhat.com>, Namhyung Kim <namhyung@kernel.org>,
Al Grant <Al.Grant@arm.com>, Wei Li <liwei391@huawei.com>,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH v7 06/22] perf arm-spe: Refactor printing string to buffer
Date: Mon, 9 Nov 2020 12:58:34 +0000 [thread overview]
Message-ID: <b7484681-9250-6fbc-63ab-ab19c8d1e990@arm.com> (raw)
In-Reply-To: <20201106014136.14103-7-leo.yan@linaro.org>
On 06/11/2020 01:41, Leo Yan wrote:
> When outputs strings to the decoding buffer with function snprintf(),
> SPE decoder needs to detects if any error returns from snprintf() and if
> so needs to directly bail out. If snprintf() returns success, it needs
> to update buffer pointer and reduce the buffer length so can continue to
> output the next string into the consequent memory space.
>
> This complex logics are spreading in the function arm_spe_pkt_desc() so
> there has many duplicate codes for handling error detecting, increment
> buffer pointer and decrement buffer size.
>
> To avoid the duplicate code, this patch introduces a new helper function
> arm_spe_pkt_snprintf() which is used to wrap up the complex logics, and
> it's used by the caller arm_spe_pkt_desc().
>
> This patch also moves the variable 'blen' as the function's local
> variable, this allows to remove the unnecessary braces and improve the
> readability.
>
> Suggested-by: Dave Martin <Dave.Martin@arm.com>
> Signed-off-by: Leo Yan <leo.yan@linaro.org>
Well, I am not sure this is particularly easier to review ;-), but here
we go:
Checked - vs. + in an editor to verify the transformation.
I also put the new printf routine into some very simple test program,
and it seems to work as advertised: buffer overflows are detected, and
the string never gets bigger or loses the terminating 0.
So that looks alright to me:
Reviewed-by: Andre Przywara <andre.przywara@arm.com>
Cheers,
Andre
> ---
> .../arm-spe-decoder/arm-spe-pkt-decoder.c | 260 +++++++++---------
> 1 file changed, 126 insertions(+), 134 deletions(-)
>
> diff --git a/tools/perf/util/arm-spe-decoder/arm-spe-pkt-decoder.c b/tools/perf/util/arm-spe-decoder/arm-spe-pkt-decoder.c
> index 04fd7fd7c15f..1970686f7020 100644
> --- a/tools/perf/util/arm-spe-decoder/arm-spe-pkt-decoder.c
> +++ b/tools/perf/util/arm-spe-decoder/arm-spe-pkt-decoder.c
> @@ -9,6 +9,7 @@
> #include <endian.h>
> #include <byteswap.h>
> #include <linux/bitops.h>
> +#include <stdarg.h>
>
> #include "arm-spe-pkt-decoder.h"
>
> @@ -258,192 +259,183 @@ int arm_spe_get_packet(const unsigned char *buf, size_t len,
> return ret;
> }
>
> +static int arm_spe_pkt_snprintf(int *err, char **buf_p, size_t *blen,
> + const char *fmt, ...)
> +{
> + va_list ap;
> + int ret;
> +
> + /* Bail out if any error occurred */
> + if (err && *err)
> + return *err;
> +
> + va_start(ap, fmt);
> + ret = vsnprintf(*buf_p, *blen, fmt, ap);
> + va_end(ap);
> +
> + if (ret < 0) {
> + if (err && !*err)
> + *err = ret;
> +
> + /*
> + * A return value of (*blen - 1) or more means that the
> + * output was truncated and the buffer is overrun.
> + */
> + } else if (ret >= ((int)*blen - 1)) {
> + (*buf_p)[*blen - 1] = '\0';
> +
> + /*
> + * Set *err to 'ret' to avoid overflow if tries to
> + * fill this buffer sequentially.
> + */
> + if (err && !*err)
> + *err = ret;
> + } else {
> + *buf_p += ret;
> + *blen -= ret;
> + }
> +
> + return ret;
> +}
> +
> int arm_spe_pkt_desc(const struct arm_spe_pkt *packet, char *buf,
> size_t buf_len)
> {
> int ret, ns, el, idx = packet->index;
> unsigned long long payload = packet->payload;
> const char *name = arm_spe_pkt_name(packet->type);
> + size_t blen = buf_len;
> + int err = 0;
>
> switch (packet->type) {
> case ARM_SPE_BAD:
> case ARM_SPE_PAD:
> case ARM_SPE_END:
> - return snprintf(buf, buf_len, "%s", name);
> - case ARM_SPE_EVENTS: {
> - size_t blen = buf_len;
> -
> - ret = 0;
> - ret = snprintf(buf, buf_len, "EV");
> - buf += ret;
> - blen -= ret;
> - if (payload & 0x1) {
> - ret = snprintf(buf, buf_len, " EXCEPTION-GEN");
> - buf += ret;
> - blen -= ret;
> - }
> - if (payload & 0x2) {
> - ret = snprintf(buf, buf_len, " RETIRED");
> - buf += ret;
> - blen -= ret;
> - }
> - if (payload & 0x4) {
> - ret = snprintf(buf, buf_len, " L1D-ACCESS");
> - buf += ret;
> - blen -= ret;
> - }
> - if (payload & 0x8) {
> - ret = snprintf(buf, buf_len, " L1D-REFILL");
> - buf += ret;
> - blen -= ret;
> - }
> - if (payload & 0x10) {
> - ret = snprintf(buf, buf_len, " TLB-ACCESS");
> - buf += ret;
> - blen -= ret;
> - }
> - if (payload & 0x20) {
> - ret = snprintf(buf, buf_len, " TLB-REFILL");
> - buf += ret;
> - blen -= ret;
> - }
> - if (payload & 0x40) {
> - ret = snprintf(buf, buf_len, " NOT-TAKEN");
> - buf += ret;
> - blen -= ret;
> - }
> - if (payload & 0x80) {
> - ret = snprintf(buf, buf_len, " MISPRED");
> - buf += ret;
> - blen -= ret;
> - }
> + return arm_spe_pkt_snprintf(&err, &buf, &blen, "%s", name);
> + case ARM_SPE_EVENTS:
> + ret = arm_spe_pkt_snprintf(&err, &buf, &blen, "EV");
> +
> + if (payload & 0x1)
> + ret = arm_spe_pkt_snprintf(&err, &buf, &blen, " EXCEPTION-GEN");
> + if (payload & 0x2)
> + ret = arm_spe_pkt_snprintf(&err, &buf, &blen, " RETIRED");
> + if (payload & 0x4)
> + ret = arm_spe_pkt_snprintf(&err, &buf, &blen, " L1D-ACCESS");
> + if (payload & 0x8)
> + ret = arm_spe_pkt_snprintf(&err, &buf, &blen, " L1D-REFILL");
> + if (payload & 0x10)
> + ret = arm_spe_pkt_snprintf(&err, &buf, &blen, " TLB-ACCESS");
> + if (payload & 0x20)
> + ret = arm_spe_pkt_snprintf(&err, &buf, &blen, " TLB-REFILL");
> + if (payload & 0x40)
> + ret = arm_spe_pkt_snprintf(&err, &buf, &blen, " NOT-TAKEN");
> + if (payload & 0x80)
> + ret = arm_spe_pkt_snprintf(&err, &buf, &blen, " MISPRED");
> if (idx > 1) {
> - if (payload & 0x100) {
> - ret = snprintf(buf, buf_len, " LLC-ACCESS");
> - buf += ret;
> - blen -= ret;
> - }
> - if (payload & 0x200) {
> - ret = snprintf(buf, buf_len, " LLC-REFILL");
> - buf += ret;
> - blen -= ret;
> - }
> - if (payload & 0x400) {
> - ret = snprintf(buf, buf_len, " REMOTE-ACCESS");
> - buf += ret;
> - blen -= ret;
> - }
> + if (payload & 0x100)
> + ret = arm_spe_pkt_snprintf(&err, &buf, &blen, " LLC-ACCESS");
> + if (payload & 0x200)
> + ret = arm_spe_pkt_snprintf(&err, &buf, &blen, " LLC-REFILL");
> + if (payload & 0x400)
> + ret = arm_spe_pkt_snprintf(&err, &buf, &blen, " REMOTE-ACCESS");
> }
> if (ret < 0)
> return ret;
> blen -= ret;
> return buf_len - blen;
> - }
> case ARM_SPE_OP_TYPE:
> switch (idx) {
> - case 0: return snprintf(buf, buf_len, "%s", payload & 0x1 ?
> - "COND-SELECT" : "INSN-OTHER");
> - case 1: {
> - size_t blen = buf_len;
> + case 0:
> + return arm_spe_pkt_snprintf(&err, &buf, &blen,
> + payload & 0x1 ? "COND-SELECT" : "INSN-OTHER");
> + case 1:
> + ret = arm_spe_pkt_snprintf(&err, &buf, &blen,
> + payload & 0x1 ? "ST" : "LD");
>
> - if (payload & 0x1)
> - ret = snprintf(buf, buf_len, "ST");
> - else
> - ret = snprintf(buf, buf_len, "LD");
> - buf += ret;
> - blen -= ret;
> if (payload & 0x2) {
> - if (payload & 0x4) {
> - ret = snprintf(buf, buf_len, " AT");
> - buf += ret;
> - blen -= ret;
> - }
> - if (payload & 0x8) {
> - ret = snprintf(buf, buf_len, " EXCL");
> - buf += ret;
> - blen -= ret;
> - }
> - if (payload & 0x10) {
> - ret = snprintf(buf, buf_len, " AR");
> - buf += ret;
> - blen -= ret;
> - }
> + if (payload & 0x4)
> + ret = arm_spe_pkt_snprintf(&err, &buf, &blen, " AT");
> + if (payload & 0x8)
> + ret = arm_spe_pkt_snprintf(&err, &buf, &blen, " EXCL");
> + if (payload & 0x10)
> + ret = arm_spe_pkt_snprintf(&err, &buf, &blen, " AR");
> } else if (payload & 0x4) {
> - ret = snprintf(buf, buf_len, " SIMD-FP");
> - buf += ret;
> - blen -= ret;
> + ret = arm_spe_pkt_snprintf(&err, &buf, &blen, " SIMD-FP");
> }
> +
> if (ret < 0)
> return ret;
> blen -= ret;
> return buf_len - blen;
> - }
> - case 2: {
> - size_t blen = buf_len;
>
> - ret = snprintf(buf, buf_len, "B");
> - buf += ret;
> - blen -= ret;
> - if (payload & 0x1) {
> - ret = snprintf(buf, buf_len, " COND");
> - buf += ret;
> - blen -= ret;
> - }
> - if (payload & 0x2) {
> - ret = snprintf(buf, buf_len, " IND");
> - buf += ret;
> - blen -= ret;
> - }
> + case 2:
> + ret = arm_spe_pkt_snprintf(&err, &buf, &blen, "B");
> +
> + if (payload & 0x1)
> + ret = arm_spe_pkt_snprintf(&err, &buf, &blen, " COND");
> + if (payload & 0x2)
> + ret = arm_spe_pkt_snprintf(&err, &buf, &blen, " IND");
> +
> if (ret < 0)
> return ret;
> blen -= ret;
> return buf_len - blen;
> - }
> - default: return 0;
> +
> + default:
> + return 0;
> }
> case ARM_SPE_DATA_SOURCE:
> case ARM_SPE_TIMESTAMP:
> - return snprintf(buf, buf_len, "%s %lld", name, payload);
> + return arm_spe_pkt_snprintf(&err, &buf, &blen, "%s %lld", name, payload);
> case ARM_SPE_ADDRESS:
> switch (idx) {
> case 0:
> - case 1: ns = !!(packet->payload & NS_FLAG);
> + case 1:
> + ns = !!(packet->payload & NS_FLAG);
> el = (packet->payload & EL_FLAG) >> 61;
> payload &= ~(0xffULL << 56);
> - return snprintf(buf, buf_len, "%s 0x%llx el%d ns=%d",
> + return arm_spe_pkt_snprintf(&err, &buf, &blen,
> + "%s 0x%llx el%d ns=%d",
> (idx == 1) ? "TGT" : "PC", payload, el, ns);
> - case 2: return snprintf(buf, buf_len, "VA 0x%llx", payload);
> - case 3: ns = !!(packet->payload & NS_FLAG);
> + case 2:
> + return arm_spe_pkt_snprintf(&err, &buf, &blen,
> + "VA 0x%llx", payload);
> + case 3:
> + ns = !!(packet->payload & NS_FLAG);
> payload &= ~(0xffULL << 56);
> - return snprintf(buf, buf_len, "PA 0x%llx ns=%d",
> - payload, ns);
> - default: return 0;
> + return arm_spe_pkt_snprintf(&err, &buf, &blen,
> + "PA 0x%llx ns=%d", payload, ns);
> + default:
> + return 0;
> }
> case ARM_SPE_CONTEXT:
> - return snprintf(buf, buf_len, "%s 0x%lx el%d", name,
> - (unsigned long)payload, idx + 1);
> - case ARM_SPE_COUNTER: {
> - size_t blen = buf_len;
> -
> - ret = snprintf(buf, buf_len, "%s %d ", name,
> - (unsigned short)payload);
> - buf += ret;
> - blen -= ret;
> + return arm_spe_pkt_snprintf(&err, &buf, &blen, "%s 0x%lx el%d",
> + name, (unsigned long)payload, idx + 1);
> + case ARM_SPE_COUNTER:
> + ret = arm_spe_pkt_snprintf(&err, &buf, &blen, "%s %d ", name,
> + (unsigned short)payload);
> switch (idx) {
> - case 0: ret = snprintf(buf, buf_len, "TOT"); break;
> - case 1: ret = snprintf(buf, buf_len, "ISSUE"); break;
> - case 2: ret = snprintf(buf, buf_len, "XLAT"); break;
> - default: ret = 0;
> + case 0:
> + ret = arm_spe_pkt_snprintf(&err, &buf, &blen, "TOT");
> + break;
> + case 1:
> + ret = arm_spe_pkt_snprintf(&err, &buf, &blen, "ISSUE");
> + break;
> + case 2:
> + ret = arm_spe_pkt_snprintf(&err, &buf, &blen, "XLAT");
> + break;
> + default:
> + ret = 0;
> + break;
> }
> if (ret < 0)
> return ret;
> blen -= ret;
> return buf_len - blen;
> - }
> default:
> break;
> }
>
> - return snprintf(buf, buf_len, "%s 0x%llx (%d)",
> - name, payload, packet->index);
> + return arm_spe_pkt_snprintf(&err, &buf, &blen, "%s 0x%llx (%d)",
> + name, payload, packet->index);
> }
>
next prev parent reply other threads:[~2020-11-09 13:45 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-11-06 1:41 [PATCH v7 00/22] perf arm-spe: Refactor decoding & dumping flow Leo Yan
2020-11-06 1:41 ` [PATCH v7 01/22] perf arm-spe: Include bitops.h for BIT() macro Leo Yan
2020-11-06 1:41 ` [PATCH v7 02/22] perf arm-spe: Fix a typo in comment Leo Yan
2020-11-06 1:41 ` [PATCH v7 03/22] perf arm-spe: Refactor payload size calculation Leo Yan
2020-11-06 1:41 ` [PATCH v7 04/22] perf arm-spe: Refactor arm_spe_get_events() Leo Yan
2020-11-06 1:41 ` [PATCH v7 05/22] perf arm-spe: Fix packet length handling Leo Yan
2020-11-06 1:41 ` [PATCH v7 06/22] perf arm-spe: Refactor printing string to buffer Leo Yan
2020-11-09 12:58 ` André Przywara [this message]
2020-11-06 1:41 ` [PATCH v7 07/22] perf arm-spe: Consolidate arm_spe_pkt_desc()'s return value Leo Yan
2020-11-09 16:52 ` André Przywara
2020-11-10 10:22 ` Leo Yan
2020-11-06 1:41 ` [PATCH v7 08/22] perf arm-spe: Refactor packet header parsing Leo Yan
2020-11-06 1:41 ` [PATCH v7 09/22] perf arm-spe: Add new function arm_spe_pkt_desc_addr() Leo Yan
2020-11-06 1:41 ` [PATCH v7 10/22] perf arm-spe: Refactor address packet handling Leo Yan
2020-11-06 1:41 ` [PATCH v7 11/22] perf arm_spe: Fixup top byte for data virtual address Leo Yan
2020-11-06 1:41 ` [PATCH v7 12/22] perf arm-spe: Refactor context packet handling Leo Yan
2020-11-06 1:41 ` [PATCH v7 13/22] perf arm-spe: Add new function arm_spe_pkt_desc_counter() Leo Yan
2020-11-06 1:41 ` [PATCH v7 14/22] perf arm-spe: Refactor counter packet handling Leo Yan
2020-11-06 1:41 ` [PATCH v7 15/22] perf arm-spe: Add new function arm_spe_pkt_desc_event() Leo Yan
2020-11-06 1:41 ` [PATCH v7 16/22] perf arm-spe: Refactor event type handling Leo Yan
2020-11-06 1:41 ` [PATCH v7 17/22] perf arm-spe: Remove size condition checking for events Leo Yan
2020-11-06 1:41 ` [PATCH v7 18/22] perf arm-spe: Add new function arm_spe_pkt_desc_op_type() Leo Yan
2020-11-06 1:41 ` [PATCH v7 19/22] perf arm-spe: Refactor operation packet handling Leo Yan
2020-11-06 1:41 ` [PATCH v7 20/22] perf arm-spe: Add more sub classes for operation packet Leo Yan
2020-11-06 1:41 ` [PATCH v7 21/22] perf arm_spe: Decode memory tagging properties Leo Yan
2020-11-06 1:41 ` [PATCH v7 22/22] perf arm-spe: Add support for ARMv8.3-SPE Leo Yan
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=b7484681-9250-6fbc-63ab-ab19c8d1e990@arm.com \
--to=andre.przywara@arm.com \
--cc=Al.Grant@arm.com \
--cc=Dave.Martin@arm.com \
--cc=acme@kernel.org \
--cc=alexander.shishkin@linux.intel.com \
--cc=james.clark@arm.com \
--cc=jolsa@redhat.com \
--cc=leo.yan@linaro.org \
--cc=linux-kernel@vger.kernel.org \
--cc=liwei391@huawei.com \
--cc=mark.rutland@arm.com \
--cc=mingo@redhat.com \
--cc=namhyung@kernel.org \
--cc=peterz@infradead.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).