From nobody Tue Nov 26 16:23:22 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1706651587; cv=none; d=zohomail.com; s=zohoarc; b=bSkMj6Uu1J1zYq3IMlFRhNIQuUbf4OrB2UGJJi2AflJ07G3MvHMHElHtUpYgVhoOfO4EzkFv6r0/UCUunzBiGsug1Nv428LhC0fhq6x1svfu+RBHEWpLTM3T+3yWVdcf+ini2sgv5DWKQpZsE46oVy+ioKy9+m1vtmJzn0t59U8= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1706651587; h=Content-Type:Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=6clwgklteqQmzqVd62Vwxjq6DrL4/PqmNUAfSDryvWo=; b=L1GQbMO0oGA8ayFgJ+F3WeVm9ujMW8C+DGdBZv79W4qP5zjSbxcqS8Ci1uM58U9ErRJaRyRUVqo1EoAJLLZB1mx2kkuZQnrwjqPfcIRyTBc6WZojUhEepnewY/1y4aRjI7iRSIZpRyiT2Lts0Ikx2XePeOzbL+Ah/+drn3plnQU= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1706651587053136.81636010544844; Tue, 30 Jan 2024 13:53:07 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rUw1Y-0002S3-6Q; Tue, 30 Jan 2024 16:52:08 -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 1rUw1J-0002DT-Rg for qemu-devel@nongnu.org; Tue, 30 Jan 2024 16:51:55 -0500 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rUw1I-0005nx-5K for qemu-devel@nongnu.org; Tue, 30 Jan 2024 16:51:53 -0500 Received: from mimecast-mx02.redhat.com (mx-ext.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-393-XNq4h4i6Nvq86hTJOgHE8w-1; Tue, 30 Jan 2024 16:51:49 -0500 Received: from smtp.corp.redhat.com (int-mx10.intmail.prod.int.rdu2.redhat.com [10.11.54.10]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 4515D29AC036; Tue, 30 Jan 2024 21:51:49 +0000 (UTC) Received: from localhost (unknown [10.39.192.65]) by smtp.corp.redhat.com (Postfix) with ESMTP id B3A3C492BE2; Tue, 30 Jan 2024 21:51:48 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1706651511; 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=6clwgklteqQmzqVd62Vwxjq6DrL4/PqmNUAfSDryvWo=; b=EoMljisJWCNJp8NYYBVEj1XaK6LO6bPo4zBiosmkr7CKdcfuKmir10xZhPUFBqJvMXiAWM iUlyub3piNFtp/5JdhEdTaL36xluuMkPE2QtCFLTytbU8iwYAyYh9HBPuwPDnc0i2sZidl TJKfDDGWSwVcqwk2gTI6Vv/dLob3f0A= X-MC-Unique: XNq4h4i6Nvq86hTJOgHE8w-1 From: Stefan Hajnoczi To: qemu-devel@nongnu.org Cc: John Snow , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Eduardo Habkost , Paolo Bonzini , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Aarushi Mehta , Fam Zheng , Kevin Wolf , Stefan Hajnoczi , qemu-block@nongnu.org, Julia Suvorova , Stefano Garzarella , Alistair Francis , Peter Maydell , Hanna Reitz , Manos Pitsidianakis Subject: [PULL 5/5] hw/block/block.c: improve confusing blk_check_size_and_read_all() error Date: Tue, 30 Jan 2024 16:51:34 -0500 Message-ID: <20240130215134.346557-6-stefanha@redhat.com> In-Reply-To: <20240130215134.346557-1-stefanha@redhat.com> References: <20240130215134.346557-1-stefanha@redhat.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.10 Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=170.10.129.124; envelope-from=stefanha@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -33 X-Spam_score: -3.4 X-Spam_bar: --- X-Spam_report: (-3.4 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-1.292, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, 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+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1706651587514100001 From: Manos Pitsidianakis 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. Reviewed-by: Philippe Mathieu-Daud=C3=A9 Signed-off-by: Manos Pitsidianakis Message-id: 7260eadff22c08457740117c1bb7bd2b4353acb9.1706598705.git.manos.p= itsidianakis@linaro.org Signed-off-by: Stefan Hajnoczi --- include/hw/block/block.h | 4 ++-- hw/block/block.c | 25 +++++++++++++++---------- hw/block/m25p80.c | 3 ++- hw/block/pflash_cfi01.c | 4 ++-- hw/block/pflash_cfi02.c | 2 +- 5 files changed, 22 insertions(+), 16 deletions(-) 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(BlockCo= nf *conf) =20 /* Backend access helpers */ =20 -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); =20 /* Configuration helpers */ =20 diff --git a/hw/block/block.c b/hw/block/block.c index ff503002aa..3ceca7dce6 100644 --- a/hw/block/block.c +++ b/hw/block/block.c @@ -54,29 +54,30 @@ static int blk_pread_nonzeroes(BlockBackend *blk, hwadd= r 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 =3D NULL; =20 blk_len =3D 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(bl= k)); return false; } if (blk_len !=3D size) { - error_setg(errp, "device requires %" HWADDR_PRIu " bytes, " - "block backend provides %" PRIu64 " bytes", - size, blk_len); + dev_id =3D qdev_get_human_name(dev); + error_setg(errp, "%s device '%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; } =20 @@ -89,7 +90,11 @@ bool blk_check_size_and_read_all(BlockBackend *blk, void= *buf, hwaddr size, assert(size <=3D BDRV_REQUEST_MAX_BYTES); ret =3D blk_pread_nonzeroes(blk, size, buf); if (ret < 0) { - error_setg_errno(errp, -ret, "can't read block backend"); + dev_id =3D qdev_get_human_name(dev); + error_setg_errno(errp, -ret, "can't read %s block backend" + " for %s device '%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 =3D blk_blockalign(s->blk, s->size); =20 - 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, Erro= r **errp) } =20 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, Erro= r **errp) } =20 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; --=20 2.43.0