From patchwork Tue Jan 23 08:09:12 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Manos Pitsidianakis X-Patchwork-Id: 13526939 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 397A0C47258 for ; Tue, 23 Jan 2024 08:10:20 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rSBqb-0001Ox-Ah; Tue, 23 Jan 2024 03:09:29 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rSBqY-0001Nu-Bc for qemu-devel@nongnu.org; Tue, 23 Jan 2024 03:09:26 -0500 Received: from mail-ed1-x52c.google.com ([2a00:1450:4864:20::52c]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1rSBqS-0006mg-4M for qemu-devel@nongnu.org; Tue, 23 Jan 2024 03:09:22 -0500 Received: by mail-ed1-x52c.google.com with SMTP id 4fb4d7f45d1cf-558f523c072so4647127a12.2 for ; Tue, 23 Jan 2024 00:09:19 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1705997358; x=1706602158; darn=nongnu.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=HkmrsuVbgTF+za7ZMeDRDBZqRcm/2ztx9jMk1UJC/m8=; b=UiYaIKIB4tO52m8T1dfwXppozp/PGOyvgrNI2fRTrbGHyaSlPRlBikyKQnBAwTLgjg MEVrXE46HgxQMOpL+5HY2coSeeVJKFESuwOp6IDFedEDgs5Id1lAf7f4WkuxR9HnT/Bb MnDNZMNMKQ5qBJfzyxCjqgA/WP+Xc2FnorWTnkRyVUr174oL++4/yWoFFv+uJveTkSjv boIx+79L+YREW1Pcys21HoPcZ99qVn0rC52NYU1dfsStRMM4mA3hQEjiVIlWS5lvNUGV MVHsEUCPagnv9S1uHxlnIT9+Xc0aS2FHL/GNkZzJ0ybGE245AXp5EoY3xXQtVefPJD4n P2Tg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1705997358; x=1706602158; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=HkmrsuVbgTF+za7ZMeDRDBZqRcm/2ztx9jMk1UJC/m8=; b=rd0plafXzfZwH5H2re+AolCP//yeN4vP+w8QKesDgkOrjEWhL26YU2/n1mT0qRM5gm YkUS0N+HBMqn8yJwzy+K0xIAP7OQW1mXtzPWqyaEidFAlA4uvk1+qH834+UBTQO1wvC3 FAQQV8COH/nOnQ6OKRz4+Tu47R7vU2tP7NFWmtjVrpQytBoQnOnfQWVYb2WXQc4W4aI0 EcFZQbNvMmNC2QJ6WhbikyKFHJTSv6W8qsya4vrdNvAkhQKdoGg7ESBOEl+MswptycNW yYWnbHxB2gEIQxFaF/AxQPyijXiJysacQmTd5GCGwwCOgoeKTD/6MzjvT92bjcVGRlHi UjVg== X-Gm-Message-State: AOJu0Yxs0muL/s6p8g01QHXVp9NbXGfVhNpT9jFYlAevs33xL8JiQ1B1 Fim5RerOAexwt4AweCFnXvUtVUrEzFaNKZ1egXdZC35c3HMDS8XJUvO8DrW6EbJKg9MvwBFXpCL T/Ls= X-Google-Smtp-Source: AGHT+IGwNQnyGLhF25UbZLdaMt0Q9/tAZqtdtfe62R9H1jtMGBD9Yz8EMeq5zFQ5sRmxMr5h4qcxHg== X-Received: by 2002:a17:907:6899:b0:a2c:8dba:eb1b with SMTP id qy25-20020a170907689900b00a2c8dbaeb1bmr1588204ejc.112.1705997357765; Tue, 23 Jan 2024 00:09:17 -0800 (PST) Received: from localhost.localdomain (adsl-138.37.6.1.tellas.gr. [37.6.1.138]) by smtp.gmail.com with ESMTPSA id tb21-20020a1709078b9500b00a2f24da8baasm5794069ejc.39.2024.01.23.00.09.16 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 23 Jan 2024 00:09:17 -0800 (PST) From: Manos Pitsidianakis To: qemu-devel@nongnu.org, qemu-block@nongnu.org Cc: Paolo Bonzini , =?utf-8?q?Daniel_P=2E_Berrang=C3=A9?= , Eduardo Habkost Subject: [PATCH 1/2] hw/core/qdev.c: add qdev_get_human_name() Date: Tue, 23 Jan 2024 10:09:12 +0200 Message-Id: <15b15d6d4f2a1706b5e2d85ab18e25bcb03e72c2.1705938003.git.manos.pitsidianakis@linaro.org> X-Mailer: git-send-email 2.39.2 In-Reply-To: References: MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::52c; envelope-from=manos.pitsidianakis@linaro.org; helo=mail-ed1-x52c.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Add a simple method to return some kind of human readable identifier for use in error messages. Signed-off-by: Manos Pitsidianakis --- hw/core/qdev.c | 10 ++++++++++ include/hw/qdev-core.h | 15 +++++++++++++++ 2 files changed, 25 insertions(+) diff --git a/hw/core/qdev.c b/hw/core/qdev.c index 43d863b0c5..499f191826 100644 --- a/hw/core/qdev.c +++ b/hw/core/qdev.c @@ -879,6 +879,16 @@ Object *qdev_get_machine(void) return dev; } +char *qdev_get_human_name(DeviceState *dev) +{ + if (!dev) { + return g_strdup(""); + } + + return dev->id ? + g_strdup(dev->id) : object_get_canonical_path(OBJECT(dev)); +} + static MachineInitPhase machine_phase; bool phase_check(MachineInitPhase phase) diff --git a/include/hw/qdev-core.h b/include/hw/qdev-core.h index 151d968238..a8c742b4a3 100644 --- a/include/hw/qdev-core.h +++ b/include/hw/qdev-core.h @@ -993,6 +993,21 @@ const char *qdev_fw_name(DeviceState *dev); void qdev_assert_realized_properly(void); Object *qdev_get_machine(void); +/** + * qdev_get_human_name() - Return a human-readable name for a device + * @dev: The device + * + * .. note:: + * This function is intended for user friendly error messages. + * + * Returns: A newly allocated string containing the device id if not null, + * else the object canonical path if not null. If @dev is NULL, it returns an + * allocated empty string. + * + * Use g_free() to free it. + */ +char *qdev_get_human_name(DeviceState *dev); + /* FIXME: make this a link<> */ bool qdev_set_parent_bus(DeviceState *dev, BusState *bus, Error **errp); From patchwork Tue Jan 23 08:09:13 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Manos Pitsidianakis X-Patchwork-Id: 13526940 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 55300C47DDC for ; Tue, 23 Jan 2024 08:10:20 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rSBqf-0001PO-Id; Tue, 23 Jan 2024 03:09:33 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rSBqa-0001Oo-P0 for qemu-devel@nongnu.org; Tue, 23 Jan 2024 03:09:28 -0500 Received: from mail-lf1-x12e.google.com ([2a00:1450:4864:20::12e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1rSBqX-0006mq-1P for qemu-devel@nongnu.org; Tue, 23 Jan 2024 03:09:27 -0500 Received: by mail-lf1-x12e.google.com with SMTP id 2adb3069b0e04-5100409e31eso899735e87.1 for ; Tue, 23 Jan 2024 00:09:21 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1705997359; x=1706602159; darn=nongnu.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=F2eJvbF20rYGA/+fjcTQo9Ig7hIhbqVGnNCnWf30Rds=; b=Md7uBqpo2SC07/kr2xe/aZQPjU5N4KstWvTD0Q6OFpy6T89aVNAPBmhUjHc/BeH7uM sOA8q9MKcyk2EuxB1uuAmyAQ7C7txLEBVnApQwG3E4juNGIT+53Ulis0bswXCLrEXCKm VU6lNpTaAUXE/L0oYwhbvxHyboe7SA8lY0xs/+YHotr6uNv8w9kNIazUs6RSHhVTBG6J 5aES0O9VNrkxPnwLvJTb20JWfI3RTNlmo8lraEBb1BBg8ZLIZ0RPyHVyBGUQbM1AdwEC LPa0v+V3/v5DnykMQXuIcCGsr3bgojUy6j+9lqbDRsfwad90t5WxIz11zjXakjVCMSOi A1jw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1705997359; x=1706602159; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=F2eJvbF20rYGA/+fjcTQo9Ig7hIhbqVGnNCnWf30Rds=; b=d1GtSKO2hieEfu/PXEafxO67DM45gL3/xDH/7FqZYpRXT0A+mVgHzycfIo30TZod2T 1CvTlScydHT/4KnJkDor1WQiCdkm8DrqK+TXIFRRKEbnoQaphAWrRDYcIB3/skQFiOYr hoJ5WCb92fs0vAXQ/uEqTGpx16VpvMo5YNAV6Ksjlvv2QmczijI2qAsLKDPeqolYWiHL h8OP6R8xUpAlFloomTNe+upTnzl8Naff/znACkCnTmU7wqCy0Ekke80zaib8xa4ULqTV Y2m1zRwco52DA1OjcMGFqJdYIrfqMvVwNqCkkvN0MR0GegENUfE5qQ8trKl6Ivd4i+Lu gvDg== X-Gm-Message-State: AOJu0YwYqCb9okSQeVNnD2BCIK0ayZllsDr237vQ2RxkeyZ7qt6x2SOt lkL3xCkbARVP+efyuhQVhkr5Mf/WUwjUbddqyMwNJX92drG9Ci6Li72vcbV3fikM2TABPYEzIyL RMJk= X-Google-Smtp-Source: AGHT+IEOEfad0+dUh0oHVFSesdOjEtp8arUOTUCuBrdNjRD6xRFUh6eL57kl3spzF2ZxhGVBF5OjZQ== X-Received: by 2002:a05:6512:1111:b0:50e:8696:1718 with SMTP id l17-20020a056512111100b0050e86961718mr2924778lfg.37.1705997359319; Tue, 23 Jan 2024 00:09:19 -0800 (PST) Received: from localhost.localdomain (adsl-138.37.6.1.tellas.gr. [37.6.1.138]) by smtp.gmail.com with ESMTPSA id tb21-20020a1709078b9500b00a2f24da8baasm5794069ejc.39.2024.01.23.00.09.18 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 23 Jan 2024 00:09:19 -0800 (PST) From: Manos Pitsidianakis To: qemu-devel@nongnu.org, qemu-block@nongnu.org Cc: John Snow , Kevin Wolf , Hanna Reitz , Alistair Francis , =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= Subject: [PATCH 2/2] hw/block/block.c: improve confusing blk_check_size_and_read_all() error Date: Tue, 23 Jan 2024 10:09:13 +0200 Message-Id: X-Mailer: git-send-email 2.39.2 In-Reply-To: References: MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::12e; envelope-from=manos.pitsidianakis@linaro.org; helo=mail-lf1-x12e.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=unavailable autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org In cases where a device tries to read more bytes than the block device contains, the error is vague: "device requires X bytes, block backend provides Y bytes". This patch changes the errors of this function to include the block backend name, the device id and device type name where appropriate. Signed-off-by: Manos Pitsidianakis Reviewed-by: Philippe Mathieu-Daudé --- hw/block/block.c | 25 +++++++++++++++---------- hw/block/m25p80.c | 3 ++- hw/block/pflash_cfi01.c | 4 ++-- hw/block/pflash_cfi02.c | 2 +- include/hw/block/block.h | 4 ++-- 5 files changed, 22 insertions(+), 16 deletions(-) diff --git a/hw/block/block.c b/hw/block/block.c index 9f52ee6e72..624389d62d 100644 --- a/hw/block/block.c +++ b/hw/block/block.c @@ -54,29 +54,30 @@ static int blk_pread_nonzeroes(BlockBackend *blk, hwaddr size, void *buf) * BDRV_REQUEST_MAX_BYTES. * On success, return true. * On failure, store an error through @errp and return false. - * Note that the error messages do not identify the block backend. - * TODO Since callers don't either, this can result in confusing - * errors. + * * This function not intended for actual block devices, which read on * demand. It's for things like memory devices that (ab)use a block * backend to provide persistence. */ -bool blk_check_size_and_read_all(BlockBackend *blk, void *buf, hwaddr size, - Error **errp) +bool blk_check_size_and_read_all(BlockBackend *blk, DeviceState *dev, + void *buf, hwaddr size, Error **errp) { int64_t blk_len; int ret; + g_autofree char *dev_id = NULL; blk_len = blk_getlength(blk); if (blk_len < 0) { error_setg_errno(errp, -blk_len, - "can't get size of block backend"); + "can't get size of %s block backend", blk_name(blk)); return false; } if (blk_len != size) { - error_setg(errp, "device requires %" HWADDR_PRIu " bytes, " - "block backend provides %" PRIu64 " bytes", - size, blk_len); + dev_id = qdev_get_human_name(dev); + error_setg(errp, "%s device with id='%s' requires %" HWADDR_PRIu + " bytes, %s block backend provides %" PRIu64 " bytes", + object_get_typename(OBJECT(dev)), dev_id, size, + blk_name(blk), blk_len); return false; } @@ -89,7 +90,11 @@ bool blk_check_size_and_read_all(BlockBackend *blk, void *buf, hwaddr size, assert(size <= BDRV_REQUEST_MAX_BYTES); ret = blk_pread_nonzeroes(blk, size, buf); if (ret < 0) { - error_setg_errno(errp, -ret, "can't read block backend"); + dev_id = qdev_get_human_name(dev); + error_setg_errno(errp, -ret, "can't read %s block backend" + "for %s device with id='%s'", + blk_name(blk), object_get_typename(OBJECT(dev)), + dev_id); return false; } return true; diff --git a/hw/block/m25p80.c b/hw/block/m25p80.c index 26ce895628..0a12030a3a 100644 --- a/hw/block/m25p80.c +++ b/hw/block/m25p80.c @@ -1617,7 +1617,8 @@ static void m25p80_realize(SSIPeripheral *ss, Error **errp) trace_m25p80_binding(s); s->storage = blk_blockalign(s->blk, s->size); - if (!blk_check_size_and_read_all(s->blk, s->storage, s->size, errp)) { + if (!blk_check_size_and_read_all(s->blk, DEVICE(s), + s->storage, s->size, errp)) { return; } } else { diff --git a/hw/block/pflash_cfi01.c b/hw/block/pflash_cfi01.c index f956f8bcf7..1bda8424b9 100644 --- a/hw/block/pflash_cfi01.c +++ b/hw/block/pflash_cfi01.c @@ -848,8 +848,8 @@ static void pflash_cfi01_realize(DeviceState *dev, Error **errp) } if (pfl->blk) { - if (!blk_check_size_and_read_all(pfl->blk, pfl->storage, total_len, - errp)) { + if (!blk_check_size_and_read_all(pfl->blk, dev, pfl->storage, + total_len, errp)) { vmstate_unregister_ram(&pfl->mem, DEVICE(pfl)); return; } diff --git a/hw/block/pflash_cfi02.c b/hw/block/pflash_cfi02.c index 6fa56f14c0..2314142373 100644 --- a/hw/block/pflash_cfi02.c +++ b/hw/block/pflash_cfi02.c @@ -902,7 +902,7 @@ static void pflash_cfi02_realize(DeviceState *dev, Error **errp) } if (pfl->blk) { - if (!blk_check_size_and_read_all(pfl->blk, pfl->storage, + if (!blk_check_size_and_read_all(pfl->blk, dev, pfl->storage, pfl->chip_len, errp)) { vmstate_unregister_ram(&pfl->orig_mem, DEVICE(pfl)); return; diff --git a/include/hw/block/block.h b/include/hw/block/block.h index 15fff66435..de3946a5f1 100644 --- a/include/hw/block/block.h +++ b/include/hw/block/block.h @@ -88,8 +88,8 @@ static inline unsigned int get_physical_block_exp(BlockConf *conf) /* Backend access helpers */ -bool blk_check_size_and_read_all(BlockBackend *blk, void *buf, hwaddr size, - Error **errp); +bool blk_check_size_and_read_all(BlockBackend *blk, DeviceState *dev, + void *buf, hwaddr size, Error **errp); /* Configuration helpers */