From nobody Sun Sep 28 16:35:21 2025 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=quarantine dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1756217219; cv=none; d=zohomail.com; s=zohoarc; b=XVqeaVMQXi2mcJJ4tci7v/snuHTdGRG0mhTWoytX719S8XagGJrb8N/F569/FHqOQ1zQv6xu3Ftq4vJoVGegaFk2DKqMT4dzxubVc8164p52V3Aa1LyYr61dalbxVX6EqgTHos5BzW4bT/Mx1n3oFyrkx7L6K1kw9LadKhn6EEE= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1756217219; 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=Bkt36Pr5/qRqxqma3g03PLfI44a//mDVlHn7f70r8wg=; b=gDwNUi+RUirzmitEt8U+nh+dOB8ipXKazCuFGgYzWxafXdFLy9LN01ayeaWQh+RNSDLGgR84UNxdKoTSH0SE3h0k7UMbi9wU0fNYyacjfYxn6wyY5O0hYjzIJNp/AHSF88/M/GZ9apDNBwNbUk/YIeBsnMz95QICJd8meu2fZk0= 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=quarantine dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1756217219075352.3596584951298; Tue, 26 Aug 2025 07:06:59 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1uquJA-00068n-62; Tue, 26 Aug 2025 10:05:56 -0400 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 1uquIr-00060u-Fs for qemu-devel@nongnu.org; Tue, 26 Aug 2025 10:05:40 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1uquIe-00070U-5h for qemu-devel@nongnu.org; Tue, 26 Aug 2025 10:05:37 -0400 Received: from mx-prod-mc-08.mail-002.prod.us-west-2.aws.redhat.com (ec2-35-165-154-97.us-west-2.compute.amazonaws.com [35.165.154.97]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-552--fHai1W7PdeatJX2kdZ6rQ-1; Tue, 26 Aug 2025 10:05:17 -0400 Received: from mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.17]) (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 mx-prod-mc-08.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 965DE18002C3; Tue, 26 Aug 2025 14:05:16 +0000 (UTC) Received: from localhost (unknown [10.45.242.16]) by mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id D96341955F24; Tue, 26 Aug 2025 14:05:14 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1756217121; 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=Bkt36Pr5/qRqxqma3g03PLfI44a//mDVlHn7f70r8wg=; b=YziMPF9u8z50DFmmL6Zs2ZL0gRa/VFUlHiDq2qEfHYkduTtIIi3CMDXSGp7lYnN3g4azZ+ eVYCY2fSD5w0bO5qejRCvcIJpZzYL6RxH2fSk5lxRLd1kc85lmLB9LBa0i4rI6o8SH6drG gLizwuNo5GovP3FQlrNE9LIqElm3xTc= X-MC-Unique: -fHai1W7PdeatJX2kdZ6rQ-1 X-Mimecast-MFC-AGG-ID: -fHai1W7PdeatJX2kdZ6rQ_1756217116 From: marcandre.lureau@redhat.com To: qemu-devel@nongnu.org Cc: Paolo Bonzini , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , qemu-rust@nongnu.org, =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Manos Pitsidianakis Subject: [RFC 04/18] rust: split "util" crate Date: Tue, 26 Aug 2025 18:04:32 +0400 Message-ID: <20250826140449.4190022-5-marcandre.lureau@redhat.com> In-Reply-To: <20250826140449.4190022-1-marcandre.lureau@redhat.com> References: <20250826140449.4190022-1-marcandre.lureau@redhat.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.0 on 10.30.177.17 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.133.124; envelope-from=marcandre.lureau@redhat.com; helo=us-smtp-delivery-124.mimecast.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, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_MSPIKE_H5=0.001, RCVD_IN_MSPIKE_WL=0.001, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, RCVD_IN_VALIDITY_SAFE_BLOCKED=0.001, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001 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+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1756217221765116600 From: Marc-Andr=C3=A9 Lureau Signed-off-by: Marc-Andr=C3=A9 Lureau --- MAINTAINERS | 1 + rust/qemu-api/wrapper.h | 6 --- rust/util/wrapper.h | 32 ++++++++++++++ rust/Cargo.lock | 14 ++++++ rust/Cargo.toml | 5 +-- rust/hw/char/pl011/Cargo.toml | 1 + rust/hw/char/pl011/meson.build | 1 + rust/hw/char/pl011/src/device.rs | 7 ++- rust/hw/timer/hpet/Cargo.toml | 1 + rust/hw/timer/hpet/meson.build | 1 + rust/hw/timer/hpet/src/device.rs | 6 +-- rust/meson.build | 1 + rust/qemu-api-macros/src/lib.rs | 2 +- rust/qemu-api-macros/src/tests.rs | 2 +- rust/qemu-api/Cargo.toml | 1 + rust/qemu-api/meson.build | 12 ++---- rust/qemu-api/src/bindings.rs | 1 + rust/qemu-api/src/chardev.rs | 10 ++--- rust/qemu-api/src/lib.rs | 7 --- rust/qemu-api/src/prelude.rs | 4 -- rust/qemu-api/src/qdev.rs | 4 +- rust/qemu-api/src/sysbus.rs | 2 +- rust/qemu-api/src/vmstate.rs | 2 +- rust/qemu-api/tests/tests.rs | 3 +- rust/util/Cargo.toml | 23 ++++++++++ rust/util/build.rs | 43 +++++++++++++++++++ rust/util/meson.build | 61 +++++++++++++++++++++++++++ rust/util/src/bindings.rs | 25 +++++++++++ rust/{qemu-api =3D> util}/src/errno.rs | 10 ++--- rust/{qemu-api =3D> util}/src/error.rs | 7 ++- rust/util/src/lib.rs | 10 +++++ rust/{qemu-api =3D> util}/src/log.rs | 12 +++--- rust/{qemu-api =3D> util}/src/module.rs | 2 +- rust/{qemu-api =3D> util}/src/timer.rs | 0 34 files changed, 255 insertions(+), 64 deletions(-) create mode 100644 rust/util/wrapper.h create mode 100644 rust/util/Cargo.toml create mode 100644 rust/util/build.rs create mode 100644 rust/util/meson.build create mode 100644 rust/util/src/bindings.rs rename rust/{qemu-api =3D> util}/src/errno.rs (98%) rename rust/{qemu-api =3D> util}/src/error.rs (98%) create mode 100644 rust/util/src/lib.rs rename rust/{qemu-api =3D> util}/src/log.rs (93%) rename rust/{qemu-api =3D> util}/src/module.rs (97%) rename rust/{qemu-api =3D> util}/src/timer.rs (100%) diff --git a/MAINTAINERS b/MAINTAINERS index 80c0f80657..22d7847804 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -3514,6 +3514,7 @@ F: rust/common/ F: rust/qemu-api F: rust/qemu-api-macros F: rust/rustfmt.toml +F: rust/util/ F: scripts/get-wraps-from-cargo-registry.py =20 Rust-related patches CC here diff --git a/rust/qemu-api/wrapper.h b/rust/qemu-api/wrapper.h index 15a1b19847..cc7112406b 100644 --- a/rust/qemu-api/wrapper.h +++ b/rust/qemu-api/wrapper.h @@ -48,9 +48,6 @@ typedef enum memory_order { #endif /* __CLANG_STDATOMIC_H */ =20 #include "qemu/osdep.h" -#include "qemu/log.h" -#include "qemu/log-for-trace.h" -#include "qemu/module.h" #include "qemu-io.h" #include "system/system.h" #include "hw/sysbus.h" @@ -61,11 +58,8 @@ typedef enum memory_order { #include "hw/qdev-properties.h" #include "hw/qdev-properties-system.h" #include "hw/irq.h" -#include "qapi/error.h" -#include "qapi/error-internal.h" #include "migration/vmstate.h" #include "chardev/char-serial.h" #include "exec/memattrs.h" -#include "qemu/timer.h" #include "system/address-spaces.h" #include "hw/char/pl011.h" diff --git a/rust/util/wrapper.h b/rust/util/wrapper.h new file mode 100644 index 0000000000..b9ed68a01d --- /dev/null +++ b/rust/util/wrapper.h @@ -0,0 +1,32 @@ +/* SPDX-License-Identifier: GPL-2.0-or-later */ + +/* + * This header file is meant to be used as input to the `bindgen` applicat= ion + * in order to generate C FFI compatible Rust bindings. + */ + +#ifndef __CLANG_STDATOMIC_H +#define __CLANG_STDATOMIC_H +/* + * Fix potential missing stdatomic.h error in case bindgen does not insert= the + * correct libclang header paths on its own. We do not use stdatomic.h sym= bols + * in QEMU code, so it's fine to declare dummy types instead. + */ +typedef enum memory_order { + memory_order_relaxed, + memory_order_consume, + memory_order_acquire, + memory_order_release, + memory_order_acq_rel, + memory_order_seq_cst, +} memory_order; +#endif /* __CLANG_STDATOMIC_H */ + +#include "qemu/osdep.h" + +#include "qapi/error.h" +#include "qapi/error-internal.h" +#include "qemu/log-for-trace.h" +#include "qemu/log.h" +#include "qemu/module.h" +#include "qemu/timer.h" diff --git a/rust/Cargo.lock b/rust/Cargo.lock index ac105bd499..5cc3306b21 100644 --- a/rust/Cargo.lock +++ b/rust/Cargo.lock @@ -70,6 +70,7 @@ dependencies =3D [ "common", "qemu_api", "qemu_api_macros", + "util", ] =20 [[package]] @@ -97,6 +98,7 @@ dependencies =3D [ "common", "qemu_api", "qemu_api_macros", + "util", ] =20 [[package]] @@ -140,6 +142,7 @@ dependencies =3D [ "foreign", "libc", "qemu_api_macros", + "util", ] =20 [[package]] @@ -177,6 +180,17 @@ version =3D "1.0.12" source =3D "registry+https://github.com/rust-lang/crates.io-index" checksum =3D "3354b9ac3fae1ff6755cb6db53683adb661634f67557942dea4facebec0f= ee4b" =20 +[[package]] +name =3D "util" +version =3D "0.1.0" +dependencies =3D [ + "anyhow", + "common", + "foreign", + "libc", + "qemu_api_macros", +] + [[package]] name =3D "version_check" version =3D "0.9.4" diff --git a/rust/Cargo.toml b/rust/Cargo.toml index bb27db7931..04dac19c32 100644 --- a/rust/Cargo.toml +++ b/rust/Cargo.toml @@ -7,6 +7,7 @@ members =3D [ "qemu-api", "hw/char/pl011", "hw/timer/hpet", + "util", ] =20 [workspace.package] @@ -18,9 +19,7 @@ rust-version =3D "1.77.0" authors =3D ["The QEMU Project Developers "] =20 [workspace.lints.rust] -unexpected_cfgs =3D { level =3D "deny", check-cfg =3D [ - 'cfg(MESON)', -] } +unexpected_cfgs =3D { level =3D "deny", check-cfg =3D ['cfg(MESON)'] } =20 # Occasionally, we may need to silence warnings and clippy lints that # were only introduced in newer Rust compiler versions. Do not croak diff --git a/rust/hw/char/pl011/Cargo.toml b/rust/hw/char/pl011/Cargo.toml index 6d15f107df..0cf9943fe8 100644 --- a/rust/hw/char/pl011/Cargo.toml +++ b/rust/hw/char/pl011/Cargo.toml @@ -17,6 +17,7 @@ bilge =3D { version =3D "0.2.0" } bilge-impl =3D { version =3D "0.2.0" } bits =3D { path =3D "../../../bits" } common =3D { path =3D "../../../common" } +util =3D { path =3D "../../../util" } qemu_api =3D { path =3D "../../../qemu-api" } qemu_api_macros =3D { path =3D "../../../qemu-api-macros" } =20 diff --git a/rust/hw/char/pl011/meson.build b/rust/hw/char/pl011/meson.build index 67bd295c3d..41cf46ead1 100644 --- a/rust/hw/char/pl011/meson.build +++ b/rust/hw/char/pl011/meson.build @@ -8,6 +8,7 @@ _libpl011_rs =3D static_library( bilge_impl_rs, bits_rs, common_rs, + util_rs, qemu_api, qemu_api_macros, ], diff --git a/rust/hw/char/pl011/src/device.rs b/rust/hw/char/pl011/src/devi= ce.rs index 0c27c42c31..eb94cf6ba7 100644 --- a/rust/hw/char/pl011/src/device.rs +++ b/rust/hw/char/pl011/src/device.rs @@ -14,8 +14,6 @@ chardev::{CharBackend, Chardev, Event}, impl_vmstate_forward, irq::{IRQState, InterruptSource}, - log::Log, - log_mask_ln, memory::{hwaddr, MemoryRegion, MemoryRegionOps, MemoryRegionOpsBuilder= }, prelude::*, qdev::{Clock, ClockEvent, DeviceImpl, DeviceState, Property, ResetType= , ResettablePhasesImpl}, @@ -24,6 +22,7 @@ vmstate::VMStateDescription, vmstate_clock, vmstate_fields, vmstate_of, vmstate_struct, vmstate_sub= sections, vmstate_unused, }; +use util::{log::Log, log_mask_ln}; =20 use crate::registers::{self, Interrupt, RegisterOffset}; =20 @@ -180,7 +179,7 @@ fn properties() -> &'static [Property] { fn vmsd() -> Option<&'static VMStateDescription> { Some(&VMSTATE_PL011) } - const REALIZE: Option qemu_api::Result<()>> =3D Some(Self= ::realize); + const REALIZE: Option util::Result<()>> =3D Some(Self::re= alize); } =20 impl ResettablePhasesImpl for PL011State { @@ -627,7 +626,7 @@ fn event(&self, event: Event) { } } =20 - fn realize(&self) -> qemu_api::Result<()> { + fn realize(&self) -> util::Result<()> { self.char_backend .enable_handlers(self, Self::can_receive, Self::receive, Self:= :event); Ok(()) diff --git a/rust/hw/timer/hpet/Cargo.toml b/rust/hw/timer/hpet/Cargo.toml index ba7354f07e..dd9a5ed3d4 100644 --- a/rust/hw/timer/hpet/Cargo.toml +++ b/rust/hw/timer/hpet/Cargo.toml @@ -12,6 +12,7 @@ rust-version.workspace =3D true =20 [dependencies] common =3D { path =3D "../../../common" } +util =3D { path =3D "../../../util" } qemu_api =3D { path =3D "../../../qemu-api" } qemu_api_macros =3D { path =3D "../../../qemu-api-macros" } =20 diff --git a/rust/hw/timer/hpet/meson.build b/rust/hw/timer/hpet/meson.build index 05f8bd240a..f413893aa5 100644 --- a/rust/hw/timer/hpet/meson.build +++ b/rust/hw/timer/hpet/meson.build @@ -5,6 +5,7 @@ _libhpet_rs =3D static_library( rust_abi: 'rust', dependencies: [ common_rs, + util_rs, qemu_api, qemu_api_macros, ], diff --git a/rust/hw/timer/hpet/src/device.rs b/rust/hw/timer/hpet/src/devi= ce.rs index f3c324f243..672c88c46c 100644 --- a/rust/hw/timer/hpet/src/device.rs +++ b/rust/hw/timer/hpet/src/device.rs @@ -26,10 +26,10 @@ qom::{ObjectImpl, ObjectType, ParentField, ParentInit}, qom_isa, sysbus::{SysBusDevice, SysBusDeviceImpl}, - timer::{Timer, CLOCK_VIRTUAL, NANOSECONDS_PER_SECOND}, vmstate::VMStateDescription, vmstate_fields, vmstate_of, vmstate_struct, vmstate_subsections, vmsta= te_validate, }; +use util::timer::{Timer, CLOCK_VIRTUAL, NANOSECONDS_PER_SECOND}; =20 use crate::fw_cfg::HPETFwConfig; =20 @@ -723,7 +723,7 @@ fn post_init(&self) { } } =20 - fn realize(&self) -> qemu_api::Result<()> { + fn realize(&self) -> util::Result<()> { if self.num_timers < HPET_MIN_TIMERS || self.num_timers > HPET_MAX= _TIMERS { Err(format!( "hpet.num_timers must be between {HPET_MIN_TIMERS} and {HP= ET_MAX_TIMERS}" @@ -1039,7 +1039,7 @@ fn vmsd() -> Option<&'static VMStateDescription> { Some(&VMSTATE_HPET) } =20 - const REALIZE: Option qemu_api::Result<()>> =3D Some(Self= ::realize); + const REALIZE: Option util::Result<()>> =3D Some(Self::re= alize); } =20 impl ResettablePhasesImpl for HPETState { diff --git a/rust/meson.build b/rust/meson.build index 402f8d6600..a9d715e6e9 100644 --- a/rust/meson.build +++ b/rust/meson.build @@ -25,6 +25,7 @@ genrs =3D [] subdir('common') subdir('qemu-api-macros') subdir('bits') +subdir('util') subdir('qemu-api') =20 subdir('hw') diff --git a/rust/qemu-api-macros/src/lib.rs b/rust/qemu-api-macros/src/lib= .rs index 850e3b1596..b5f77f06f5 100644 --- a/rust/qemu-api-macros/src/lib.rs +++ b/rust/qemu-api-macros/src/lib.rs @@ -91,7 +91,7 @@ fn derive_object_or_error(input: DeriveInput) -> Result::ParentType>); =20 - ::qemu_api::module_init! { + ::util::module_init! { MODULE_INIT_QOM =3D> unsafe { ::qemu_api::bindings::type_register_static(&<#name as ::qe= mu_api::qom::ObjectImpl>::TYPE_INFO); } diff --git a/rust/qemu-api-macros/src/tests.rs b/rust/qemu-api-macros/src/t= ests.rs index 42d5fa50bd..52683e46d5 100644 --- a/rust/qemu-api-macros/src/tests.rs +++ b/rust/qemu-api-macros/src/tests.rs @@ -63,7 +63,7 @@ struct Foo { _unused, ::qemu_api::qom::ParentField<::ParentType> ); - ::qemu_api::module_init! { + ::util::module_init! { MODULE_INIT_QOM =3D> unsafe { ::qemu_api::bindings::type_register_static(&::TYPE_INFO); } diff --git a/rust/qemu-api/Cargo.toml b/rust/qemu-api/Cargo.toml index 12774c356a..28e5969e7a 100644 --- a/rust/qemu-api/Cargo.toml +++ b/rust/qemu-api/Cargo.toml @@ -15,6 +15,7 @@ rust-version.workspace =3D true =20 [dependencies] common =3D { path =3D "../common" } +util =3D { path =3D "../util" } qemu_api_macros =3D { path =3D "../qemu-api-macros" } anyhow =3D "~1.0" libc =3D "0.2.162" diff --git a/rust/qemu-api/meson.build b/rust/qemu-api/meson.build index 6177e26819..8a2950dfe4 100644 --- a/rust/qemu-api/meson.build +++ b/rust/qemu-api/meson.build @@ -14,10 +14,8 @@ c_enums =3D [ 'MigrationPolicy', 'MigrationPriority', 'QEMUChrEvent', - 'QEMUClockType', 'ResetType', 'device_endian', - 'module_init_type', ] _qemu_api_bindgen_args =3D [] foreach enum : c_enums @@ -31,6 +29,7 @@ foreach enum : c_bitfields _qemu_api_bindgen_args +=3D ['--bitfield-enum', enum] endforeach =20 +_qemu_api_bindgen_args +=3D ['--blocklist-type', 'Error'] # TODO: Remove this comment when the clang/libclang mismatch issue is solv= ed. # # Rust bindings generation with `bindgen` might fail in some cases where t= he @@ -55,17 +54,12 @@ _qemu_api_rs =3D static_library( 'src/bindings.rs', 'src/cell.rs', 'src/chardev.rs', - 'src/errno.rs', - 'src/error.rs', 'src/irq.rs', - 'src/log.rs', 'src/memory.rs', - 'src/module.rs', 'src/prelude.rs', 'src/qdev.rs', 'src/qom.rs', 'src/sysbus.rs', - 'src/timer.rs', 'src/vmstate.rs', ], {'.' : _qemu_api_bindings_inc_rs}, @@ -73,7 +67,7 @@ _qemu_api_rs =3D static_library( override_options: ['rust_std=3D2021', 'build.rust_std=3D2021'], rust_abi: 'rust', rust_args: _qemu_api_cfg, - dependencies: [anyhow_rs, common_rs, foreign_rs, libc_rs, qemu_api_macro= s, qemuutil_rs, + dependencies: [anyhow_rs, common_rs, foreign_rs, libc_rs, qemu_api_macro= s, qemuutil_rs, util_rs, qom, hwcore, chardev, migration], ) =20 @@ -99,7 +93,7 @@ test('rust-qemu-api-integration', override_options: ['rust_std=3D2021', 'build.rust_std=3D2021'], rust_args: ['--test'], install: false, - dependencies: [common_rs, qemu_api]), + dependencies: [common_rs, util_rs, qemu_api]), args: [ '--test', '--test-threads', '1', '--format', 'pretty', diff --git a/rust/qemu-api/src/bindings.rs b/rust/qemu-api/src/bindings.rs index 3acdd903b5..aedf42b652 100644 --- a/rust/qemu-api/src/bindings.rs +++ b/rust/qemu-api/src/bindings.rs @@ -21,6 +21,7 @@ //! `bindgen`-generated declarations. =20 use common::Zeroable; +use util::bindings::Error; =20 #[cfg(MESON)] include!("bindings.inc.rs"); diff --git a/rust/qemu-api/src/chardev.rs b/rust/qemu-api/src/chardev.rs index e2cb5f4379..c2bea23e82 100644 --- a/rust/qemu-api/src/chardev.rs +++ b/rust/qemu-api/src/chardev.rs @@ -54,7 +54,7 @@ fn write(&mut self, buf: &[u8]) -> io::Result { =20 let len =3D buf.len().try_into().unwrap(); let r =3D unsafe { bindings::qemu_chr_fe_write(addr_of_mut!(*chr),= buf.as_ptr(), len) }; - errno::into_io_result(r).map(|cnt| cnt as usize) + ::util::errno::into_io_result(r).map(|cnt| cnt as usize) } =20 fn write_all(&mut self, buf: &[u8]) -> io::Result<()> { @@ -62,7 +62,7 @@ fn write_all(&mut self, buf: &[u8]) -> io::Result<()> { =20 let len =3D buf.len().try_into().unwrap(); let r =3D unsafe { bindings::qemu_chr_fe_write_all(addr_of_mut!(*c= hr), buf.as_ptr(), len) }; - errno::into_io_result(r).and_then(|cnt| { + ::util::errno::into_io_result(r).and_then(|cnt| { if cnt as usize =3D=3D buf.len() { Ok(()) } else { @@ -215,7 +215,7 @@ pub fn send_break(&self, long: bool) -> io::Result<()> { ) }; =20 - errno::into_io_result(r).map(|_| ()) + ::util::errno::into_io_result(r).map(|_| ()) } =20 /// Write data to a character backend from the front end. This functi= on @@ -229,7 +229,7 @@ pub fn write(&self, buf: &[u8]) -> io::Result { let len =3D buf.len().try_into().unwrap(); // SAFETY: qemu_chr_fe_write is thread-safe let r =3D unsafe { bindings::qemu_chr_fe_write(self.inner.as_ptr()= , buf.as_ptr(), len) }; - errno::into_io_result(r).map(|cnt| cnt as usize) + ::util::errno::into_io_result(r).map(|cnt| cnt as usize) } =20 /// Write data to a character backend from the front end. This functi= on @@ -243,7 +243,7 @@ pub fn write_all(&self, buf: &[u8]) -> io::Result<()> { let len =3D buf.len().try_into().unwrap(); // SAFETY: qemu_chr_fe_write_all is thread-safe let r =3D unsafe { bindings::qemu_chr_fe_write_all(self.inner.as_p= tr(), buf.as_ptr(), len) }; - errno::into_io_result(r).and_then(|cnt| { + ::util::errno::into_io_result(r).and_then(|cnt| { if cnt as usize =3D=3D buf.len() { Ok(()) } else { diff --git a/rust/qemu-api/src/lib.rs b/rust/qemu-api/src/lib.rs index 7a2b29f28f..db81841a8f 100644 --- a/rust/qemu-api/src/lib.rs +++ b/rust/qemu-api/src/lib.rs @@ -15,16 +15,9 @@ =20 pub mod cell; pub mod chardev; -pub mod errno; -pub mod error; pub mod irq; -pub mod log; pub mod memory; -pub mod module; pub mod qdev; pub mod qom; pub mod sysbus; -pub mod timer; pub mod vmstate; - -pub use error::{Error, Result}; diff --git a/rust/qemu-api/src/prelude.rs b/rust/qemu-api/src/prelude.rs index ad157f9655..3d771481e4 100644 --- a/rust/qemu-api/src/prelude.rs +++ b/rust/qemu-api/src/prelude.rs @@ -7,10 +7,6 @@ pub use crate::cell::BqlCell; pub use crate::cell::BqlRefCell; =20 -pub use crate::errno; - -pub use crate::log_mask_ln; - pub use crate::qdev::DeviceMethods; =20 pub use crate::qom::InterfaceType; diff --git a/rust/qemu-api/src/qdev.rs b/rust/qemu-api/src/qdev.rs index bf17558cdb..02e9d55e6a 100644 --- a/rust/qemu-api/src/qdev.rs +++ b/rust/qemu-api/src/qdev.rs @@ -11,12 +11,12 @@ =20 pub use bindings::{ClockEvent, DeviceClass, Property, ResetType}; use common::{callbacks::FnCall, Opaque}; +pub use util::{Error, Result}; =20 use crate::{ bindings::{self, qdev_init_gpio_in, qdev_init_gpio_out, ResettableClas= s}, cell::bql_locked, chardev::Chardev, - error::{Error, Result}, irq::InterruptSource, prelude::*, qom::{ObjectClass, ObjectImpl, Owned, ParentInit}, @@ -135,7 +135,7 @@ fn vmsd() -> Option<&'static VMStateDescription> { /// readable/writeable from one thread at any time. unsafe extern "C" fn rust_realize_fn( dev: *mut bindings::DeviceState, - errp: *mut *mut bindings::Error, + errp: *mut *mut util::bindings::Error, ) { let state =3D NonNull::new(dev).unwrap().cast::(); let result =3D T::REALIZE.unwrap()(unsafe { state.as_ref() }); diff --git a/rust/qemu-api/src/sysbus.rs b/rust/qemu-api/src/sysbus.rs index 4a5b4cbbf6..2dbfc31dbd 100644 --- a/rust/qemu-api/src/sysbus.rs +++ b/rust/qemu-api/src/sysbus.rs @@ -114,7 +114,7 @@ fn sysbus_realize(&self) { unsafe { bindings::sysbus_realize( self.upcast().as_mut_ptr(), - addr_of_mut!(bindings::error_fatal), + addr_of_mut!(util::bindings::error_fatal), ); } } diff --git a/rust/qemu-api/src/vmstate.rs b/rust/qemu-api/src/vmstate.rs index 6a9cc0b975..4e2b7e2db0 100644 --- a/rust/qemu-api/src/vmstate.rs +++ b/rust/qemu-api/src/vmstate.rs @@ -390,7 +390,7 @@ unsafe impl VMState for $type { impl_vmstate_scalar!(vmstate_info_uint16, u16, VMS_VARRAY_UINT16); impl_vmstate_scalar!(vmstate_info_uint32, u32, VMS_VARRAY_UINT32); impl_vmstate_scalar!(vmstate_info_uint64, u64); -impl_vmstate_scalar!(vmstate_info_timer, crate::timer::Timer); +impl_vmstate_scalar!(vmstate_info_timer, util::timer::Timer); =20 // Pointer types using the underlying type's VMState plus VMS_POINTER // Note that references are not supported, though references to cells diff --git a/rust/qemu-api/tests/tests.rs b/rust/qemu-api/tests/tests.rs index 2594e5465d..1dd4e29754 100644 --- a/rust/qemu-api/tests/tests.rs +++ b/rust/qemu-api/tests/tests.rs @@ -6,7 +6,7 @@ =20 use common::Zeroable; use qemu_api::{ - bindings::{module_call_init, module_init_type, qdev_prop_bool}, + bindings::qdev_prop_bool, cell::{self, BqlCell}, declare_properties, define_property, prelude::*, @@ -15,6 +15,7 @@ sysbus::SysBusDevice, vmstate::VMStateDescription, }; +use util::bindings::{module_call_init, module_init_type}; =20 mod vmstate_tests; =20 diff --git a/rust/util/Cargo.toml b/rust/util/Cargo.toml new file mode 100644 index 0000000000..aa10f03384 --- /dev/null +++ b/rust/util/Cargo.toml @@ -0,0 +1,23 @@ +[package] +name =3D "util" +version =3D "0.1.0" +description =3D "Rust bindings for QEMU/util" +resolver =3D "2" +publish =3D false + +authors.workspace =3D true +edition.workspace =3D true +homepage.workspace =3D true +license.workspace =3D true +repository.workspace =3D true +rust-version.workspace =3D true + +[dependencies] +anyhow =3D "~1.0" +libc =3D "0.2.162" +foreign =3D "~0.3.1" +common =3D { path =3D "../common" } +qemu_api_macros =3D { path =3D "../qemu-api-macros" } + +[lints] +workspace =3D true diff --git a/rust/util/build.rs b/rust/util/build.rs new file mode 100644 index 0000000000..cac57cc5b9 --- /dev/null +++ b/rust/util/build.rs @@ -0,0 +1,43 @@ +// Copyright 2024, Linaro Limited +// Author(s): Manos Pitsidianakis +// SPDX-License-Identifier: GPL-2.0-or-later + +#[cfg(unix)] +use std::os::unix::fs::symlink as symlink_file; +#[cfg(windows)] +use std::os::windows::fs::symlink_file; +use std::{env, fs::remove_file, io::Result, path::Path}; + +fn main() -> Result<()> { + let file =3D if let Ok(root) =3D env::var("MESON_BUILD_ROOT") { + format!("{root}/rust/util/bindings.inc.rs") + } else { + // Placing bindings.inc.rs in the source directory is supported + // but not documented or encouraged. + format!("{}/src/bindings.inc.rs", env!("CARGO_MANIFEST_DIR")) + }; + + let file =3D Path::new(&file); + if !Path::new(&file).exists() { + panic!(concat!( + "\n", + " No generated C bindings found! Maybe you wanted one of\n", + " `make clippy`, `make rustfmt`, `make rustdoc`?\n", + "\n", + " For other uses of `cargo`, start a subshell with\n", + " `pyvenv/bin/meson devenv`, or point MESON_BUILD_ROOT to\n= ", + " the top of the build tree." + )); + } + + let out_dir =3D env::var("OUT_DIR").unwrap(); + let dest_path =3D format!("{out_dir}/bindings.inc.rs"); + let dest_path =3D Path::new(&dest_path); + if dest_path.symlink_metadata().is_ok() { + remove_file(dest_path)?; + } + symlink_file(file, dest_path)?; + + println!("cargo:rerun-if-changed=3Dbuild.rs"); + Ok(()) +} diff --git a/rust/util/meson.build b/rust/util/meson.build new file mode 100644 index 0000000000..3fe8e3975f --- /dev/null +++ b/rust/util/meson.build @@ -0,0 +1,61 @@ +_util_cfg =3D run_command(rustc_args, + '--config-headers', config_host_h, '--features', files('Cargo.toml'), + capture: true, check: true).stdout().strip().splitlines() + +_util_bindgen_args =3D [] +c_enums =3D [ + 'module_init_type', + 'QEMUClockType', +] +foreach enum : c_enums + _util_bindgen_args +=3D ['--rustified-enum', enum] +endforeach + +# +# TODO: Remove this comment when the clang/libclang mismatch issue is solv= ed. +# +# Rust bindings generation with `bindgen` might fail in some cases where t= he +# detected `libclang` does not match the expected `clang` version/target. = In +# this case you must pass the path to `clang` and `libclang` to your build +# command invocation using the environment variables CLANG_PATH and +# LIBCLANG_PATH +_util_bindings_inc_rs =3D rust.bindgen( + input: 'wrapper.h', + dependencies: common_ss.all_dependencies(), + output: 'bindings.inc.rs', + include_directories: bindings_incdir, + bindgen_version: ['>=3D0.60.0'], + args: bindgen_args_common + _util_bindgen_args, +) + +_util_rs =3D static_library( + 'util', + structured_sources( + [ + 'src/lib.rs', + 'src/bindings.rs', + 'src/errno.rs', + 'src/error.rs', + 'src/log.rs', + 'src/module.rs', + 'src/timer.rs', + ], + {'.': _util_bindings_inc_rs} + ), + override_options: ['rust_std=3D2021', 'build.rust_std=3D2021'], + rust_abi: 'rust', + rust_args: _util_cfg, + dependencies: [anyhow_rs, libc_rs, foreign_rs, qemuutil_rs, common_rs, q= emu_api_macros], +) + +util_rs =3D declare_dependency(link_with: [_util_rs], dependencies: [qemuu= til_rs, qom]) + +# Doctests are essentially integration tests, so they need the same depend= encies. +# Note that running them requires the object files for C code, so place th= em +# in a separate suite that is run by the "build" CI jobs rather than "chec= k". +rust.doctest('rust-util-rs-doctests', + _util_rs, + protocol: 'rust', + dependencies: util_rs, + suite: ['doc', 'rust'] +) diff --git a/rust/util/src/bindings.rs b/rust/util/src/bindings.rs new file mode 100644 index 0000000000..9ffff12cde --- /dev/null +++ b/rust/util/src/bindings.rs @@ -0,0 +1,25 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +#![allow( + dead_code, + improper_ctypes_definitions, + improper_ctypes, + non_camel_case_types, + non_snake_case, + non_upper_case_globals, + unnecessary_transmutes, + unsafe_op_in_unsafe_fn, + clippy::pedantic, + clippy::restriction, + clippy::style, + clippy::missing_const_for_fn, + clippy::ptr_offset_with_cast, + clippy::useless_transmute, + clippy::missing_safety_doc, + clippy::too_many_arguments +)] + +#[cfg(MESON)] +include!("bindings.inc.rs"); + +#[cfg(not(MESON))] +include!(concat!(env!("OUT_DIR"), "/bindings.inc.rs")); diff --git a/rust/qemu-api/src/errno.rs b/rust/util/src/errno.rs similarity index 98% rename from rust/qemu-api/src/errno.rs rename to rust/util/src/errno.rs index e9478c4eb4..f3d27ccf65 100644 --- a/rust/qemu-api/src/errno.rs +++ b/rust/util/src/errno.rs @@ -176,7 +176,7 @@ fn map_ok(self) -> i32 { /// are interpreted as negated `errno` and turned into an `Err`. /// /// ``` -/// # use qemu_api::errno::into_io_result; +/// # use util::errno::into_io_result; /// # use std::io::ErrorKind; /// let ok =3D into_io_result(1i32).unwrap(); /// assert_eq!(ok, 1u32); @@ -192,7 +192,7 @@ fn map_ok(self) -> i32 { /// likely overflows and will panic: /// /// ```should_panic -/// # use qemu_api::errno::into_io_result; +/// # use util::errno::into_io_result; /// # #[allow(dead_code)] /// let err =3D into_io_result(-0x1234_5678i32); // panic /// ``` @@ -204,7 +204,7 @@ pub fn into_io_result(value: T) -> io::Res= ult { /// values to report errors. /// /// ``` -/// # use qemu_api::errno::into_neg_errno; +/// # use util::errno::into_neg_errno; /// # use std::io::{self, ErrorKind}; /// let ok: io::Result<()> =3D Ok(()); /// assert_eq!(into_neg_errno(ok), 0); @@ -223,7 +223,7 @@ pub fn into_io_result(value: T) -> io::Res= ult { /// positive: /// /// ```should_panic -/// # use qemu_api::errno::into_neg_errno; +/// # use util::errno::into_neg_errno; /// # use std::io; /// let err: io::Result =3D Ok(0x8899_AABB); /// into_neg_errno(err) // panic @@ -240,7 +240,7 @@ pub fn into_neg_errno>(va= lue: Result) -> T:: mod tests { use std::io::ErrorKind; =20 - use common::assert_match; + use bindings::assert_match; =20 use super::*; =20 diff --git a/rust/qemu-api/src/error.rs b/rust/util/src/error.rs similarity index 98% rename from rust/qemu-api/src/error.rs rename to rust/util/src/error.rs index 8bac3cbec8..a1b11a97ca 100644 --- a/rust/qemu-api/src/error.rs +++ b/rust/util/src/error.rs @@ -19,7 +19,7 @@ //! //! This module is most commonly used at the boundary between C and Rust c= ode; //! other code will usually access it through the -//! [`qemu_api::Result`](crate::Result) type alias, and will use the +//! [`utils::Result`](crate::Result) type alias, and will use the //! [`std::error::Error`] interface to let C errors participate in Rust's = error //! handling functionality. //! @@ -30,7 +30,7 @@ //! type up to C code, or from a combination of the two. //! //! The third case, corresponding to [`Error::with_error`], is the only on= e that -//! requires mentioning [`qemu_api::Error`](crate::Error) explicitly. Sim= ilar +//! requires mentioning [`utils::Error`](crate::Error) explicitly. Similar //! to how QEMU's C code handles errno values, the string and the //! `anyhow::Error` object will be concatenated with `:` as the separator. =20 @@ -316,11 +316,10 @@ mod tests { use std::ffi::CStr; =20 use anyhow::anyhow; - use common::assert_match; + use bindings::assert_match; use foreign::OwnedPointer; =20 use super::*; - use crate::bindings; =20 #[track_caller] fn error_for_test(msg: &CStr) -> OwnedPointer { diff --git a/rust/util/src/lib.rs b/rust/util/src/lib.rs new file mode 100644 index 0000000000..3463d937b4 --- /dev/null +++ b/rust/util/src/lib.rs @@ -0,0 +1,10 @@ +// SPDX-License-Identifier: GPL-2.0-or-later + +pub mod bindings; +pub mod errno; +pub mod error; +pub mod log; +pub mod module; +pub mod timer; + +pub use error::{Error, Result}; diff --git a/rust/qemu-api/src/log.rs b/rust/util/src/log.rs similarity index 93% rename from rust/qemu-api/src/log.rs rename to rust/util/src/log.rs index a441b8c1f2..2e2c1cf3f8 100644 --- a/rust/qemu-api/src/log.rs +++ b/rust/util/src/log.rs @@ -47,7 +47,7 @@ impl LogGuard { /// # Examples /// /// ``` - /// # use qemu_api::log::LogGuard; + /// # use util::log::LogGuard; /// # use std::io::Write; /// if let Some(mut log) =3D LogGuard::new() { /// writeln!(log, "test"); @@ -114,7 +114,7 @@ fn drop(&mut self) { /// # Example /// /// ``` -/// use qemu_api::{log::Log, log_mask_ln}; +/// use util::{log::Log, log_mask_ln}; /// /// let error_address =3D 0xbad; /// log_mask_ln!(Log::GuestError, "Address 0x{error_address:x} out of rang= e"); @@ -124,7 +124,7 @@ fn drop(&mut self) { /// trailing `,`: /// /// ``` -/// use qemu_api::{log::Log, log_mask_ln}; +/// use util::{log::Log, log_mask_ln}; /// /// let error_address =3D 0xbad; /// log_mask_ln!( @@ -137,12 +137,12 @@ fn drop(&mut self) { macro_rules! log_mask_ln { ($mask:expr, $fmt:tt $($args:tt)*) =3D> {{ // Type assertion to enforce type `Log` for $mask - let _: Log =3D $mask; + let _: $crate::log::Log =3D $mask; =20 if unsafe { - (::qemu_api::bindings::qemu_loglevel & ($mask as std::os::raw:= :c_int)) !=3D 0 + ($crate::bindings::qemu_loglevel & ($mask as std::os::raw::c_i= nt)) !=3D 0 } { - _ =3D ::qemu_api::log::LogGuard::log_fmt( + _ =3D $crate::log::LogGuard::log_fmt( format_args!("{}\n", format_args!($fmt $($args)*))); } }}; diff --git a/rust/qemu-api/src/module.rs b/rust/util/src/module.rs similarity index 97% rename from rust/qemu-api/src/module.rs rename to rust/util/src/module.rs index fa5cea3598..06c45fc142 100644 --- a/rust/qemu-api/src/module.rs +++ b/rust/util/src/module.rs @@ -36,7 +36,7 @@ extern "C" fn ctor_fn() { =20 // shortcut because it's quite common that $body needs unsafe {} ($type:ident =3D> unsafe $body:block) =3D> { - $crate::module_init! { + ::util::module_init! { $type =3D> { unsafe { $body } } } }; diff --git a/rust/qemu-api/src/timer.rs b/rust/util/src/timer.rs similarity index 100% rename from rust/qemu-api/src/timer.rs rename to rust/util/src/timer.rs --=20 2.50.1