Remove #[axplat_macros::def_plat_interface] (#46)

* [feat] remove axplat_macros::def_plat_interface

It can be replaced with `crate_interface::def_interface(gen_caller)`
with crate_interface >= 0.2.0

* [chore] bump version of axplat

axplat 0.3.0 -> 0.4.0
axplat_macros 0.1.0 -> 0.2.0
cargo-axplat 0.2.5 -> 0.3.0

Author: equation314

Cargo.lock

@@ -36,6 +36,6 @@ repository = "https://github.com/arceos-org/axplat_crates"
 
 [workspace.dependencies]
 axcpu = "0.2"
-axplat = { version = "0.3.0", path = "./axplat" }
-axplat-macros = { version = "0.1.0", path = "./axplat-macros" }
-axplat-aarch64-peripherals = { version = "0.3.0", path = "platforms/axplat-aarch64-peripherals" }
+axplat = { version = "0.4.0", path = "./axplat" }
+axplat-macros = { version = "0.2.0", path = "./axplat-macros" }
+axplat-aarch64-peripherals = { version = "0.3.0", path = "platforms/axplat-aarch64-peripherals" }

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "axplat-macros"
-version = "0.1.0"
+version = "0.2.0"
 description = "Procedural macros for the `axplat` crate"
 documentation = "https://docs.rs/axplat-macros"
 keywords = ["arceos", "os", "hal", "embedded", "macros"]
@@ -16,8 +16,5 @@ proc-macro2 = "1.0"
 quote = "1.0"
 syn = { version = "2.0", features = ["full"] }
 
-[dev-dependencies]
-crate_interface = "0.1"
-
 [lib]
 proc-macro = true

axplat-macros/Cargo.toml

@@ -3,7 +3,7 @@
 use proc_macro::TokenStream;
 use proc_macro2::Span;
 use quote::quote;
-use syn::{Error, FnArg, ItemFn, ItemTrait, ReturnType, TraitItem};
+use syn::{Error, FnArg, ItemFn, ReturnType};
 
 fn compiler_error(err: Error) -> TokenStream {
     err.to_compile_error().into()
@@ -104,55 +104,3 @@ pub fn secondary_main(attr: TokenStream, item: TokenStream) -> TokenStream {
         "expect a function with type `fn(cpu_id: usize) -> !`",
     )
 }
-
-#[doc(hidden)]
-#[proc_macro_attribute]
-pub fn def_plat_interface(attr: TokenStream, item: TokenStream) -> TokenStream {
-    if !attr.is_empty() {
-        return compiler_error(Error::new(
-            Span::call_site(),
-            "expect an empty attribute: `#[def_plat_interface]`",
-        ));
-    }
-
-    let trait_ast = syn::parse_macro_input!(item as ItemTrait);
-    let trait_name = &trait_ast.ident;
-
-    let mut fn_list = vec![];
-    for item in &trait_ast.items {
-        if let TraitItem::Fn(method) = item {
-            let attrs = &method.attrs;
-            let sig = &method.sig;
-            let fn_name = &sig.ident;
-
-            let mut args = vec![];
-            for arg in &sig.inputs {
-                match arg {
-                    FnArg::Receiver(_) => {
-                        return compiler_error(Error::new_spanned(
-                            arg,
-                            "`self` is not allowed in the interface definition",
-                        ));
-                    }
-                    FnArg::Typed(ty) => args.push(ty.pat.clone()),
-                }
-            }
-
-            fn_list.push(quote! {
-                #(#attrs)*
-                #[inline]
-                pub #sig {
-                    crate::__priv::call_interface!(#trait_name::#fn_name, #(#args),* )
-                }
-            });
-        }
-    }
-
-    quote! {
-        #[crate::__priv::def_interface]
-        #trait_ast
-
-        #(#fn_list)*
-    }
-    .into()
-}

axplat-macros/src/lib.rs

@@ -1,6 +1,6 @@
 [package]
 name = "axplat"
-version = "0.3.0"
+version = "0.4.0"
 description = "This crate provides a unified abstraction layer for diverse hardware platforms."
 documentation = "https://docs.rs/axplat"
 keywords = ["arceos", "os", "hal", "embedded"]
