Skip to content

[hermes] Reject annotated items in blocks #3046

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
joshlf wants to merge 1 commit into
base: Gegf4fywvkwtqzwzektqc5lett4skoxvx
Choose a base branch
from
+285 −76
Open

[hermes] Reject annotated items in blocks #3046

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions tools/hermes/src/charon.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,13 @@ pub fn run_charon(args: &Args, roots: &Roots, packages: &[HermesArtifact]) -> Re
let mut start_from = artifact.start_from.clone();
start_from.sort();

// NOTE: This is an optimization that is relevant because, when we
// encounter items which we can't name (which carry Hermes annotations),
// we add their parent module to the list of entrypoints. If there are
// multiple items in the same module, this can lead to duplication in
// the list of entrypoints.
start_from.dedup();

let start_from_str = start_from.join(",");
// OS command-line length limits (Windows is ~32k; Linux `ARG_MAX` is
// usually larger, but variable)
Expand Down
65 changes: 34 additions & 31 deletions tools/hermes/src/parse.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,9 @@ use std::{
use log::{debug, trace};
use miette::{NamedSource, SourceSpan};
use proc_macro2::Span;
use quote::quote;
use syn::{
spanned::Spanned as _, visit::Visit, Attribute, Error, Expr, ImplItemFn, ItemEnum, ItemFn,
ItemImpl, ItemMod, ItemStruct, ItemTrait, ItemUnion, Lit, Meta,
ItemImpl, ItemMod, ItemStruct, ItemTrait, ItemUnion, Lit, Meta, TraitItemFn,
};

use crate::errors::HermesError;
Expand Down Expand Up @@ -44,6 +43,7 @@ pub enum ParsedItem {
Trait(ItemTrait),
Impl(ItemImpl),
ImplItemFn(ImplItemFn),
TraitItemFn(TraitItemFn),
}

impl ParsedItem {
Expand All @@ -55,6 +55,7 @@ impl ParsedItem {
Self::Union(item) => Some(item.ident.to_string()),
Self::Trait(item) => Some(item.ident.to_string()),
Self::ImplItemFn(item) => Some(item.sig.ident.to_string()),
Self::TraitItemFn(item) => Some(item.sig.ident.to_string()),
Self::Impl(_) => None,
}
}
Expand All @@ -69,6 +70,7 @@ impl ParsedItem {
Self::Trait(item) => &item.attrs,
Self::Impl(item) => &item.attrs,
Self::ImplItemFn(item) => &item.attrs,
Self::TraitItemFn(item) => &item.attrs,
}
}
}
Expand All @@ -89,6 +91,8 @@ pub struct UnloadedModule {
/// The value of `#[path = "..."]` if present.
pub path_attr: Option<String>,
pub span: proc_macro2::Span,
/// True if this module was declared inside a block.
pub inside_block: bool,
}

/// Parses the given Rust source code and invokes the callback `f` for each item
Expand All @@ -103,29 +107,35 @@ where
F: FnMut(&str, Result<ParsedLeanItem, HermesError>),
{
let mut unloaded_modules = Vec::new();
scan_compilation_unit_internal(source, None, f, |m| unloaded_modules.push(m));
scan_compilation_unit_internal(source, None, false, f, |m| unloaded_modules.push(m));
unloaded_modules
}

/// Like [`scan_compilation_unit`], but reads the source code from a file path.
///
/// Parsing errors and generated items will be associated with this file path.
///
/// Set `inside_block = true` if this file was discovered via a `mod foo;` item
/// inside of a block.
pub fn read_file_and_scan_compilation_unit<F>(
path: &Path,
inside_block: bool,
f: F,
) -> Result<(String, Vec<UnloadedModule>), io::Error>
where
F: FnMut(&str, Result<ParsedLeanItem, HermesError>),
{
log::trace!("read_file_and_scan_compilation_unit({:?})", path);
log::trace!("read_file_and_scan_compilation_unit({:?}, inside_block={})", path, inside_block);
let source = fs::read_to_string(path)?;
let unloaded_modules = scan_compilation_unit(&source, f);
let mut unloaded_modules = Vec::new();
scan_compilation_unit_internal(&source, None, inside_block, f, |m| unloaded_modules.push(m));
Ok((source, unloaded_modules))
}

