1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
/*
* SPDX-FileCopyrightText: 2023 Tommaso Fontana
* SPDX-FileCopyrightText: 2023 Inria
* SPDX-FileCopyrightText: 2023 Sebastiano Vigna
*
* SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later
*/
//! Derive procedural macros for the [`mem_dbg`](https://crates.io/crates/mem_dbg) crate.
use proc_macro::TokenStream;
use quote::{quote, ToTokens};
use syn::{
parse_macro_input, parse_quote, parse_quote_spanned, spanned::Spanned, Data, DeriveInput,
};
/**
Generate a `mem_dbg::MemSize` implementation for custom types.
Presently we do not support unions.
The attribute `copy_type` can be used on [`Copy`] types that do not contain references
to make `MemSize::mem_size` faster on arrays, vectors and slices. Note that specifying
`copy_type` will add the bound that the type is `Copy + 'static`.
See `mem_dbg::CopyType` for more details.
*/
#[proc_macro_derive(MemSize, attributes(copy_type))]
pub fn mem_dbg_mem_size(input: TokenStream) -> TokenStream {
let mut input = parse_macro_input!(input as DeriveInput);
let name = input.ident;
input.generics.make_where_clause();
let (impl_generics, ty_generics, where_clause) = input.generics.split_for_impl();
let mut where_clause = where_clause.unwrap().clone(); // We just created it
let is_copy_type = input
.attrs
.iter()
.any(|x| x.meta.path().is_ident("copy_type"));
let copy_type: syn::Expr = if is_copy_type {
where_clause
.predicates
.push(parse_quote_spanned!(name.span()=> Self: Copy + 'static));
parse_quote!(mem_dbg::True)
} else {
parse_quote!(mem_dbg::False)
};
match input.data {
Data::Struct(s) => {
let mut fields_ident = vec![];
let mut fields_ty = vec![];
s.fields.iter().enumerate().for_each(|(field_idx, field)| {
fields_ident.push(
field
.ident
.to_owned()
.map(|t| t.to_token_stream())
.unwrap_or_else(|| syn::Index::from(field_idx).to_token_stream()),
);
fields_ty.push(field.ty.to_token_stream());
let ty = &field.ty;
where_clause
.predicates
.push(parse_quote_spanned!(field.span()=> #ty: mem_dbg::MemSize));
});
quote! {
#[automatically_derived]
impl #impl_generics mem_dbg::CopyType for #name #ty_generics #where_clause
{
type Copy = #copy_type;
}
#[automatically_derived]
impl #impl_generics mem_dbg::MemSize for #name #ty_generics #where_clause {
fn mem_size(&self, _memsize_flags: mem_dbg::SizeFlags) -> usize {
let mut bytes = core::mem::size_of::<Self>();
#(bytes += self.#fields_ident.mem_size(_memsize_flags) - core::mem::size_of::<#fields_ty>();)*
bytes
}
}
}
}
Data::Enum(e) => {
let mut variants = Vec::new();
let mut variant_sizes = Vec::new();
e.variants.iter().for_each(|variant| {
let mut res = variant.ident.to_owned().to_token_stream();
let mut var_args_size = quote! {core::mem::size_of::<Self>()};
match &variant.fields {
syn::Fields::Unit => {}
syn::Fields::Named(fields) => {
let mut args = proc_macro2::TokenStream::new();
fields
.named
.iter()
.map(|field| {
let ty = &field.ty;
where_clause
.predicates
.push(parse_quote_spanned!(field.span()=> #ty: mem_dbg::MemSize));
(field.ident.as_ref().unwrap(), field.ty.to_token_stream())
})
.for_each(|(ident, ty)| {
var_args_size.extend([quote! {
+ #ident.mem_size(_memsize_flags) - core::mem::size_of::<#ty>()
}]);
args.extend([ident.to_token_stream()]);
args.extend([quote! {,}]);
});
// extend res with the args sourrounded by curly braces
res.extend(quote! {
{ #args }
});
}
syn::Fields::Unnamed(fields) => {
let mut args = proc_macro2::TokenStream::new();
fields.unnamed.iter().enumerate().for_each(|(field_idx, field)| {
let ident = syn::Ident::new(
&format!("v{}", field_idx),
proc_macro2::Span::call_site(),
)
.to_token_stream();
let ty = field.ty.to_token_stream();
var_args_size.extend([quote! {
+ #ident.mem_size(_memsize_flags) - core::mem::size_of::<#ty>()
}]);
args.extend([ident]);
args.extend([quote! {,}]);
where_clause
.predicates
.push(parse_quote_spanned!(field.span()=> #ty: mem_dbg::MemSize));
});
// extend res with the args sourrounded by curly braces
res.extend(quote! {
( #args )
});
}
}
variants.push(res);
variant_sizes.push(var_args_size);
});
quote! {
#[automatically_derived]
impl #impl_generics mem_dbg::CopyType for #name #ty_generics #where_clause
{
type Copy = #copy_type;
}
#[automatically_derived]
impl #impl_generics mem_dbg::MemSize for #name #ty_generics #where_clause {
fn mem_size(&self, _memsize_flags: mem_dbg::SizeFlags) -> usize {
match self {
#(
#name::#variants => #variant_sizes,
)*
}
}
}
}
}
Data::Union(_) => unimplemented!("Unions are not supported"),
}.into()
}
/**
Generate a `mem_dbg::MemDbg` implementation for custom types.
Presently we do not support unions.
*/
#[proc_macro_derive(MemDbg)]
pub fn mem_dbg_mem_dbg(input: TokenStream) -> TokenStream {
let mut input = parse_macro_input!(input as DeriveInput);
let name = input.ident;
input.generics.make_where_clause();
let (impl_generics, ty_generics, where_clause) = input.generics.split_for_impl();
let mut where_clause = where_clause.unwrap().clone(); // We just created it
match input.data {
Data::Struct(s) => {
let code = s
.fields
.iter()
.enumerate()
.map(|(field_idx, field)| {
let field_ident = field
.ident
.to_owned()
.map(|t| t.to_token_stream())
.unwrap_or_else(|| syn::Index::from(field_idx).to_token_stream());
let fields_str = field
.ident
.to_owned()
.map(|t| t.to_string().to_token_stream())
.unwrap_or_else(|| field_idx.to_string().to_token_stream());
let ty = &field.ty;
where_clause
.predicates
.push(parse_quote_spanned!(field.span()=> #ty: mem_dbg::MemDbgImpl));
let is_last = field_idx == s.fields.len().saturating_sub(1);
quote!{self.#field_ident.mem_dbg_depth_on(_memdbg_writer, _memdbg_total_size, _memdbg_max_depth, _memdbg_prefix, Some(#fields_str), #is_last, _memdbg_flags)?;}
})
.collect::<Vec<_>>();
quote! {
#[automatically_derived]
impl #impl_generics mem_dbg::MemDbgImpl for #name #ty_generics #where_clause {
#[inline(always)]
fn _mem_dbg_rec_on(
&self,
_memdbg_writer: &mut impl core::fmt::Write,
_memdbg_total_size: usize,
_memdbg_max_depth: usize,
_memdbg_prefix: &mut String,
_memdbg_is_last: bool,
_memdbg_flags: mem_dbg::DbgFlags,
) -> core::fmt::Result {
#(#code)*
Ok(())
}
}
}
}
Data::Enum(e) => {
let mut variants = Vec::new();
let mut variants_code = Vec::new();
e.variants.iter().for_each(|variant| {
let mut res = variant.ident.to_owned().to_token_stream();
let mut variant_code = quote! {};
let mut arrow = '╰';
match &variant.fields {
syn::Fields::Unit => {},
syn::Fields::Named(fields) => {
let mut args = proc_macro2::TokenStream::new();
if !fields.named.is_empty() {
arrow = '├';
}
fields
.named
.iter()
.enumerate()
.for_each(|(idx, field)| {
let ident = field.ident.as_ref().unwrap();
let field_name = format!("{}", ident);
let is_last = idx == fields.named.len().saturating_sub(1);
variant_code.extend([quote! {
#ident.mem_dbg_depth_on(_memdbg_writer, _memdbg_total_size, _memdbg_max_depth, _memdbg_prefix, Some(#field_name), #is_last, _memdbg_flags)?;
}]);
args.extend([ident.to_token_stream()]);
args.extend([quote! {,}]);
let ty = &field.ty;
where_clause
.predicates
.push(parse_quote_spanned!(field.span()=> #ty: mem_dbg::MemDbgImpl));
});
// extend res with the args sourrounded by curly braces
res.extend(quote! {
{ #args }
});
}
syn::Fields::Unnamed(fields) => {
let mut args = proc_macro2::TokenStream::new();
if !fields.unnamed.is_empty() {
arrow = '├';
}
fields.unnamed.iter().enumerate().for_each(|(idx, field)| {
let ident = syn::Ident::new(
&format!("v{}", idx),
proc_macro2::Span::call_site(),
)
.to_token_stream();
let field_name = format!("{}", idx);
let is_last = idx == fields.unnamed.len().saturating_sub(1);
variant_code.extend([quote! {
#ident.mem_dbg_depth_on(_memdbg_writer, _memdbg_total_size, _memdbg_max_depth, _memdbg_prefix, Some(#field_name), #is_last, _memdbg_flags)?;
}]);
args.extend([ident]);
args.extend([quote! {,}]);
let ty = &field.ty;
where_clause
.predicates
.push(parse_quote_spanned!(field.span()=> #ty: mem_dbg::MemDbgImpl));
});
// extend res with the args sourrounded by curly braces
res.extend(quote! {
( #args )
});
}
}
variants.push(res);
let variant_name = format!("Variant: {}\n", variant.ident);
variants_code.push(quote!{{
_memdbg_writer.write_char(#arrow)?;
_memdbg_writer.write_char('╴')?;
_memdbg_writer.write_str(#variant_name)?;
#variant_code
}});
});
quote! {
#[automatically_derived]
impl #impl_generics mem_dbg::MemDbgImpl for #name #ty_generics #where_clause {
#[inline(always)]
fn _mem_dbg_rec_on(
&self,
_memdbg_writer: &mut impl core::fmt::Write,
_memdbg_total_size: usize,
_memdbg_max_depth: usize,
_memdbg_prefix: &mut String,
_memdbg_is_last: bool,
_memdbg_flags: mem_dbg::DbgFlags,
) -> core::fmt::Result {
let mut _memdbg_digits_number = mem_dbg::utils::n_of_digits(_memdbg_total_size);
if _memdbg_flags.contains(mem_dbg::DbgFlags::SEPARATOR) {
_memdbg_digits_number += _memdbg_digits_number / 3;
}
if _memdbg_flags.contains(mem_dbg::DbgFlags::HUMANIZE) {
_memdbg_digits_number = 6;
}
if _memdbg_flags.contains(mem_dbg::DbgFlags::PERCENTAGE) {
_memdbg_digits_number += 8;
}
for _ in 0.._memdbg_digits_number + 3 {
_memdbg_writer.write_char(' ')?;
}
if !_memdbg_prefix.is_empty() {
_memdbg_writer.write_str(&_memdbg_prefix[2..])?;
}
match self {
#(
#name::#variants => #variants_code,
)*
}
Ok(())
}
}
}
}
Data::Union(_) => unimplemented!("Unions are not supported"),
}.into()
}