@@ -18,11 +18,11 @@ irq = ["dep:handler_table"]
 [dependencies]
 memory_addr = "0.4"
 bitflags = "2.6"
-crate_interface = "0.1"
+crate_interface = "0.3"
 handler_table = { version = "0.1.2", optional = true }
 const-str = "0.6.2"
-axplat-macros = { workspace = true }
 kspin = "0.1"
+axplat-macros = { workspace = true }
 
 [package.metadata.docs.rs]
 all-features = true

axplat/Cargo.toml

@@ -2,7 +2,7 @@
 
 [![Crates.io](https://img.shields.io/crates/v/axplat)](https://crates.io/crates/axplat)
 [![Docs.rs](https://docs.rs/axplat/badge.svg)](https://docs.rs/axplat)
-[![CI](https://github.com/arceos-org/axplat_crates/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/arceos-org/axplat_crates/actions/workflows/ci.yml)
+[![CI](https://github.com/arceos-org/axplat_crates/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/arceos-org/axplat_crates/actions/workflows/test.yml)
 
 This crate provides a unified abstraction layer for diverse hardware platforms. It allows kernel developers to bootstrap custom kernels across various platforms and interact with essential peripherals using hardware-agnostic APIs.
 
@@ -48,12 +48,12 @@ More APIs can be found in the [documentation](https://docs.rs/axplat/latest/axpl
 #### 1. Implement each interface trait
 
 ```rust
-use axplat::impl_plat_interface;
+use axplat::impl_interface;
 
 /// Implementation of Platform initialization.
 struct InitIfImpl;
 
-#[impl_plat_interface]
+#[impl_interface]
 impl axplat::init::InitIf for InitIfImpl {
     fn init_early(cpu_id: usize, arg: usize) { /* ... */ }
     fn init_later(cpu_id: usize, arg: usize) { /* ... */ }
@@ -64,7 +64,7 @@ impl axplat::init::InitIf for InitIfImpl {
 /// Implementation of Console input and output.
 struct ConsoleIfImpl;
 
-#[impl_plat_interface]
+#[impl_interface]
 impl axplat::console::ConsoleIf for ConsoleIfImpl {
     fn write_bytes(bytes: &[u8]) { /* ... */ }
     fn read_bytes(bytes: &mut [u8]) -> usize { /* ... */ 0 }

axplat/README.md

@@ -3,7 +3,7 @@
 use core::fmt::{Arguments, Result, Write};
 
 /// Console input and output interface.
-#[def_plat_interface]
+#[def_interface(gen_caller)]
 pub trait ConsoleIf {
     /// Writes given bytes to the console.
     fn write_bytes(bytes: &[u8]);

axplat/src/console.rs

@@ -1,7 +1,7 @@
 //! Platform initialization.
 
 /// Platform initialization interface.
-#[def_plat_interface]
+#[def_interface(gen_caller)]
 pub trait InitIf {
     /// Initializes the platform at the early stage for the primary core.
     ///

axplat/src/init.rs

@@ -27,7 +27,7 @@ pub enum IpiTarget {
 }
 
 /// IRQ management interface.
-#[def_plat_interface]
+#[def_interface(gen_caller)]
 pub trait IrqIf {
     /// Enables or disables the given IRQ.
     fn set_enable(irq: usize, enabled: bool);

axplat/src/irq.rs

@@ -3,7 +3,7 @@
 #![doc = include_str!("../README.md")]
 
 #[macro_use]
-extern crate axplat_macros;
+extern crate crate_interface;
 
 pub mod console;
 pub mod init;
@@ -14,15 +14,14 @@ pub mod power;
 pub mod time;
 
 pub use axplat_macros::main;
-pub use crate_interface::impl_interface as impl_plat_interface;
+pub use crate_interface::impl_interface;
 
 #[cfg(feature = "smp")]
 pub use axplat_macros::secondary_main;
 
 #[doc(hidden)]
 pub mod __priv {
     pub use const_str::equal as const_str_eq;
-    pub use crate_interface::{call_interface, def_interface};
 }
 
 /// Checks that two strings are equal. If they are not equal, it will cause a compile-time