fn scan_compilation_unit_internal<I, M>(
source: &str,
source_file: Option<PathBuf>,
inside_block: bool,
mut item_cb: I,
mod_cb: M,
) where
Expand All @@ -141,10 +151,6 @@ fn scan_compilation_unit_internal<I, M>(

f
};
let _x = source_file
.as_ref()
.map(|p| p.display().to_string())
.unwrap_or_else(|| "<input>".to_string());
let named_source = miette::NamedSource::new(file_name, source.to_string());
let file = match syn::parse_file(source) {
Ok(file) => {
Expand All @@ -168,7 +174,7 @@ fn scan_compilation_unit_internal<I, M>(
trace!("Initializing HermesVisitor to traverse AST");
let mut visitor = HermesVisitor {
current_path: Vec::new(),
inside_block: false,
inside_block,
item_cb,
mod_cb,
source_file,
Expand All @@ -195,8 +201,7 @@ where
I: FnMut(&str, Result<ParsedLeanItem, HermesError>),
M: FnMut(UnloadedModule),
{
fn check_and_add(&mut self, item: ParsedItem, span: Span) {
// NEW: Check nesting
fn process_item(&mut self, item: ParsedItem, span: Span) {
if self.inside_block {
// Only check attributes if we are in a body to see if we need to
// error. We want to avoid erroring on un-annotated local items.
Expand Down Expand Up @@ -268,6 +273,7 @@ where
name: mod_name.clone(),
path_attr: extract_path_attr(&node.attrs),
span: node.span(),
inside_block: self.inside_block,
});
}

Expand All @@ -290,32 +296,32 @@ where

fn visit_item_fn(&mut self, node: &'ast ItemFn) {
trace!("Visiting Fn {}", node.sig.ident);
self.check_and_add(ParsedItem::Fn(node.clone()), node.span());
self.process_item(ParsedItem::Fn(node.clone()), node.span());
syn::visit::visit_item_fn(self, node);
}

fn visit_item_struct(&mut self, node: &'ast ItemStruct) {
trace!("Visiting Struct {}", node.ident);
self.check_and_add(ParsedItem::Struct(node.clone()), node.span());
self.process_item(ParsedItem::Struct(node.clone()), node.span());
syn::visit::visit_item_struct(self, node);
}

fn visit_item_enum(&mut self, node: &'ast ItemEnum) {
trace!("Visiting Enum {}", node.ident);
self.check_and_add(ParsedItem::Enum(node.clone()), node.span());
self.process_item(ParsedItem::Enum(node.clone()), node.span());
syn::visit::visit_item_enum(self, node);
}

fn visit_item_union(&mut self, node: &'ast ItemUnion) {
trace!("Visiting Union {}", node.ident);
self.check_and_add(ParsedItem::Union(node.clone()), node.span());
self.process_item(ParsedItem::Union(node.clone()), node.span());
syn::visit::visit_item_union(self, node);
}

fn visit_item_trait(&mut self, node: &'ast ItemTrait) {
let name = node.ident.to_string();
trace!("Visiting Trait {}", name);
self.check_and_add(ParsedItem::Trait(node.clone()), node.span());
self.process_item(ParsedItem::Trait(node.clone()), node.span());

self.current_path.push(name);
syn::visit::visit_item_trait(self, node);
Expand All @@ -331,27 +337,21 @@ where

fn visit_item_impl(&mut self, node: &'ast ItemImpl) {
trace!("Visiting Impl");
self.check_and_add(ParsedItem::Impl(node.clone()), node.span());

// If this is a trait impl, we use UFCS syntax (`<Type as Trait>`). If
// this is an inherent impl, we use the `Type: Type` syntax.
let self_ty = &node.self_ty;
let segment = if let Some((_, path, _)) = &node.trait_ {
quote! { <#self_ty as #path> }
} else {
quote! { #self_ty }
};

self.current_path.push(segment.to_string());
self.process_item(ParsedItem::Impl(node.clone()), node.span());
syn::visit::visit_item_impl(self, node);
self.current_path.pop();
}

fn visit_impl_item_fn(&mut self, node: &'ast ImplItemFn) {
trace!("Visiting ImplItemFn {}", node.sig.ident);
self.check_and_add(ParsedItem::ImplItemFn(node.clone()), node.span());
self.process_item(ParsedItem::ImplItemFn(node.clone()), node.span());
syn::visit::visit_impl_item_fn(self, node);
}

fn visit_trait_item_fn(&mut self, node: &'ast TraitItemFn) {
trace!("Visiting TraitItemFn {}", node.sig.ident);
self.process_item(ParsedItem::TraitItemFn(node.clone()), node.span());
syn::visit::visit_trait_item_fn(self, node);
}
}

/// Helper to extract exactly one Lean block from a slice of attributes.
Expand Down Expand Up @@ -605,6 +605,7 @@ mod tests {
scan_compilation_unit_internal(
code,
Some(Path::new("src/foo.rs").to_path_buf()),
false,
|source: &str, res| items.push((source.to_string(), res)),
|_| {},
);
Expand Down Expand Up @@ -689,12 +690,14 @@ mod c {
scan_compilation_unit_internal(
code1,
Some(path.to_path_buf()),
false,
|_src, res| items.push(res),
|_| {},
);
scan_compilation_unit_internal(
code2,
Some(path.to_path_buf()),
false,
|_src, res| items.push(res),
|_| {},
);
Expand Down
2 changes: 2 additions & 0 deletions tools/hermes/src/resolve.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@ impl TryFrom<&TargetKind> for HermesTargetKind {
pub struct HermesTargetName {
pub package_name: PackageName,
pub target_name: String,
pub kind: HermesTargetKind,
}

#[derive(Debug)]
Expand Down Expand Up @@ -171,6 +172,7 @@ pub fn resolve_roots(args: &Args) -> Result<Roots> {
name: HermesTargetName {
package_name: package.name.clone(),
target_name: target.name.clone(),
kind,
},
kind,
src_path: target.src_path.as_std_path().to_owned(),
Expand Down
Loading
Loading