1 // Copyright 2024, Linaro Limited 2 // Author(s): Manos Pitsidianakis <manos.pitsidianakis@linaro.org> 3 // SPDX-License-Identifier: GPL-2.0-or-later 4 5 use proc_macro::TokenStream; 6 use proc_macro2::Span; 7 use quote::{quote, quote_spanned}; 8 use syn::{ 9 parse_macro_input, parse_quote, punctuated::Punctuated, token::Comma, Data, DeriveInput, Field, 10 Fields, Ident, Type, Visibility, 11 }; 12 13 struct CompileError(String, Span); 14 15 impl From<CompileError> for proc_macro2::TokenStream { 16 fn from(err: CompileError) -> Self { 17 let CompileError(msg, span) = err; 18 quote_spanned! { span => compile_error!(#msg); } 19 } 20 } 21 22 fn is_c_repr(input: &DeriveInput, msg: &str) -> Result<(), CompileError> { 23 let expected = parse_quote! { #[repr(C)] }; 24 25 if input.attrs.iter().any(|attr| attr == &expected) { 26 Ok(()) 27 } else { 28 Err(CompileError( 29 format!("#[repr(C)] required for {}", msg), 30 input.ident.span(), 31 )) 32 } 33 } 34 35 fn derive_object_or_error(input: DeriveInput) -> Result<proc_macro2::TokenStream, CompileError> { 36 is_c_repr(&input, "#[derive(Object)]")?; 37 38 let name = &input.ident; 39 Ok(quote! { 40 ::qemu_api::module_init! { 41 MODULE_INIT_QOM => unsafe { 42 ::qemu_api::bindings::type_register_static(&<#name as ::qemu_api::qom::ObjectImpl>::TYPE_INFO); 43 } 44 } 45 }) 46 } 47 48 #[proc_macro_derive(Object)] 49 pub fn derive_object(input: TokenStream) -> TokenStream { 50 let input = parse_macro_input!(input as DeriveInput); 51 let expanded = derive_object_or_error(input).unwrap_or_else(Into::into); 52 53 TokenStream::from(expanded) 54 } 55 56 fn get_fields(input: &DeriveInput) -> Result<&Punctuated<Field, Comma>, CompileError> { 57 if let Data::Struct(s) = &input.data { 58 if let Fields::Named(fs) = &s.fields { 59 Ok(&fs.named) 60 } else { 61 Err(CompileError( 62 "Cannot generate offsets for unnamed fields.".to_string(), 63 input.ident.span(), 64 )) 65 } 66 } else { 67 Err(CompileError( 68 "Cannot generate offsets for union or enum.".to_string(), 69 input.ident.span(), 70 )) 71 } 72 } 73 74 #[rustfmt::skip::macros(quote)] 75 fn derive_offsets_or_error(input: DeriveInput) -> Result<proc_macro2::TokenStream, CompileError> { 76 is_c_repr(&input, "#[derive(offsets)]")?; 77 78 let name = &input.ident; 79 let fields = get_fields(&input)?; 80 let field_names: Vec<&Ident> = fields.iter().map(|f| f.ident.as_ref().unwrap()).collect(); 81 let field_types: Vec<&Type> = fields.iter().map(|f| &f.ty).collect(); 82 let field_vis: Vec<&Visibility> = fields.iter().map(|f| &f.vis).collect(); 83 84 Ok(quote! { 85 ::qemu_api::with_offsets! { 86 struct #name { 87 #(#field_vis #field_names: #field_types,)* 88 } 89 } 90 }) 91 } 92 93 #[proc_macro_derive(offsets)] 94 pub fn derive_offsets(input: TokenStream) -> TokenStream { 95 let input = parse_macro_input!(input as DeriveInput); 96 let expanded = derive_offsets_or_error(input).unwrap_or_else(Into::into); 97 98 TokenStream::from(expanded) 99 } 100