Add rust/qemu-api, which exposes rust-bindgen generated FFI bindings and
provides some declaration macros for symbols visible to the rest of
QEMU.
Co-authored-by: Junjie Mao <junjie.mao@intel.com>
Co-authored-by: Paolo Bonzini <pbonzini@redhat.com>
Signed-off-by: Junjie Mao <junjie.mao@intel.com>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Signed-off-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
---
MAINTAINERS | 6 ++
rust/meson.build | 9 +++
rust/qemu-api/.gitignore | 2 +
rust/qemu-api/Cargo.lock | 7 +++
rust/qemu-api/Cargo.toml | 23 +++++++
rust/qemu-api/README.md | 17 +++++
rust/qemu-api/build.rs | 13 ++++
rust/qemu-api/meson.build | 17 +++++
rust/qemu-api/rustfmt.toml | 1 +
rust/qemu-api/src/bindings.rs | 7 +++
rust/qemu-api/src/definitions.rs | 108 ++++++++++++++++++++++++++++++++
rust/qemu-api/src/device_class.rs | 128 ++++++++++++++++++++++++++++++++++++++
rust/qemu-api/src/lib.rs | 100 +++++++++++++++++++++++++++++
rust/qemu-api/src/tests.rs | 48 ++++++++++++++
rust/rustfmt.toml | 7 +++
15 files changed, 493 insertions(+)
diff --git a/MAINTAINERS b/MAINTAINERS
index 5464cb2b03..56a88048d2 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -3348,6 +3348,12 @@ F: hw/core/register.c
F: include/hw/register.h
F: include/hw/registerfields.h
+Rust
+M: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
+S: Maintained
+F: rust/qemu-api
+F: rust/rustfmt.toml
+
SLIRP
M: Samuel Thibault <samuel.thibault@ens-lyon.org>
S: Maintained
diff --git a/rust/meson.build b/rust/meson.build
index e69de29bb2..d5f32aed25 100644
--- a/rust/meson.build
+++ b/rust/meson.build
@@ -0,0 +1,9 @@
+_lib_bindings_rs = static_library(
+ '_bindings_rs',
+ bindings_rs,
+ gnu_symbol_visibility: 'hidden',
+ override_options: ['rust_std=2021', 'build.rust_std=2021'],
+ rust_abi: 'rust',
+)
+
+subdir('qemu-api')
diff --git a/rust/qemu-api/.gitignore b/rust/qemu-api/.gitignore
new file mode 100644
index 0000000000..71eaff2035
--- /dev/null
+++ b/rust/qemu-api/.gitignore
@@ -0,0 +1,2 @@
+# Ignore generated bindings file overrides.
+src/bindings.rs.inc
diff --git a/rust/qemu-api/Cargo.lock b/rust/qemu-api/Cargo.lock
new file mode 100644
index 0000000000..e9c51a243a
--- /dev/null
+++ b/rust/qemu-api/Cargo.lock
@@ -0,0 +1,7 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 3
+
+[[package]]
+name = "qemu_api"
+version = "0.1.0"
diff --git a/rust/qemu-api/Cargo.toml b/rust/qemu-api/Cargo.toml
new file mode 100644
index 0000000000..51260cbe42
--- /dev/null
+++ b/rust/qemu-api/Cargo.toml
@@ -0,0 +1,23 @@
+[package]
+name = "qemu_api"
+version = "0.1.0"
+edition = "2021"
+authors = ["Manos Pitsidianakis <manos.pitsidianakis@linaro.org>"]
+license = "GPL-2.0 OR GPL-3.0-or-later"
+readme = "README.md"
+homepage = "https://www.qemu.org"
+description = "Rust bindings for QEMU"
+repository = "https://gitlab.com/qemu-project/qemu/"
+resolver = "2"
+publish = false
+keywords = []
+categories = []
+
+[dependencies]
+
+[features]
+default = ["allocator"]
+allocator = []
+
+# Do not include in any global workspace
+[workspace]
diff --git a/rust/qemu-api/README.md b/rust/qemu-api/README.md
new file mode 100644
index 0000000000..7588fa29ef
--- /dev/null
+++ b/rust/qemu-api/README.md
@@ -0,0 +1,17 @@
+# QEMU bindings and API wrappers
+
+This library exports helper Rust types, Rust macros and C FFI bindings for internal QEMU APIs.
+
+The C bindings can be generated with `bindgen`, using this build target:
+
+```console
+$ ninja bindings.rs
+```
+
+## Generate Rust documentation
+
+To generate docs for this crate, including private items:
+
+```sh
+cargo doc --no-deps --document-private-items
+```
diff --git a/rust/qemu-api/build.rs b/rust/qemu-api/build.rs
new file mode 100644
index 0000000000..2f57c2b3d4
--- /dev/null
+++ b/rust/qemu-api/build.rs
@@ -0,0 +1,13 @@
+// Copyright 2024 Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
+// SPDX-License-Identifier: GPL-2.0 OR GPL-3.0-or-later
+
+use std::path::Path;
+
+fn main() {
+ if !Path::new("src/bindings.rs.inc").exists() {
+ panic!(
+ "No generated C bindings found! Either build them manually with bindgen or with meson \
+ (`ninja bindings.rs`) and copy them to src/bindings.rs.inc, or build through meson."
+ );
+ }
+}
diff --git a/rust/qemu-api/meson.build b/rust/qemu-api/meson.build
new file mode 100644
index 0000000000..997d478309
--- /dev/null
+++ b/rust/qemu-api/meson.build
@@ -0,0 +1,17 @@
+_qemu_api_rs = static_library(
+ 'qemu_api',
+ [files('src/lib.rs')],
+ gnu_symbol_visibility: 'hidden',
+ override_options: ['rust_std=2021', 'build.rust_std=2021'],
+ rust_abi: 'rust',
+ rust_args: rust_args + [
+ '--cfg', 'MESON_BINDINGS_RS',
+ ],
+ link_with: [
+ _lib_bindings_rs,
+ ],
+)
+
+qemu_api = declare_dependency(
+ link_with: _qemu_api_rs,
+)
diff --git a/rust/qemu-api/rustfmt.toml b/rust/qemu-api/rustfmt.toml
new file mode 120000
index 0000000000..39f97b043b
--- /dev/null
+++ b/rust/qemu-api/rustfmt.toml
@@ -0,0 +1 @@
+../rustfmt.toml
\ No newline at end of file
diff --git a/rust/qemu-api/src/bindings.rs b/rust/qemu-api/src/bindings.rs
new file mode 100644
index 0000000000..fb595f1469
--- /dev/null
+++ b/rust/qemu-api/src/bindings.rs
@@ -0,0 +1,7 @@
+// Copyright 2024 Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
+// SPDX-License-Identifier: GPL-2.0 OR GPL-3.0-or-later
+#[cfg(not(MESON_BINDINGS_RS))]
+include!("bindings.rs.inc");
+
+#[cfg(MESON_BINDINGS_RS)]
+pub use ::_bindings_rs::*;
diff --git a/rust/qemu-api/src/definitions.rs b/rust/qemu-api/src/definitions.rs
new file mode 100644
index 0000000000..6de42229b6
--- /dev/null
+++ b/rust/qemu-api/src/definitions.rs
@@ -0,0 +1,108 @@
+// Copyright 2024 Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
+// SPDX-License-Identifier: GPL-2.0 OR GPL-3.0-or-later
+
+//! Definitions required by QEMU when registering a device.
+
+/// Trait a type must implement to be registered with QEMU.
+pub trait ObjectImpl {
+ type Class;
+ const TYPE_INFO: crate::bindings::TypeInfo;
+ const TYPE_NAME: &'static ::core::ffi::CStr;
+ const PARENT_TYPE_NAME: Option<&'static ::core::ffi::CStr>;
+ const INSTANCE_INIT: ::core::option::Option<
+ unsafe extern "C" fn(obj: *mut crate::bindings::Object),
+ >;
+ const INSTANCE_POST_INIT: ::core::option::Option<
+ unsafe extern "C" fn(obj: *mut crate::bindings::Object),
+ >;
+ const INSTANCE_FINALIZE: ::core::option::Option<
+ unsafe extern "C" fn(obj: *mut crate::bindings::Object),
+ >;
+ const ABSTRACT: bool;
+}
+
+pub trait Class {
+ const CLASS_INIT: ::core::option::Option<
+ unsafe extern "C" fn(
+ klass: *mut crate::bindings::ObjectClass,
+ data: *mut core::ffi::c_void,
+ ),
+ >;
+ const CLASS_BASE_INIT: ::core::option::Option<
+ unsafe extern "C" fn(
+ klass: *mut crate::bindings::ObjectClass,
+ data: *mut core::ffi::c_void,
+ ),
+ >;
+}
+
+#[macro_export]
+macro_rules! module_init {
+ ($func:expr, $type:expr) => {
+ #[used]
+ #[cfg_attr(target_os = "linux", link_section = ".ctors")]
+ #[cfg_attr(target_os = "macos", link_section = "__DATA,__mod_init_func")]
+ #[cfg_attr(target_os = "windows", link_section = ".CRT$XCU")]
+ pub static LOAD_MODULE: extern "C" fn() = {
+ assert!($type < $crate::bindings::module_init_type_MODULE_INIT_MAX);
+
+ extern "C" fn __load() {
+ unsafe {
+ $crate::bindings::register_module_init(Some($func), $type);
+ }
+ }
+
+ __load
+ };
+ };
+ (qom: $func:ident => $body:block) => {
+ // NOTE: To have custom identifiers for the ctor func we need to either supply
+ // them directly as a macro argument or create them with a proc macro.
+ #[used]
+ #[cfg_attr(target_os = "linux", link_section = ".ctors")]
+ #[cfg_attr(target_os = "macos", link_section = "__DATA,__mod_init_func")]
+ #[cfg_attr(target_os = "windows", link_section = ".CRT$XCU")]
+ pub static LOAD_MODULE: extern "C" fn() = {
+ extern "C" fn __load() {
+ #[no_mangle]
+ unsafe extern "C" fn $func() {
+ $body
+ }
+
+ unsafe {
+ $crate::bindings::register_module_init(
+ Some($func),
+ $crate::bindings::module_init_type_MODULE_INIT_QOM,
+ );
+ }
+ }
+
+ __load
+ };
+ };
+}
+
+#[macro_export]
+macro_rules! type_info {
+ ($t:ty) => {
+ $crate::bindings::TypeInfo {
+ name: <$t as $crate::definitions::ObjectImpl>::TYPE_NAME.as_ptr(),
+ parent: if let Some(pname) = <$t as $crate::definitions::ObjectImpl>::PARENT_TYPE_NAME {
+ pname.as_ptr()
+ } else {
+ ::core::ptr::null_mut()
+ },
+ instance_size: ::core::mem::size_of::<$t>(),
+ instance_align: ::core::mem::align_of::<$t>(),
+ instance_init: <$t as $crate::definitions::ObjectImpl>::INSTANCE_INIT,
+ instance_post_init: <$t as $crate::definitions::ObjectImpl>::INSTANCE_POST_INIT,
+ instance_finalize: <$t as $crate::definitions::ObjectImpl>::INSTANCE_FINALIZE,
+ abstract_: <$t as $crate::definitions::ObjectImpl>::ABSTRACT,
+ class_size: ::core::mem::size_of::<<$t as $crate::definitions::ObjectImpl>::Class>(),
+ class_init: <<$t as $crate::definitions::ObjectImpl>::Class as $crate::definitions::Class>::CLASS_INIT,
+ class_base_init: <<$t as $crate::definitions::ObjectImpl>::Class as $crate::definitions::Class>::CLASS_BASE_INIT,
+ class_data: ::core::ptr::null_mut(),
+ interfaces: ::core::ptr::null_mut(),
+ };
+ }
+}
diff --git a/rust/qemu-api/src/device_class.rs b/rust/qemu-api/src/device_class.rs
new file mode 100644
index 0000000000..f8d4c04e03
--- /dev/null
+++ b/rust/qemu-api/src/device_class.rs
@@ -0,0 +1,128 @@
+// Copyright 2024 Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
+// SPDX-License-Identifier: GPL-2.0 OR GPL-3.0-or-later
+
+use std::sync::OnceLock;
+
+use crate::bindings::Property;
+
+#[macro_export]
+macro_rules! device_class_init {
+ ($func:ident, props => $props:ident, realize_fn => $realize_fn:expr, reset_fn => $reset_fn:expr, vmsd => $vmsd:ident$(,)*) => {
+ #[no_mangle]
+ pub unsafe extern "C" fn $func(
+ klass: *mut $crate::bindings::ObjectClass,
+ _: *mut ::core::ffi::c_void,
+ ) {
+ let mut dc =
+ ::core::ptr::NonNull::new(klass.cast::<$crate::bindings::DeviceClass>()).unwrap();
+ dc.as_mut().realize = $realize_fn;
+ dc.as_mut().reset = $reset_fn;
+ dc.as_mut().vmsd = &$vmsd;
+ $crate::bindings::device_class_set_props(dc.as_mut(), $props.as_mut_ptr());
+ }
+ };
+}
+
+#[macro_export]
+macro_rules! define_property {
+ ($name:expr, $state:ty, $field:expr, $prop:expr, $type:expr, default = $defval:expr$(,)*) => {
+ $crate::bindings::Property {
+ name: {
+ #[used]
+ static _TEMP: &::core::ffi::CStr = $name;
+ _TEMP.as_ptr()
+ },
+ info: $prop,
+ offset: ::core::mem::offset_of!($state, $field)
+ .try_into()
+ .expect("Could not fit offset value to type"),
+ bitnr: 0,
+ bitmask: 0,
+ set_default: true,
+ defval: $crate::bindings::Property__bindgen_ty_1 { u: $defval.into() },
+ arrayoffset: 0,
+ arrayinfo: ::core::ptr::null(),
+ arrayfieldsize: 0,
+ link_type: ::core::ptr::null(),
+ }
+ };
+ ($name:expr, $state:ty, $field:expr, $prop:expr, $type:expr$(,)*) => {
+ $crate::bindings::Property {
+ name: {
+ #[used]
+ static _TEMP: &::core::ffi::CStr = $name;
+ _TEMP.as_ptr()
+ },
+ info: $prop,
+ offset: ::core::mem::offset_of!($state, $field)
+ .try_into()
+ .expect("Could not fit offset value to type"),
+ bitnr: 0,
+ bitmask: 0,
+ set_default: false,
+ defval: $crate::bindings::Property__bindgen_ty_1 { i: 0 },
+ arrayoffset: 0,
+ arrayinfo: ::core::ptr::null(),
+ arrayfieldsize: 0,
+ link_type: ::core::ptr::null(),
+ }
+ };
+}
+
+#[repr(C)]
+pub struct Properties<const N: usize>(pub OnceLock<[Property; N]>, pub fn() -> [Property; N]);
+
+impl<const N: usize> Properties<N> {
+ pub fn as_mut_ptr(&mut self) -> *mut Property {
+ _ = self.0.get_or_init(self.1);
+ self.0.get_mut().unwrap().as_mut_ptr()
+ }
+}
+
+#[macro_export]
+macro_rules! declare_properties {
+ ($ident:ident, $($prop:expr),*$(,)*) => {
+
+ const fn _calc_prop_len() -> usize {
+ let mut len = 1;
+ $({
+ _ = stringify!($prop);
+ len += 1;
+ })*
+ len
+ }
+ const PROP_LEN: usize = _calc_prop_len();
+
+ #[no_mangle]
+ fn _make_properties() -> [$crate::bindings::Property; PROP_LEN] {
+ [
+ $($prop),*,
+ unsafe { ::core::mem::MaybeUninit::<$crate::bindings::Property>::zeroed().assume_init() },
+ ]
+ }
+
+ #[no_mangle]
+ pub static mut $ident: $crate::device_class::Properties<PROP_LEN> = $crate::device_class::Properties(::std::sync::OnceLock::new(), _make_properties);
+ };
+}
+
+#[macro_export]
+macro_rules! vm_state_description {
+ ($(#[$outer:meta])*
+ $name:ident,
+ $(name: $vname:expr,)*
+ $(unmigratable: $um_val:expr,)*
+ ) => {
+ #[used]
+ $(#[$outer])*
+ pub static $name: $crate::bindings::VMStateDescription = $crate::bindings::VMStateDescription {
+ $(name: {
+ #[used]
+ static VMSTATE_NAME: &::core::ffi::CStr = $vname;
+ $vname.as_ptr()
+ },)*
+ unmigratable: true,
+ ..unsafe { ::core::mem::MaybeUninit::<$crate::bindings::VMStateDescription>::zeroed().assume_init() }
+ };
+ }
+}
diff --git a/rust/qemu-api/src/lib.rs b/rust/qemu-api/src/lib.rs
new file mode 100644
index 0000000000..6f02ac45e2
--- /dev/null
+++ b/rust/qemu-api/src/lib.rs
@@ -0,0 +1,100 @@
+// Copyright 2024 Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
+// SPDX-License-Identifier: GPL-2.0 OR GPL-3.0-or-later
+
+#![doc = include_str!("../README.md")]
+
+#[cfg(MESON_BINDINGS_RS)]
+extern crate _bindings_rs;
+
+#[cfg_attr(not(MESON_BINDINGS_RS), allow(
+ improper_ctypes_definitions,
+ improper_ctypes,
+ non_camel_case_types,
+ non_snake_case,
+ non_upper_case_globals
+))]
+#[cfg_attr(not(MESON_BINDINGS_RS), allow(
+ clippy::missing_const_for_fn,
+ clippy::too_many_arguments,
+ clippy::approx_constant,
+ clippy::use_self,
+ clippy::useless_transmute,
+ clippy::missing_safety_doc,
+))]
+#[cfg_attr(not(MESON_BINDINGS_RS), rustfmt::skip)]
+pub mod bindings;
+
+pub mod definitions;
+pub mod device_class;
+
+#[cfg(test)]
+mod tests;
+
+use std::alloc::{GlobalAlloc, Layout};
+
+extern "C" {
+ pub fn g_aligned_alloc0(
+ n_blocks: bindings::gsize,
+ n_block_bytes: bindings::gsize,
+ alignment: bindings::gsize,
+ ) -> bindings::gpointer;
+ pub fn g_aligned_free(mem: bindings::gpointer);
+ pub fn g_malloc0(n_bytes: bindings::gsize) -> bindings::gpointer;
+ pub fn g_free(mem: bindings::gpointer);
+}
+
+/// An allocator that uses the same allocator as QEMU in C.
+///
+/// It is enabled by default with the `allocator` feature.
+///
+/// To set it up manually as a global allocator in your crate:
+///
+/// ```ignore
+/// use qemu_api::QemuAllocator;
+///
+/// #[global_allocator]
+/// static GLOBAL: QemuAllocator = QemuAllocator::new();
+/// ```
+#[derive(Clone, Copy, Debug)]
+#[repr(C)]
+pub struct QemuAllocator {
+ _unused: [u8; 0],
+}
+
+#[cfg_attr(feature = "allocator", global_allocator)]
+pub static GLOBAL: QemuAllocator = QemuAllocator::new();
+
+impl QemuAllocator {
+ pub const fn new() -> Self {
+ Self { _unused: [] }
+ }
+}
+
+impl Default for QemuAllocator {
+ fn default() -> Self {
+ Self::new()
+ }
+}
+
+unsafe impl GlobalAlloc for QemuAllocator {
+ unsafe fn alloc(&self, layout: Layout) -> *mut u8 {
+ if layout.align() == 0 {
+ g_malloc0(layout.size().try_into().unwrap()).cast::<u8>()
+ } else {
+ g_aligned_alloc0(
+ layout.size().try_into().unwrap(),
+ 1,
+ layout.align().try_into().unwrap(),
+ )
+ .cast::<u8>()
+ }
+ }
+
+ unsafe fn dealloc(&self, ptr: *mut u8, layout: Layout) {
+ if layout.align() == 0 {
+ g_free(ptr.cast::<_>())
+ } else {
+ g_aligned_free(ptr.cast::<_>())
+ }
+ }
+}
diff --git a/rust/qemu-api/src/tests.rs b/rust/qemu-api/src/tests.rs
new file mode 100644
index 0000000000..88c26308ee
--- /dev/null
+++ b/rust/qemu-api/src/tests.rs
@@ -0,0 +1,48 @@
+// Copyright 2024 Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
+// SPDX-License-Identifier: GPL-2.0 OR GPL-3.0-or-later
+
+use crate::{
+ bindings::*, declare_properties, define_property, device_class_init, vm_state_description,
+};
+
+#[test]
+fn test_device_decl_macros() {
+ // Test that macros can compile.
+ vm_state_description! {
+ VMSTATE,
+ name: c"name",
+ unmigratable: true,
+ }
+
+ #[repr(C)]
+ pub struct DummyState {
+ pub char_backend: CharBackend,
+ pub migrate_clock: bool,
+ }
+
+ declare_properties! {
+ DUMMY_PROPERTIES,
+ define_property!(
+ c"chardev",
+ DummyState,
+ char_backend,
+ unsafe { &qdev_prop_chr },
+ CharBackend
+ ),
+ define_property!(
+ c"migrate-clk",
+ DummyState,
+ migrate_clock,
+ unsafe { &qdev_prop_bool },
+ bool
+ ),
+ }
+
+ device_class_init! {
+ dummy_class_init,
+ props => DUMMY_PROPERTIES,
+ realize_fn => None,
+ reset_fn => None,
+ vmsd => VMSTATE,
+ }
+}
diff --git a/rust/rustfmt.toml b/rust/rustfmt.toml
new file mode 100644
index 0000000000..ebecb99fe0
--- /dev/null
+++ b/rust/rustfmt.toml
@@ -0,0 +1,7 @@
+edition = "2021"
+format_generated_files = false
+format_code_in_doc_comments = true
+format_strings = true
+imports_granularity = "Crate"
+group_imports = "StdExternalCrate"
+wrap_comments = true
--
2.44.0On 8/15/2024 7:42 PM, Manos Pitsidianakis wrote:
> Add rust/qemu-api, which exposes rust-bindgen generated FFI bindings and
> provides some declaration macros for symbols visible to the rest of
> QEMU.
>
> Co-authored-by: Junjie Mao <junjie.mao@intel.com>
> Co-authored-by: Paolo Bonzini <pbonzini@redhat.com>
> Signed-off-by: Junjie Mao <junjie.mao@intel.com>
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
> Signed-off-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
> ---
[snip]
> +
> +#[macro_export]
> +macro_rules! declare_properties {
> + ($ident:ident, $($prop:expr),*$(,)*) => {
> +
> + const fn _calc_prop_len() -> usize {
> + let mut len = 1;
> + $({
> + _ = stringify!($prop);
> + len += 1;
> + })*
> + len
> + }
> + const PROP_LEN: usize = _calc_prop_len();
> +
> + #[no_mangle]
> + fn _make_properties() -> [$crate::bindings::Property; PROP_LEN] {
#[no_mangle] also makes _make_properties externally visible and thus will cause
duplicate-symbol-definition errors at link time when multiple devices are enabled.
Since it is only used in the definition of $ident below, shall we just remove
#[no_mangle] for _make_properties?
---
Best Regards
Junjie Mao
> + [
> + $($prop),*,
> + unsafe { ::core::mem::MaybeUninit::<$crate::bindings::Property>::zeroed().assume_init() },
> + ]
> + }
> +
> + #[no_mangle]
> + pub static mut $ident: $crate::device_class::Properties<PROP_LEN> = $crate::device_class::Properties(::std::sync::OnceLock::new(), _make_properties);
> + };
> +}
> +
> +#[macro_export]
> +macro_rules! vm_state_description {
> + ($(#[$outer:meta])*
> + $name:ident,
> + $(name: $vname:expr,)*
> + $(unmigratable: $um_val:expr,)*
> + ) => {
> + #[used]
> + $(#[$outer])*
> + pub static $name: $crate::bindings::VMStateDescription = $crate::bindings::VMStateDescription {
> + $(name: {
> + #[used]
> + static VMSTATE_NAME: &::core::ffi::CStr = $vname;
> + $vname.as_ptr()
> + },)*
> + unmigratable: true,
> + ..unsafe { ::core::mem::MaybeUninit::<$crate::bindings::VMStateDescription>::zeroed().assume_init() }
> + };
> + }
> +}
Hi Manos, On 15/8/24 13:42, Manos Pitsidianakis wrote: > Add rust/qemu-api, which exposes rust-bindgen generated FFI bindings and > provides some declaration macros for symbols visible to the rest of > QEMU. > > Co-authored-by: Junjie Mao <junjie.mao@intel.com> > Co-authored-by: Paolo Bonzini <pbonzini@redhat.com> > Signed-off-by: Junjie Mao <junjie.mao@intel.com> > Signed-off-by: Paolo Bonzini <pbonzini@redhat.com> > Signed-off-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org> > --- > MAINTAINERS | 6 ++ > rust/meson.build | 9 +++ > rust/qemu-api/.gitignore | 2 + > rust/qemu-api/Cargo.lock | 7 +++ > rust/qemu-api/Cargo.toml | 23 +++++++ > rust/qemu-api/README.md | 17 +++++ > rust/qemu-api/build.rs | 13 ++++ > rust/qemu-api/meson.build | 17 +++++ > rust/qemu-api/rustfmt.toml | 1 + > rust/qemu-api/src/bindings.rs | 7 +++ > rust/qemu-api/src/definitions.rs | 108 ++++++++++++++++++++++++++++++++ > rust/qemu-api/src/device_class.rs | 128 ++++++++++++++++++++++++++++++++++++++ > rust/qemu-api/src/lib.rs | 100 +++++++++++++++++++++++++++++ > rust/qemu-api/src/tests.rs | 48 ++++++++++++++ > rust/rustfmt.toml | 7 +++ > 15 files changed, 493 insertions(+) > > diff --git a/MAINTAINERS b/MAINTAINERS > index 5464cb2b03..56a88048d2 100644 > --- a/MAINTAINERS > +++ b/MAINTAINERS > @@ -3348,6 +3348,12 @@ F: hw/core/register.c > F: include/hw/register.h > F: include/hw/registerfields.h > > +Rust > +M: Manos Pitsidianakis <manos.pitsidianakis@linaro.org> > +S: Maintained > +F: rust/qemu-api > +F: rust/rustfmt.toml Few lines in docs/devel/rust.rst would be welcomed, > diff --git a/rust/qemu-api/Cargo.toml b/rust/qemu-api/Cargo.toml > new file mode 100644 > index 0000000000..51260cbe42 > --- /dev/null > +++ b/rust/qemu-api/Cargo.toml > @@ -0,0 +1,23 @@ > +[package] > +name = "qemu_api" > +version = "0.1.0" > +edition = "2021" > +license = "GPL-2.0 OR GPL-3.0-or-later" in particular explaining the license choice. Should all rust code use it? Thanks, Phil.
On Thu, Aug 15, 2024 at 04:01:17PM +0200, Philippe Mathieu-Daudé wrote:
> Hi Manos,
>
> On 15/8/24 13:42, Manos Pitsidianakis wrote:
> > Add rust/qemu-api, which exposes rust-bindgen generated FFI bindings and
> > provides some declaration macros for symbols visible to the rest of
> > QEMU.
> >
> > Co-authored-by: Junjie Mao <junjie.mao@intel.com>
> > Co-authored-by: Paolo Bonzini <pbonzini@redhat.com>
> > Signed-off-by: Junjie Mao <junjie.mao@intel.com>
> > Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
> > Signed-off-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
> > ---
> > MAINTAINERS | 6 ++
> > rust/meson.build | 9 +++
> > rust/qemu-api/.gitignore | 2 +
> > rust/qemu-api/Cargo.lock | 7 +++
> > rust/qemu-api/Cargo.toml | 23 +++++++
> > rust/qemu-api/README.md | 17 +++++
> > rust/qemu-api/build.rs | 13 ++++
> > rust/qemu-api/meson.build | 17 +++++
> > rust/qemu-api/rustfmt.toml | 1 +
> > rust/qemu-api/src/bindings.rs | 7 +++
> > rust/qemu-api/src/definitions.rs | 108 ++++++++++++++++++++++++++++++++
> > rust/qemu-api/src/device_class.rs | 128 ++++++++++++++++++++++++++++++++++++++
> > rust/qemu-api/src/lib.rs | 100 +++++++++++++++++++++++++++++
> > rust/qemu-api/src/tests.rs | 48 ++++++++++++++
> > rust/rustfmt.toml | 7 +++
> > 15 files changed, 493 insertions(+)
> > diff --git a/rust/qemu-api/Cargo.toml b/rust/qemu-api/Cargo.toml
> > new file mode 100644
> > index 0000000000..51260cbe42
> > --- /dev/null
> > +++ b/rust/qemu-api/Cargo.toml
> > @@ -0,0 +1,23 @@
> > +[package]
> > +name = "qemu_api"
> > +version = "0.1.0"
> > +edition = "2021"
>
> > +license = "GPL-2.0 OR GPL-3.0-or-later"
>
> in particular explaining the license choice.
Semantically this is an overly verbose way of saying
"GPL-2.0-or-later", so just simplify this.
> Should all rust code use it?
GPL-2.0-or-later is what we expect all new QEMU contributions to be
licensed as, regardless of language[1], so this looks desirable.
With regards,
Daniel
[1] unless they're derived from one of the few pieces of code under
different terms
--
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org -o- https://fstop138.berrange.com :|
|: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
On 15/8/24 17:06, Daniel P. Berrangé wrote: > On Thu, Aug 15, 2024 at 04:01:17PM +0200, Philippe Mathieu-Daudé wrote: >> Hi Manos, >> >> On 15/8/24 13:42, Manos Pitsidianakis wrote: >>> Add rust/qemu-api, which exposes rust-bindgen generated FFI bindings and >>> provides some declaration macros for symbols visible to the rest of >>> QEMU. >>> >>> Co-authored-by: Junjie Mao <junjie.mao@intel.com> >>> Co-authored-by: Paolo Bonzini <pbonzini@redhat.com> >>> Signed-off-by: Junjie Mao <junjie.mao@intel.com> >>> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com> >>> Signed-off-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org> >>> --- >>> MAINTAINERS | 6 ++ >>> rust/meson.build | 9 +++ >>> rust/qemu-api/.gitignore | 2 + >>> rust/qemu-api/Cargo.lock | 7 +++ >>> rust/qemu-api/Cargo.toml | 23 +++++++ >>> rust/qemu-api/README.md | 17 +++++ >>> rust/qemu-api/build.rs | 13 ++++ >>> rust/qemu-api/meson.build | 17 +++++ >>> rust/qemu-api/rustfmt.toml | 1 + >>> rust/qemu-api/src/bindings.rs | 7 +++ >>> rust/qemu-api/src/definitions.rs | 108 ++++++++++++++++++++++++++++++++ >>> rust/qemu-api/src/device_class.rs | 128 ++++++++++++++++++++++++++++++++++++++ >>> rust/qemu-api/src/lib.rs | 100 +++++++++++++++++++++++++++++ >>> rust/qemu-api/src/tests.rs | 48 ++++++++++++++ >>> rust/rustfmt.toml | 7 +++ >>> 15 files changed, 493 insertions(+) > >>> diff --git a/rust/qemu-api/Cargo.toml b/rust/qemu-api/Cargo.toml >>> new file mode 100644 >>> index 0000000000..51260cbe42 >>> --- /dev/null >>> +++ b/rust/qemu-api/Cargo.toml >>> @@ -0,0 +1,23 @@ >>> +[package] >>> +name = "qemu_api" >>> +version = "0.1.0" >>> +edition = "2021" >> >>> +license = "GPL-2.0 OR GPL-3.0-or-later" >> >> in particular explaining the license choice. > > Semantically this is an overly verbose way of saying > "GPL-2.0-or-later", so just simplify this. Indeed. Manos, please use GPL-2.0-or-later to keep it simple. > >> Should all rust code use it? > > GPL-2.0-or-later is what we expect all new QEMU contributions to be > licensed as, regardless of language[1], so this looks desirable. Agreed. > > With regards, > Daniel > > [1] unless they're derived from one of the few pieces of code under > different terms
On Fri, 16 Aug 2024 11:34, Philippe Mathieu-Daudé <philmd@linaro.org> wrote: >On 15/8/24 17:06, Daniel P. Berrangé wrote: >> On Thu, Aug 15, 2024 at 04:01:17PM +0200, Philippe Mathieu-Daudé wrote: >>> Hi Manos, >>> >>> On 15/8/24 13:42, Manos Pitsidianakis wrote: >>>> Add rust/qemu-api, which exposes rust-bindgen generated FFI bindings and >>>> provides some declaration macros for symbols visible to the rest of >>>> QEMU. >>>> >>>> Co-authored-by: Junjie Mao <junjie.mao@intel.com> >>>> Co-authored-by: Paolo Bonzini <pbonzini@redhat.com> >>>> Signed-off-by: Junjie Mao <junjie.mao@intel.com> >>>> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com> >>>> Signed-off-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org> >>>> --- >>>> MAINTAINERS | 6 ++ >>>> rust/meson.build | 9 +++ >>>> rust/qemu-api/.gitignore | 2 + >>>> rust/qemu-api/Cargo.lock | 7 +++ >>>> rust/qemu-api/Cargo.toml | 23 +++++++ >>>> rust/qemu-api/README.md | 17 +++++ >>>> rust/qemu-api/build.rs | 13 ++++ >>>> rust/qemu-api/meson.build | 17 +++++ >>>> rust/qemu-api/rustfmt.toml | 1 + >>>> rust/qemu-api/src/bindings.rs | 7 +++ >>>> rust/qemu-api/src/definitions.rs | 108 ++++++++++++++++++++++++++++++++ >>>> rust/qemu-api/src/device_class.rs | 128 ++++++++++++++++++++++++++++++++++++++ >>>> rust/qemu-api/src/lib.rs | 100 +++++++++++++++++++++++++++++ >>>> rust/qemu-api/src/tests.rs | 48 ++++++++++++++ >>>> rust/rustfmt.toml | 7 +++ >>>> 15 files changed, 493 insertions(+) >> >>>> diff --git a/rust/qemu-api/Cargo.toml b/rust/qemu-api/Cargo.toml >>>> new file mode 100644 >>>> index 0000000000..51260cbe42 >>>> --- /dev/null >>>> +++ b/rust/qemu-api/Cargo.toml >>>> @@ -0,0 +1,23 @@ >>>> +[package] >>>> +name = "qemu_api" >>>> +version = "0.1.0" >>>> +edition = "2021" >>> >>>> +license = "GPL-2.0 OR GPL-3.0-or-later" >>> >>> in particular explaining the license choice. >> >> Semantically this is an overly verbose way of saying >> "GPL-2.0-or-later", so just simplify this. > >Indeed. Manos, please use GPL-2.0-or-later to keep it simple. > >> >>> Should all rust code use it? >> >> GPL-2.0-or-later is what we expect all new QEMU contributions to be >> licensed as, regardless of language[1], so this looks desirable. > >Agreed. Thanks, will replace it. Manos
On Thu, 15 Aug 2024 17:01, Philippe Mathieu-Daudé <philmd@linaro.org> wrote: >Hi Manos, > >On 15/8/24 13:42, Manos Pitsidianakis wrote: >> Add rust/qemu-api, which exposes rust-bindgen generated FFI bindings and >> provides some declaration macros for symbols visible to the rest of >> QEMU. >> >> Co-authored-by: Junjie Mao <junjie.mao@intel.com> >> Co-authored-by: Paolo Bonzini <pbonzini@redhat.com> >> Signed-off-by: Junjie Mao <junjie.mao@intel.com> >> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com> >> Signed-off-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org> >> --- >> MAINTAINERS | 6 ++ >> rust/meson.build | 9 +++ >> rust/qemu-api/.gitignore | 2 + >> rust/qemu-api/Cargo.lock | 7 +++ >> rust/qemu-api/Cargo.toml | 23 +++++++ >> rust/qemu-api/README.md | 17 +++++ >> rust/qemu-api/build.rs | 13 ++++ >> rust/qemu-api/meson.build | 17 +++++ >> rust/qemu-api/rustfmt.toml | 1 + >> rust/qemu-api/src/bindings.rs | 7 +++ >> rust/qemu-api/src/definitions.rs | 108 ++++++++++++++++++++++++++++++++ >> rust/qemu-api/src/device_class.rs | 128 ++++++++++++++++++++++++++++++++++++++ >> rust/qemu-api/src/lib.rs | 100 +++++++++++++++++++++++++++++ >> rust/qemu-api/src/tests.rs | 48 ++++++++++++++ >> rust/rustfmt.toml | 7 +++ >> 15 files changed, 493 insertions(+) >> >> diff --git a/MAINTAINERS b/MAINTAINERS >> index 5464cb2b03..56a88048d2 100644 >> --- a/MAINTAINERS >> +++ b/MAINTAINERS >> @@ -3348,6 +3348,12 @@ F: hw/core/register.c >> F: include/hw/register.h >> F: include/hw/registerfields.h >> >> +Rust >> +M: Manos Pitsidianakis <manos.pitsidianakis@linaro.org> >> +S: Maintained >> +F: rust/qemu-api >> +F: rust/rustfmt.toml > >Few lines in docs/devel/rust.rst would be welcomed, In another patch. There's so much to do! > >> diff --git a/rust/qemu-api/Cargo.toml b/rust/qemu-api/Cargo.toml >> new file mode 100644 >> index 0000000000..51260cbe42 >> --- /dev/null >> +++ b/rust/qemu-api/Cargo.toml >> @@ -0,0 +1,23 @@ >> +[package] >> +name = "qemu_api" >> +version = "0.1.0" >> +edition = "2021" > >> +license = "GPL-2.0 OR GPL-3.0-or-later" > >in particular explaining the license choice. > >Should all rust code use it? It's an OR, so all rust code can use GPL-2.0 like the rest of QEMU.
© 2016 - 2024 Red Hat, Inc.