crates/hir_expand/src/db.rs

   1 //! Defines database & queries for macro expansion.
   2
   3 use std::sync::Arc;
   4
   5 use base_db::{salsa, SourceDatabase};
   6 use either::Either;
   7 use limit::Limit;
   8 use mbe::{syntax_node_to_token_tree, ExpandError, ExpandResult};
   9 use rustc_hash::FxHashSet;
  10 use syntax::{
  11     algo::diff,
  12     ast::{self, HasAttrs, HasDocComments},
  13     AstNode, GreenNode, Parse, SyntaxNode, SyntaxToken, T,
  14 };
  15
  16 use crate::{
  17     ast_id_map::AstIdMap, fixup, hygiene::HygieneFrame, BuiltinAttrExpander, BuiltinDeriveExpander,
  18     BuiltinFnLikeExpander, ExpandTo, HirFileId, HirFileIdRepr, MacroCallId, MacroCallKind,
  19     MacroCallLoc, MacroDefId, MacroDefKind, MacroFile, ProcMacroExpander,
  20 };
  21
  22 /// Total limit on the number of tokens produced by any macro invocation.
  23 ///
  24 /// If an invocation produces more tokens than this limit, it will not be stored in the database and
  25 /// an error will be emitted.
  26 ///
  27 /// Actual max for `analysis-stats .` at some point: 30672.
  28 static TOKEN_LIMIT: Limit = Limit::new(524_288);
  29
  30 #[derive(Debug, Clone, Eq, PartialEq)]
  31 pub enum TokenExpander {
  32     /// Old-style `macro_rules` or the new macros 2.0
  33     DeclarativeMacro { mac: mbe::DeclarativeMacro, def_site_token_map: mbe::TokenMap },
  34     /// Stuff like `line!` and `file!`.
  35     Builtin(BuiltinFnLikeExpander),
  36     /// `global_allocator` and such.
  37     BuiltinAttr(BuiltinAttrExpander),
  38     /// `derive(Copy)` and such.
  39     BuiltinDerive(BuiltinDeriveExpander),
  40     /// The thing we love the most here in rust-analyzer -- procedural macros.
  41     ProcMacro(ProcMacroExpander),
  42 }
  43
  44 impl TokenExpander {
  45     fn expand(
  46         &self,
  47         db: &dyn AstDatabase,
  48         id: MacroCallId,
  49         tt: &tt::Subtree,
  50     ) -> mbe::ExpandResult<tt::Subtree> {
  51         match self {
  52             TokenExpander::DeclarativeMacro { mac, .. } => mac.expand(tt),
  53             TokenExpander::Builtin(it) => it.expand(db, id, tt),
  54             TokenExpander::BuiltinAttr(it) => it.expand(db, id, tt),
  55             TokenExpander::BuiltinDerive(it) => it.expand(db, id, tt),
  56             TokenExpander::ProcMacro(_) => {
  57                 // We store the result in salsa db to prevent non-deterministic behavior in
  58                 // some proc-macro implementation
  59                 // See #4315 for details
  60                 db.expand_proc_macro(id)
  61             }
  62         }
  63     }
  64
  65     pub(crate) fn map_id_down(&self, id: tt::TokenId) -> tt::TokenId {
  66         match self {
  67             TokenExpander::DeclarativeMacro { mac, .. } => mac.map_id_down(id),
  68             TokenExpander::Builtin(..)
  69             | TokenExpander::BuiltinAttr(..)
  70             | TokenExpander::BuiltinDerive(..)
  71             | TokenExpander::ProcMacro(..) => id,
  72         }
  73     }
  74
  75     pub(crate) fn map_id_up(&self, id: tt::TokenId) -> (tt::TokenId, mbe::Origin) {
  76         match self {
  77             TokenExpander::DeclarativeMacro { mac, .. } => mac.map_id_up(id),
  78             TokenExpander::Builtin(..)
  79             | TokenExpander::BuiltinAttr(..)
  80             | TokenExpander::BuiltinDerive(..)
  81             | TokenExpander::ProcMacro(..) => (id, mbe::Origin::Call),
  82         }
  83     }
  84 }
  85
  86 // FIXME: rename to ExpandDatabase
  87 #[salsa::query_group(AstDatabaseStorage)]
  88 pub trait AstDatabase: SourceDatabase {
  89     fn ast_id_map(&self, file_id: HirFileId) -> Arc<AstIdMap>;
  90
  91     /// Main public API -- parses a hir file, not caring whether it's a real
  92     /// file or a macro expansion.
  93     #[salsa::transparent]
  94     fn parse_or_expand(&self, file_id: HirFileId) -> Option<SyntaxNode>;
  95     /// Implementation for the macro case.
  96     fn parse_macro_expansion(
  97         &self,
  98         macro_file: MacroFile,
  99     ) -> ExpandResult<Option<(Parse<SyntaxNode>, Arc<mbe::TokenMap>)>>;
 100
 101     /// Macro ids. That's probably the tricksiest bit in rust-analyzer, and the
 102     /// reason why we use salsa at all.
 103     ///
 104     /// We encode macro definitions into ids of macro calls, this what allows us
 105     /// to be incremental.
 106     #[salsa::interned]
 107     fn intern_macro_call(&self, macro_call: MacroCallLoc) -> MacroCallId;
 108
 109     /// Lowers syntactic macro call to a token tree representation.
 110     #[salsa::transparent]
 111     fn macro_arg(
 112         &self,
 113         id: MacroCallId,
 114     ) -> Option<Arc<(tt::Subtree, mbe::TokenMap, fixup::SyntaxFixupMap)>>;
 115     /// Extracts syntax node, corresponding to a macro call. That's a firewall
 116     /// query, only typing in the macro call itself changes the returned
 117     /// subtree.
 118     fn macro_arg_text(&self, id: MacroCallId) -> Option<GreenNode>;
 119     /// Gets the expander for this macro. This compiles declarative macros, and
 120     /// just fetches procedural ones.
 121     fn macro_def(&self, id: MacroDefId) -> Result<Arc<TokenExpander>, mbe::ParseError>;
 122
 123     /// Expand macro call to a token tree. This query is LRUed (we keep 128 or so results in memory)
 124     fn macro_expand(&self, macro_call: MacroCallId) -> ExpandResult<Option<Arc<tt::Subtree>>>;
 125     /// Special case of the previous query for procedural macros. We can't LRU
 126     /// proc macros, since they are not deterministic in general, and
 127     /// non-determinism breaks salsa in a very, very, very bad way. @edwin0cheng
 128     /// heroically debugged this once!
 129     fn expand_proc_macro(&self, call: MacroCallId) -> ExpandResult<tt::Subtree>;
 130     /// Firewall query that returns the error from the `macro_expand` query.
 131     fn macro_expand_error(&self, macro_call: MacroCallId) -> Option<ExpandError>;
 132
 133     fn hygiene_frame(&self, file_id: HirFileId) -> Arc<HygieneFrame>;
 134 }
 135
 136 /// This expands the given macro call, but with different arguments. This is
 137 /// used for completion, where we want to see what 'would happen' if we insert a
 138 /// token. The `token_to_map` mapped down into the expansion, with the mapped
 139 /// token returned.
 140 pub fn expand_speculative(
 141     db: &dyn AstDatabase,
 142     actual_macro_call: MacroCallId,
 143     speculative_args: &SyntaxNode,
 144     token_to_map: SyntaxToken,
 145 ) -> Option<(SyntaxNode, SyntaxToken)> {
 146     let loc = db.lookup_intern_macro_call(actual_macro_call);
 147     let macro_def = db.macro_def(loc.def).ok()?;
 148     let token_range = token_to_map.text_range();
 149
 150     // Build the subtree and token mapping for the speculative args
 151     let censor = censor_for_macro_input(&loc, &speculative_args);
 152     let mut fixups = fixup::fixup_syntax(&speculative_args);
 153     fixups.replace.extend(censor.into_iter().map(|node| (node, Vec::new())));
 154     let (mut tt, spec_args_tmap) =
 155         mbe::syntax_node_to_token_tree_censored(&speculative_args, fixups.replace, fixups.append);
 156
 157     let (attr_arg, token_id) = match loc.kind {
 158         MacroCallKind::Attr { invoc_attr_index, .. } => {
 159             // Attributes may have an input token tree, build the subtree and map for this as well
 160             // then try finding a token id for our token if it is inside this input subtree.
 161             let item = ast::Item::cast(speculative_args.clone())?;
 162             let attr = item
 163                 .doc_comments_and_attrs()
 164                 .nth(invoc_attr_index as usize)
 165                 .and_then(Either::left)?;
 166             match attr.token_tree() {
 167                 Some(token_tree) => {
 168                     let (mut tree, map) = syntax_node_to_token_tree(attr.token_tree()?.syntax());
 169                     tree.delimiter = None;
 170
 171                     let shift = mbe::Shift::new(&tt);
 172                     shift.shift_all(&mut tree);
 173
 174                     let token_id = if token_tree.syntax().text_range().contains_range(token_range) {
 175                         let attr_input_start =
 176                             token_tree.left_delimiter_token()?.text_range().start();
 177                         let range = token_range.checked_sub(attr_input_start)?;
 178                         let token_id = shift.shift(map.token_by_range(range)?);
 179                         Some(token_id)
 180                     } else {
 181                         None
 182                     };
 183                     (Some(tree), token_id)
 184                 }
 185                 _ => (None, None),
 186             }
 187         }
 188         _ => (None, None),
 189     };
 190     let token_id = match token_id {
 191         Some(token_id) => token_id,
 192         // token wasn't inside an attribute input so it has to be in the general macro input
 193         None => {
 194             let range = token_range.checked_sub(speculative_args.text_range().start())?;
 195             let token_id = spec_args_tmap.token_by_range(range)?;
 196             macro_def.map_id_down(token_id)
 197         }
 198     };
 199
 200     // Do the actual expansion, we need to directly expand the proc macro due to the attribute args
 201     // Otherwise the expand query will fetch the non speculative attribute args and pass those instead.
 202     let speculative_expansion = if let MacroDefKind::ProcMacro(expander, ..) = loc.def.kind {
 203         tt.delimiter = None;
 204         expander.expand(db, loc.krate, &tt, attr_arg.as_ref())
 205     } else {
 206         macro_def.expand(db, actual_macro_call, &tt)
 207     };
 208
 209     let expand_to = macro_expand_to(db, actual_macro_call);
 210     let (node, rev_tmap) = token_tree_to_syntax_node(&speculative_expansion.value, expand_to);
 211
 212     let range = rev_tmap.first_range_by_token(token_id, token_to_map.kind())?;
 213     let token = node.syntax_node().covering_element(range).into_token()?;
 214     Some((node.syntax_node(), token))
 215 }
 216
 217 fn ast_id_map(db: &dyn AstDatabase, file_id: HirFileId) -> Arc<AstIdMap> {
 218     let map = db.parse_or_expand(file_id).map(|it| AstIdMap::from_source(&it)).unwrap_or_default();
 219     Arc::new(map)
 220 }
 221
 222 fn parse_or_expand(db: &dyn AstDatabase, file_id: HirFileId) -> Option<SyntaxNode> {
 223     match file_id.0 {
 224         HirFileIdRepr::FileId(file_id) => Some(db.parse(file_id).tree().syntax().clone()),
 225         HirFileIdRepr::MacroFile(macro_file) => {
 226             // FIXME: Note how we convert from `Parse` to `SyntaxNode` here,
 227             // forgetting about parse errors.
 228             db.parse_macro_expansion(macro_file).value.map(|(it, _)| it.syntax_node())
 229         }
 230     }
 231 }
 232
 233 fn parse_macro_expansion(
 234     db: &dyn AstDatabase,
 235     macro_file: MacroFile,
 236 ) -> ExpandResult<Option<(Parse<SyntaxNode>, Arc<mbe::TokenMap>)>> {
 237     let _p = profile::span("parse_macro_expansion");
 238     let result = db.macro_expand(macro_file.macro_call_id);
 239
 240     if let Some(err) = &result.err {
 241         // Note:
 242         // The final goal we would like to make all parse_macro success,
 243         // such that the following log will not call anyway.
 244         let loc: MacroCallLoc = db.lookup_intern_macro_call(macro_file.macro_call_id);
 245         let node = loc.kind.to_node(db);
 246
 247         // collect parent information for warning log
 248         let parents =
 249             std::iter::successors(loc.kind.file_id().call_node(db), |it| it.file_id.call_node(db))
 250                 .map(|n| format!("{:#}", n.value))
 251                 .collect::<Vec<_>>()
 252                 .join("\n");
 253
 254         tracing::warn!(
 255             "fail on macro_parse: (reason: {:?} macro_call: {:#}) parents: {}",
 256             err,
 257             node.value,
 258             parents
 259         );
 260     }
 261     let tt = match result.value {
 262         Some(tt) => tt,
 263         None => return ExpandResult { value: None, err: result.err },
 264     };
 265
 266     let expand_to = macro_expand_to(db, macro_file.macro_call_id);
 267
 268     tracing::debug!("expanded = {}", tt.as_debug_string());
 269     tracing::debug!("kind = {:?}", expand_to);
 270
 271     let (parse, rev_token_map) = token_tree_to_syntax_node(&tt, expand_to);
 272
 273     match result.err {
 274         Some(err) => {
 275             // Safety check for recursive identity macro.
 276             let node = parse.syntax_node();
 277             let file: HirFileId = macro_file.into();
 278             let call_node = match file.call_node(db) {
 279                 Some(it) => it,
 280                 None => {
 281                     return ExpandResult::only_err(err);
 282                 }
 283             };
 284             if is_self_replicating(&node, &call_node.value) {
 285                 ExpandResult::only_err(err)
 286             } else {
 287                 ExpandResult { value: Some((parse, Arc::new(rev_token_map))), err: Some(err) }
 288             }
 289         }
 290         None => {
 291             tracing::debug!("parse = {:?}", parse.syntax_node().kind());
 292             ExpandResult { value: Some((parse, Arc::new(rev_token_map))), err: None }
 293         }
 294     }
 295 }
 296
 297 fn macro_arg(
 298     db: &dyn AstDatabase,
 299     id: MacroCallId,
 300 ) -> Option<Arc<(tt::Subtree, mbe::TokenMap, fixup::SyntaxFixupMap)>> {
 301     let arg = db.macro_arg_text(id)?;
 302     let loc = db.lookup_intern_macro_call(id);
 303
 304     let node = SyntaxNode::new_root(arg);
 305     let censor = censor_for_macro_input(&loc, &node);
 306     // TODO only fixup for attribute macro input
 307     let mut fixups = fixup::fixup_syntax(&node);
 308     fixups.replace.extend(censor.into_iter().map(|node| (node, Vec::new())));
 309     let (mut tt, tmap) =
 310         mbe::syntax_node_to_token_tree_censored(&node, fixups.replace, fixups.append);
 311
 312     if loc.def.is_proc_macro() {
 313         // proc macros expect their inputs without parentheses, MBEs expect it with them included
 314         tt.delimiter = None;
 315     }
 316
 317     Some(Arc::new((tt, tmap, fixups.map)))
 318 }
 319
 320 fn censor_for_macro_input(loc: &MacroCallLoc, node: &SyntaxNode) -> FxHashSet<SyntaxNode> {
 321     (|| {
 322         let censor = match loc.kind {
 323             MacroCallKind::FnLike { .. } => return None,
 324             MacroCallKind::Derive { derive_attr_index, .. } => {
 325                 cov_mark::hit!(derive_censoring);
 326                 ast::Item::cast(node.clone())?
 327                     .attrs()
 328                     .take(derive_attr_index as usize + 1)
 329                     .filter(|attr| attr.simple_name().as_deref() == Some("derive"))
 330                     .map(|it| it.syntax().clone())
 331                     .collect()
 332             }
 333             MacroCallKind::Attr { invoc_attr_index, .. } => {
 334                 cov_mark::hit!(attribute_macro_attr_censoring);
 335                 ast::Item::cast(node.clone())?
 336                     .doc_comments_and_attrs()
 337                     .nth(invoc_attr_index as usize)
 338                     .and_then(Either::left)
 339                     .map(|attr| attr.syntax().clone())
 340                     .into_iter()
 341                     .collect()
 342             }
 343         };
 344         Some(censor)
 345     })()
 346     .unwrap_or_default()
 347 }
 348
 349 fn macro_arg_text(db: &dyn AstDatabase, id: MacroCallId) -> Option<GreenNode> {
 350     let loc = db.lookup_intern_macro_call(id);
 351     let arg = loc.kind.arg(db)?;
 352     if matches!(loc.kind, MacroCallKind::FnLike { .. }) {
 353         let first = arg.first_child_or_token().map_or(T![.], |it| it.kind());
 354         let last = arg.last_child_or_token().map_or(T![.], |it| it.kind());
 355         let well_formed_tt =
 356             matches!((first, last), (T!['('], T![')']) | (T!['['], T![']']) | (T!['{'], T!['}']));
 357         if !well_formed_tt {
 358             // Don't expand malformed (unbalanced) macro invocations. This is
 359             // less than ideal, but trying to expand unbalanced  macro calls
 360             // sometimes produces pathological, deeply nested code which breaks
 361             // all kinds of things.
 362             //
 363             // Some day, we'll have explicit recursion counters for all
 364             // recursive things, at which point this code might be removed.
 365             cov_mark::hit!(issue9358_bad_macro_stack_overflow);
 366             return None;
 367         }
 368     }
 369     Some(arg.green().into())
 370 }
 371
 372 fn macro_def(db: &dyn AstDatabase, id: MacroDefId) -> Result<Arc<TokenExpander>, mbe::ParseError> {
 373     match id.kind {
 374         MacroDefKind::Declarative(ast_id) => {
 375             let (mac, def_site_token_map) = match ast_id.to_node(db) {
 376                 ast::Macro::MacroRules(macro_rules) => {
 377                     let arg = macro_rules
 378                         .token_tree()
 379                         .ok_or_else(|| mbe::ParseError::Expected("expected a token tree".into()))?;
 380                     let (tt, def_site_token_map) = mbe::syntax_node_to_token_tree(arg.syntax());
 381                     let mac = mbe::DeclarativeMacro::parse_macro_rules(&tt)?;
 382                     (mac, def_site_token_map)
 383                 }
 384                 ast::Macro::MacroDef(macro_def) => {
 385                     let arg = macro_def
 386                         .body()
 387                         .ok_or_else(|| mbe::ParseError::Expected("expected a token tree".into()))?;
 388                     let (tt, def_site_token_map) = mbe::syntax_node_to_token_tree(arg.syntax());
 389                     let mac = mbe::DeclarativeMacro::parse_macro2(&tt)?;
 390                     (mac, def_site_token_map)
 391                 }
 392             };
 393             Ok(Arc::new(TokenExpander::DeclarativeMacro { mac, def_site_token_map }))
 394         }
 395         MacroDefKind::BuiltIn(expander, _) => Ok(Arc::new(TokenExpander::Builtin(expander))),
 396         MacroDefKind::BuiltInAttr(expander, _) => {
 397             Ok(Arc::new(TokenExpander::BuiltinAttr(expander)))
 398         }
 399         MacroDefKind::BuiltInDerive(expander, _) => {
 400             Ok(Arc::new(TokenExpander::BuiltinDerive(expander)))
 401         }
 402         MacroDefKind::BuiltInEager(..) => {
 403             // FIXME: Return a random error here just to make the types align.
 404             // This obviously should do something real instead.
 405             Err(mbe::ParseError::UnexpectedToken("unexpected eager macro".into()))
 406         }
 407         MacroDefKind::ProcMacro(expander, ..) => Ok(Arc::new(TokenExpander::ProcMacro(expander))),
 408     }
 409 }
 410
 411 fn macro_expand(db: &dyn AstDatabase, id: MacroCallId) -> ExpandResult<Option<Arc<tt::Subtree>>> {
 412     let _p = profile::span("macro_expand");
 413     let loc: MacroCallLoc = db.lookup_intern_macro_call(id);
 414     if let Some(eager) = &loc.eager {
 415         return ExpandResult {
 416             value: Some(eager.arg_or_expansion.clone()),
 417             // FIXME: There could be errors here!
 418             err: None,
 419         };
 420     }
 421
 422     let macro_arg = match db.macro_arg(id) {
 423         Some(it) => it,
 424         None => return ExpandResult::str_err("Failed to lower macro args to token tree".into()),
 425     };
 426
 427     let expander = match db.macro_def(loc.def) {
 428         Ok(it) => it,
 429         // FIXME: This is weird -- we effectively report macro *definition*
 430         // errors lazily, when we try to expand the macro. Instead, they should
 431         // be reported at the definition site (when we construct a def map).
 432         Err(err) => return ExpandResult::str_err(format!("invalid macro definition: {}", err)),
 433     };
 434     let ExpandResult { value: mut tt, err } = expander.expand(db, id, &macro_arg.0);
 435     // Set a hard limit for the expanded tt
 436     let count = tt.count();
 437     if TOKEN_LIMIT.check(count).is_err() {
 438         return ExpandResult::str_err(format!(
 439             "macro invocation exceeds token limit: produced {} tokens, limit is {}",
 440             count,
 441             TOKEN_LIMIT.inner(),
 442         ));
 443     }
 444
 445     fixup::reverse_fixups(&mut tt, &macro_arg.1, &macro_arg.2);
 446
 447     ExpandResult { value: Some(Arc::new(tt)), err }
 448 }
 449
 450 fn macro_expand_error(db: &dyn AstDatabase, macro_call: MacroCallId) -> Option<ExpandError> {
 451     db.macro_expand(macro_call).err
 452 }
 453
 454 fn expand_proc_macro(db: &dyn AstDatabase, id: MacroCallId) -> ExpandResult<tt::Subtree> {
 455     let loc: MacroCallLoc = db.lookup_intern_macro_call(id);
 456     let macro_arg = match db.macro_arg(id) {
 457         Some(it) => it,
 458         None => return ExpandResult::str_err("No arguments for proc-macro".to_string()),
 459     };
 460
 461     let expander = match loc.def.kind {
 462         MacroDefKind::ProcMacro(expander, ..) => expander,
 463         _ => unreachable!(),
 464     };
 465
 466     let attr_arg = match &loc.kind {
 467         MacroCallKind::Attr { attr_args, .. } => {
 468             let mut attr_args = attr_args.0.clone();
 469             mbe::Shift::new(&macro_arg.0).shift_all(&mut attr_args);
 470             Some(attr_args)
 471         }
 472         _ => None,
 473     };
 474
 475     expander.expand(db, loc.krate, &macro_arg.0, attr_arg.as_ref())
 476 }
 477
 478 fn is_self_replicating(from: &SyntaxNode, to: &SyntaxNode) -> bool {
 479     if diff(from, to).is_empty() {
 480         return true;
 481     }
 482     if let Some(stmts) = ast::MacroStmts::cast(from.clone()) {
 483         if stmts.statements().any(|stmt| diff(stmt.syntax(), to).is_empty()) {
 484             return true;
 485         }
 486         if let Some(expr) = stmts.expr() {
 487             if diff(expr.syntax(), to).is_empty() {
 488                 return true;
 489             }
 490         }
 491     }
 492     false
 493 }
 494
 495 fn hygiene_frame(db: &dyn AstDatabase, file_id: HirFileId) -> Arc<HygieneFrame> {
 496     Arc::new(HygieneFrame::new(db, file_id))
 497 }
 498
 499 fn macro_expand_to(db: &dyn AstDatabase, id: MacroCallId) -> ExpandTo {
 500     let loc: MacroCallLoc = db.lookup_intern_macro_call(id);
 501     loc.kind.expand_to()
 502 }
 503
 504 fn token_tree_to_syntax_node(
 505     tt: &tt::Subtree,
 506     expand_to: ExpandTo,
 507 ) -> (Parse<SyntaxNode>, mbe::TokenMap) {
 508     let entry_point = match expand_to {
 509         ExpandTo::Statements => mbe::TopEntryPoint::MacroStmts,
 510         ExpandTo::Items => mbe::TopEntryPoint::MacroItems,
 511         ExpandTo::Pattern => mbe::TopEntryPoint::Pattern,
 512         ExpandTo::Type => mbe::TopEntryPoint::Type,
 513         ExpandTo::Expr => mbe::TopEntryPoint::Expr,
 514     };
 515     mbe::token_tree_to_syntax_node(tt, entry_point)
 516 }