rustc_hir_typeck/

lib.rs

// tidy-alphabetical-start
#![cfg_attr(bootstrap, feature(never_type))]
#![feature(deref_patterns)]
#![feature(iter_intersperse)]
#![feature(iter_order_by)]
#![feature(option_into_flat_iter)]
#![feature(option_reference_flattening)]
#![feature(trim_prefix_suffix)]
// tidy-alphabetical-end

mod _match;
mod autoderef;
mod callee;
// Used by clippy;
pub mod cast;
mod check;
mod closure;
mod coercion;
mod demand;
mod diagnostics;
mod diverges;
mod expectation;
mod expr;
mod inline_asm;
// Used by clippy;
pub mod expr_use_visitor;
mod fallback;
mod fn_ctxt;
mod gather_locals;
mod intrinsicck;
mod loops;
mod method;
mod naked_functions;
mod op;
mod opaque_types;
mod pat;
mod place_op;
mod typeck_root_ctxt;
mod upvar;
mod writeback;

pub use coercion::can_coerce;
use fn_ctxt::FnCtxt;
use rustc_data_structures::unord::UnordSet;
use rustc_errors::codes::*;
use rustc_errors::{Applicability, Diag, ErrorGuaranteed, struct_span_code_err};
use rustc_hir as hir;
use rustc_hir::def::{DefKind, Res};
use rustc_hir::{HirId, HirIdMap, Node};
use rustc_hir_analysis::check::check_abi;
use rustc_hir_analysis::hir_ty_lowering::HirTyLowerer;
use rustc_infer::traits::{ObligationCauseCode, ObligationInspector, TraitEngine, WellFormedLoc};
use rustc_middle::middle::codegen_fn_attrs::CodegenFnAttrFlags;
use rustc_middle::query::Providers;
use rustc_middle::ty::{self, FnSigKind, Ty, TyCtxt, Unnormalized};
use rustc_session::config;
use rustc_span::def_id::LocalDefId;
use rustc_span::{Span, bug, span_bug};
use tracing::{debug, instrument};
use typeck_root_ctxt::TypeckRootCtxt;

use crate::check::check_fn;
use crate::coercion::CoerceMany;
use crate::diverges::Diverges;
use crate::expectation::Expectation;
use crate::fn_ctxt::LoweredTy;
use crate::gather_locals::GatherLocalsVisitor;

#[macro_export]
macro_rules! type_error_struct {
    ($dcx:expr, $span:expr, $typ:expr, $code:expr, $($message:tt)*) => ({
        let mut err = rustc_errors::struct_span_code_err!($dcx, $span, $code, $($message)*);

        if $typ.references_error() {
            err.downgrade_to_delayed_bug();
        }

        err
    })
}

fn used_trait_imports(tcx: TyCtxt<'_>, def_id: LocalDefId) -> &UnordSet<LocalDefId> {
    &tcx.typeck(def_id).used_trait_imports
}

fn typeck_root<'tcx>(tcx: TyCtxt<'tcx>, def_id: LocalDefId) -> &'tcx ty::TypeckResults<'tcx> {
    typeck_with_inspect(tcx, def_id, None)
}

/// Same as `typeck` but `inspect` is invoked on evaluation of each root obligation.
/// Inspecting obligations only works with the new trait solver.
/// This function is *only to be used* by external tools, it should not be
/// called from within rustc. Note, this is not a query, and thus is not cached.
pub fn inspect_typeck<'tcx>(
    tcx: TyCtxt<'tcx>,
    def_id: LocalDefId,
    inspect: ObligationInspector<'tcx>,
) -> &'tcx ty::TypeckResults<'tcx> {
    // Closures' typeck results come from their outermost function,
    // as they are part of the same "inference environment".
    let typeck_root_def_id = tcx.typeck_root_def_id_local(def_id);
    if typeck_root_def_id != def_id {
        return tcx.typeck(typeck_root_def_id);
    }

    typeck_with_inspect(tcx, def_id, Some(inspect))
}

#[instrument(level = "debug", skip(tcx, inspector), ret)]
fn typeck_with_inspect<'tcx>(
    tcx: TyCtxt<'tcx>,
    def_id: LocalDefId,
    inspector: Option<ObligationInspector<'tcx>>,
) -> &'tcx ty::TypeckResults<'tcx> {
    assert!(!tcx.is_typeck_child(def_id.to_def_id()));

    let id = tcx.local_def_id_to_hir_id(def_id);
    let node = tcx.hir_node(id);
    let span = tcx.def_span(def_id);

    // Figure out what primary body this item has.
    let body_id = node.body_id().unwrap_or_else(|| {
        span_bug!(span, "can't type-check body of {:?}", def_id);
    });
    let body = tcx.hir_body(body_id);

    let param_env = tcx.param_env(def_id);

    let root_ctxt = TypeckRootCtxt::new(tcx, def_id);
    if let Some(inspector) = inspector {
        root_ctxt.infcx.attach_obligation_inspector(inspector);
    }
    let mut fcx = FnCtxt::new(&root_ctxt, param_env, def_id);

    if let hir::Node::Item(hir::Item { kind: hir::ItemKind::GlobalAsm { .. }, .. }) = node {
        // Check the fake body of a global ASM. There's not much to do here except
        // for visit the asm expr of the body.
        let ty = fcx.check_expr(body.value);
        fcx.write_ty(id, ty);
    } else if let Some(hir::FnSig { header, decl, span: _ }) = node.fn_sig() {
        let fn_sig = if decl.output.is_suggestable_infer_ty().is_some() {
            // In the case that we're recovering `fn() -> W<_>` or some other return
            // type that has an infer in it, lower the type directly so that it'll
            // be correctly filled with infer. We'll use this inference to provide
            // a suggestion later on.
            fcx.lowerer().lower_fn_ty(id, header.safety(), header.abi, decl, None, None)
        } else {
            tcx.fn_sig(def_id).instantiate_identity().skip_norm_wip()
        };

        check_abi(tcx, id, span, fn_sig.abi());

        loops::check(tcx, def_id, body);

        // Compute the function signature from point of view of inside the fn.
        let mut fn_sig = tcx.liberate_late_bound_regions(def_id.to_def_id(), fn_sig);

        // Normalize the input and output types one at a time, using a different
        // `WellFormedLoc` for each. We cannot call `normalize_associated_types`
        // on the entire `FnSig`, since this would use the same `WellFormedLoc`
        // for each type, preventing the HIR wf check from generating
        // a nice error message.
        let arg_span =
            |idx| decl.inputs.get(idx).map_or(decl.output.span(), |arg: &hir::Ty<'_>| arg.span);

        fn_sig.inputs_and_output = tcx.mk_type_list_from_iter(
            fn_sig
                .inputs_and_output
                .iter()
                .enumerate()
                .map(|(idx, ty)| fcx.normalize(arg_span(idx), Unnormalized::new_wip(ty))),
        );

        if tcx.codegen_fn_attrs(def_id).flags.contains(CodegenFnAttrFlags::NAKED) {
            naked_functions::typeck_naked_fn(tcx, def_id, body);
        }

        check_fn(&mut fcx, fn_sig, None, decl, def_id, body, tcx.features().unsized_fn_params());
    } else {
        let expected_type = if let Some(infer_ty) = infer_type_if_missing(&fcx, node) {
            infer_ty
        } else if let Some(ty) = node.ty()
            && ty.is_suggestable_infer_ty()
        {
            // In the case that we're recovering `const X: [T; _]` or some other
            // type that has an infer in it, lower the type directly so that it'll
            // be correctly filled with infer. We'll use this inference to provide
            // a suggestion later on.
            fcx.lowerer().lower_ty(ty)
        } else {
            tcx.type_of(def_id).instantiate_identity().skip_norm_wip()
        };

        loops::check(tcx, def_id, body);

        let expected_type = fcx.normalize(body.value.span, Unnormalized::new_wip(expected_type));

        let wf_code = ObligationCauseCode::WellFormed(Some(WellFormedLoc::Ty(def_id)));
        fcx.register_wf_obligation(expected_type.into(), body.value.span, wf_code);

        if let hir::Node::AnonConst(_) = node {
            fcx.require_type_is_sized(
                expected_type,
                body.value.span,
                ObligationCauseCode::SizedConstOrStatic,
            );
        }

        fcx.check_expr_coercible_to_type_or_error(body.value, expected_type, None, |err, _| {
            extend_err_with_const_context(err, tcx, node, expected_type);
        });

        fcx.write_ty(id, expected_type);
    };

    // Whether to check repeat exprs before/after inference fallback is somewhat
    // arbitrary of a decision as neither option is strictly more permissive than
    // the other. However, we opt to check repeat exprs first as errors from not
    // having inferred array lengths yet seem less confusing than errors from inference
    // fallback arbitrarily inferring something incompatible with `Copy` inference
    // side effects.
    //
    // FIXME(#140855): This should also be forwards compatible with moving
    // repeat expr checks to a custom goal kind or using marker traits in
    // the future.
    fcx.check_repeat_exprs();

    // We need to handle opaque types before emitting ambiguity errors as applying
    // defining uses may guide type inference.
    if fcx.next_trait_solver() {
        fcx.try_handle_opaque_type_uses_next();
    }

    fcx.type_inference_fallback();

    // Even though coercion casts provide type hints, we check casts after fallback for
    // backwards compatibility. This makes fallback a stronger type hint than a cast coercion.
    fcx.check_casts();
    fcx.select_obligations_where_possible(|_| {});

    // Closure and coroutine analysis may run after fallback
    // because they don't constrain other type variables.
    fcx.closure_analyze(body);
    assert!(fcx.deferred_call_resolutions.borrow().is_empty());

    for (ty, span, code) in fcx.deferred_sized_obligations.borrow_mut().drain(..) {
        let ty = fcx.normalize(span, Unnormalized::new_wip(ty));
        fcx.require_type_is_sized(ty, span, code);
    }

    fcx.select_obligations_where_possible(|_| {});

    debug!(pending_obligations = ?fcx.fulfillment_cx.borrow().pending_obligations());

    // We need to handle opaque types before emitting ambiguity errors as applying
    // defining uses may guide type inference.
    if fcx.next_trait_solver() {
        fcx.handle_opaque_type_uses_next();
    }

    // This must be the last thing before `report_ambiguity_errors` below except `select_obligations_where_possible`.
    // So don't put anything after this.
    fcx.drain_stalled_coroutine_obligations();
    if fcx.infcx.tainted_by_errors().is_none() {
        fcx.report_ambiguity_errors();
    }

    fcx.check_asms();

    let typeck_results = fcx.resolve_type_vars_in_body(body);

    fcx.detect_opaque_types_added_during_writeback();

    // Consistency check our TypeckResults instance can hold all ItemLocalIds
    // it will need to hold.
    assert_eq!(typeck_results.hir_owner, id.owner);

    typeck_results
}

fn extend_err_with_const_context(
    err: &mut Diag<'_>,
    tcx: TyCtxt<'_>,
    node: hir::Node<'_>,
    expected_ty: Ty<'_>,
) {
    match node {
        hir::Node::ImplItem(hir::ImplItem { kind: hir::ImplItemKind::Const(ty, _), .. })
        | hir::Node::TraitItem(hir::TraitItem { kind: hir::TraitItemKind::Const(ty, _), .. }) => {
            // Point at the `Type` in `const NAME: Type = value;`.
            err.span_label(ty.span, "expected because of the type of the associated constant");
        }
        hir::Node::Item(hir::Item { kind: hir::ItemKind::Const(_, _, ty, _), .. }) => {
            // Point at the `Type` in `const NAME: Type = value;`.
            err.span_label(ty.span, "expected because of the type of the constant");
        }
        hir::Node::Item(hir::Item { kind: hir::ItemKind::Static(_, _, ty, _), .. }) => {
            // Point at the `Type` in `static NAME: Type = value;`.
            err.span_label(ty.span, "expected because of the type of the static");
        }
        hir::Node::AnonConst(anon)
            if let hir::Node::ConstArg(parent) = tcx.parent_hir_node(anon.hir_id)
                && let hir::Node::Ty(parent) = tcx.parent_hir_node(parent.hir_id)
                && let hir::TyKind::Array(_ty, _len) = parent.kind =>
        {
            // `[type; len]` in type context.
            err.note("array length can only be `usize`");
        }
        hir::Node::AnonConst(anon)
            if let hir::Node::ConstArg(parent) = tcx.parent_hir_node(anon.hir_id)
                && let hir::Node::Expr(parent) = tcx.parent_hir_node(parent.hir_id)
                && let hir::ExprKind::Repeat(_ty, _len) = parent.kind =>
        {
            // `[type; len]` in expr context.
            err.note("array length can only be `usize`");
        }
        // FIXME: support method calls too.
        hir::Node::AnonConst(anon)
            if let hir::Node::ConstArg(parent) = tcx.parent_hir_node(anon.hir_id)
                && let Some(path) = tcx.parent_hir_node(parent.hir_id).path()
                && let hir::QPath::Resolved(_, path) = path
                && let Res::Def(_, def_id) = path.res =>
        {
            // `foo<N>()`, point at the const parameter in the definition of `foo`.
            if let Some(i) =
                path.segments.last().and_then(|segment| segment.args).and_then(|args| {
                    args.args.iter().position(|arg| {
                        matches!(arg, hir::GenericArg::Const(arg) if arg.hir_id == parent.hir_id)
                    })
                })
            {
                let generics = tcx.generics_of(def_id);
                let param = &generics.param_at(i, tcx);
                let sp = tcx.def_span(param.def_id);
                err.span_note(sp, "expected because of the type of the const parameter");
            }
        }
        hir::Node::AnonConst(anon)
            if let hir::Node::Variant(_variant) = tcx.parent_hir_node(anon.hir_id) =>
        {
            // FIXME: point at `repr` when present in the type.
            err.note(
                "enum variant discriminant can only be of a primitive type compatible with the \
                 enum's `repr`",
            );
        }
        hir::Node::AnonConst(anon)
            if let hir::Node::ConstArg(parent) = tcx.parent_hir_node(anon.hir_id)
                && let hir::Node::GenericParam(param) = tcx.parent_hir_node(parent.hir_id)
                && let hir::GenericParamKind::Const { ty, .. } = param.kind =>
        {
            // `fn foo<const N: usize = ()>` point at the `usize`.
            err.span_label(ty.span, "expected because of the type of the const parameter");
        }
        hir::Node::AnonConst(anon)
            if let hir::Node::ConstArg(parent) = tcx.parent_hir_node(anon.hir_id)
                && let hir::Node::TyPat(ty_pat) = tcx.parent_hir_node(parent.hir_id)
                && let hir::Node::Ty(ty) = tcx.parent_hir_node(ty_pat.hir_id)
                && let hir::TyKind::Pat(ty, _) = ty.kind =>
        {
            // Point at `char` in `pattern_type!(char is 1..=1)`.
            err.span_label(ty.span, "the pattern must match the type");
        }
        hir::Node::AnonConst(anon)
            if let hir::Node::Field(_) = tcx.parent_hir_node(anon.hir_id)
                && let ty::Param(_) = expected_ty.kind() =>
        {
            err.note(
                "the type of default fields referencing type parameters can't be assumed inside \
                 the struct defining them",
            );
        }
        _ => {}
    }
}

fn infer_type_if_missing<'tcx>(fcx: &FnCtxt<'_, 'tcx>, node: Node<'tcx>) -> Option<Ty<'tcx>> {
    let tcx = fcx.tcx;
    let def_id = fcx.body_def_id;
    let expected_type = if let Some(&hir::Ty { kind: hir::TyKind::Infer(()), span, .. }) = node.ty()
    {
        if let Some(item) = tcx.opt_associated_item(def_id.into())
            && let ty::AssocKind::Const { .. } = item.kind
            && let ty::AssocContainer::TraitImpl(Ok(trait_item_def_id)) = item.container
        {
            let impl_def_id = item.container_id(tcx);
            let impl_trait_ref =
                tcx.impl_trait_ref(impl_def_id).instantiate_identity().skip_norm_wip();
            let args = ty::GenericArgs::identity_for_item(tcx, def_id).rebase_onto(
                tcx,
                impl_def_id,
                impl_trait_ref.args,
            );
            let alias_kind = ty::AliasTermKind::ProjectionConst { def_id: trait_item_def_id };
            tcx.check_alias_term_args_compatible(alias_kind, args)
                .then(|| tcx.type_of(trait_item_def_id).instantiate(tcx, args).skip_norm_wip())
        } else {
            Some(fcx.next_ty_var(span))
        }
    } else if let Node::AnonConst(_) = node {
        let id = tcx.local_def_id_to_hir_id(def_id);
        match tcx.parent_hir_node(id) {
            Node::Expr(&hir::Expr { kind: hir::ExprKind::InlineAsm(asm), span, .. })
            | Node::Item(&hir::Item { kind: hir::ItemKind::GlobalAsm { asm, .. }, span, .. }) => {
                asm.operands.iter().find_map(|(op, _op_sp)| match op {
                    hir::InlineAsmOperand::Const { anon_const } if anon_const.hir_id == id => {
                        Some(fcx.next_ty_var(span))
                    }
                    _ => None,
                })
            }
            _ => None,
        }
    } else {
        None
    };
    expected_type
}

/// When `check_fn` is invoked on a coroutine (i.e., a body that
/// includes yield), it returns back some information about the yield
/// points.
#[derive(Debug, PartialEq, Copy, Clone)]
struct CoroutineTypes<'tcx> {
    /// Type of coroutine argument / values returned by `yield`.
    resume_ty: Ty<'tcx>,

    /// Type of value that is yielded.
    yield_ty: Ty<'tcx>,
}

#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub enum Needs {
    MutPlace,
    None,
}

impl Needs {
    fn maybe_mut_place(m: hir::Mutability) -> Self {
        match m {
            hir::Mutability::Mut => Needs::MutPlace,
            hir::Mutability::Not => Needs::None,
        }
    }
}

#[derive(Debug, Copy, Clone)]
pub enum PlaceOp {
    Deref,
    Index,
}

pub struct BreakableCtxt<'tcx> {
    may_break: bool,

    // this is `null` for loops where break with a value is illegal,
    // such as `while`, `for`, and `while let`
    coerce: Option<CoerceMany<'tcx>>,
}

pub struct EnclosingBreakables<'tcx> {
    stack: Vec<BreakableCtxt<'tcx>>,
    by_id: HirIdMap<usize>,
}

impl<'tcx> EnclosingBreakables<'tcx> {
    fn find_breakable(&mut self, target_id: HirId) -> &mut BreakableCtxt<'tcx> {
        self.opt_find_breakable(target_id).unwrap_or_else(|| {
            bug!("could not find enclosing breakable with id {}", target_id);
        })
    }

    fn opt_find_breakable(&mut self, target_id: HirId) -> Option<&mut BreakableCtxt<'tcx>> {
        match self.by_id.get(&target_id) {
            Some(ix) => Some(&mut self.stack[*ix]),
            None => None,
        }
    }
}
impl<'a, 'tcx> FnCtxt<'a, 'tcx> {
    fn report_unexpected_variant_res(
        &self,
        res: Res,
        expr: Option<&hir::Expr<'_>>,
        sub_pats: &[hir::Pat<'_>],
        qpath: &hir::QPath<'_>,
        span: Span,
        err_code: ErrCode,
        expected: &str,
    ) -> ErrorGuaranteed {
        let tcx = self.tcx;
        let res_descr = match res {
            Res::Def(DefKind::Variant, _) => "struct variant",
            _ => res.descr(),
        };
        let path_str = rustc_hir_pretty::qpath_to_string(self, qpath);
        let mut err = tcx
            .dcx()
            .struct_span_err(span, format!("expected {expected}, found {res_descr} `{path_str}`"))
            .with_code(err_code);
        match res {
            Res::Def(DefKind::Fn | DefKind::AssocFn, _) if err_code == E0164 => {
                let patterns_url = "https://doc.rust-lang.org/book/ch19-00-patterns.html";
                err.with_span_label(span, "`fn` calls are not allowed in patterns")
                    .with_help(format!("for more information, visit {patterns_url}"))
            }
            Res::Def(DefKind::Variant, _) if let Some(expr) = expr => {
                err.span_label(span, format!("not a {expected}"));
                let variant = tcx.expect_variant_res(res);
                let sugg = if variant.fields.is_empty() {
                    " {}".to_string()
                } else {
                    format!(
                        " {{ {} }}",
                        variant
                            .fields
                            .iter()
                            .map(|f| format!("{}: /* value */", f.name))
                            .collect::<Vec<_>>()
                            .join(", ")
                    )
                };
                let descr = "you might have meant to create a new value of the struct";
                let mut suggestion = vec![];
                match tcx.parent_hir_node(expr.hir_id) {
                    hir::Node::Expr(hir::Expr {
                        kind: hir::ExprKind::Call(..),
                        span: call_span,
                        ..
                    }) => {
                        suggestion.push((span.shrink_to_hi().with_hi(call_span.hi()), sugg));
                    }
                    hir::Node::Expr(hir::Expr {
                        kind: hir::ExprKind::Binary(..), hir_id, ..
                    }) => {
                        suggestion.push((expr.span.shrink_to_lo(), "(".to_string()));
                        if let hir::Node::Expr(parent) = tcx.parent_hir_node(*hir_id)
                            && let hir::ExprKind::If(condition, block, None) = parent.kind
                            && condition.hir_id == *hir_id
                            && let hir::ExprKind::Block(block, _) = block.kind
                            && block.stmts.is_empty()
                            && let Some(expr) = block.expr
                            && let hir::ExprKind::Path(..) = expr.kind
                        {
                            // Special case: you can incorrectly write an equality condition:
                            // if foo == Struct { field } { /* if body */ }
                            // which should have been written
                            // if foo == (Struct { field }) { /* if body */ }
                            suggestion.push((block.span.shrink_to_hi(), ")".to_string()));
                        } else {
                            suggestion.push((span.shrink_to_hi().with_hi(expr.span.hi()), sugg));
                        }
                    }
                    _ => {
                        suggestion.push((span.shrink_to_hi(), sugg));
                    }
                }

                err.multipart_suggestion(descr, suggestion, Applicability::HasPlaceholders);
                err
            }
            Res::Def(DefKind::Variant, _) if expr.is_none() => {
                err.span_label(span, format!("not a {expected}"));

                let fields = &tcx.expect_variant_res(res).fields.raw;
                let span = qpath.span().shrink_to_hi().to(span.shrink_to_hi());
                let (msg, sugg) = if fields.is_empty() {
                    ("use the struct variant pattern syntax", " {}".to_string())
                } else {
                    let msg = if fields.is_empty() {
                        "use struct variant pattern syntax"
                    } else {
                        "add the names to match a struct variant's fields"
                    };
                    let fields_sugg = fields
                        .iter()
                        .enumerate()
                        .map(|(i, field)| {
                            let field_name = field.ident(tcx).to_string();

                            let pat_snippet = sub_pats
                                .get(i)
                                .and_then(|sub_pat| {
                                    tcx.sess.source_map().span_to_snippet(sub_pat.span).ok()
                                })
                                .unwrap_or_else(|| "_".to_string());

                            if field_name == pat_snippet {
                                field_name
                            } else {
                                format!("{field_name}: {pat_snippet}")
                            }
                        })
                        .collect::<Vec<_>>()
                        .join(", ");
                    let sugg = format!(" {{ {} }}", fields_sugg);
                    (msg, sugg)
                };

                err.span_suggestion_verbose(
                    qpath.span().shrink_to_hi().to(span.shrink_to_hi()),
                    msg,
                    sugg,
                    Applicability::HasPlaceholders,
                );
                err
            }
            _ => err.with_span_label(span, format!("not a {expected}")),
        }
        .emit()
    }
}

/// Controls whether all arguments are tupled. This is used for the call operator only.
///
/// Tupling means that all call-side arguments are packed into a tuple and passed as a single
/// parameter. For example, if tupling is enabled, this function:
/// ```
/// fn f(x: (isize, isize)) {}
/// ```
/// Can be called as:
/// ```ignore UNSOLVED (can this be done in user code?)
/// # fn f(x: (isize, isize)) {}
/// f(1, 2);
/// ```
/// Instead of:
/// ```
/// # fn f(x: (isize, isize)) {}
/// f((1, 2));
/// ```
///
/// Note: splatted arguments are handled separately.
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
enum TupleArgumentsFlag {
    /// Arguments are typechecked unchanged.
    DontTupleArguments,
    /// This is a call operator: all caller arguments are tupled before typechecking.
    /// Set based on the "rust-call" ABI and Fn* traits.
    TupleAllCallArgs,
    /// The `self` method argument is splatted, so `Self` should be tupled before typechecking.
    TupleSplattedSelfArg,
    /// A non-self argument is splatted, so that argument should be tupled before typechecking.
    TupleSplattedArg(u8),
}

impl TupleArgumentsFlag {
    /// Returns the TupleArgumentsFlag for a known RustCall function.
    fn rust_fn_trait_call() -> Self {
        Self::TupleAllCallArgs
    }

    /// Returns the appropriate TupleArgumentsFlag for the given FnSigKind and method flag.
    fn with_fn_sig_kind<'tcx>(fn_sig_kind: FnSigKind<'tcx>, is_method: bool) -> Self {
        if let Some(splatted_arg_index) = fn_sig_kind.splatted() {
            if is_method {
                if let Some(splatted_arg_index) = splatted_arg_index.checked_sub(1) {
                    return Self::TupleSplattedArg(splatted_arg_index);
                } else {
                    // In `check_argument_types`, this is effectively `TupleSplattedArg(-1)`
                    return Self::TupleSplattedSelfArg;
                }
            }

            return Self::TupleSplattedArg(splatted_arg_index);
        }

        Self::DontTupleArguments
    }

    /// Returns true if the arguments are tupled through "rust-call" or splatting.
    fn is_tupled(self) -> bool {
        match self {
            Self::DontTupleArguments => false,
            Self::TupleAllCallArgs | Self::TupleSplattedSelfArg | Self::TupleSplattedArg(_) => true,
        }
    }

    /// Returns true if the arguments are tupled through splatting.
    /// (But false if they are "rust-call" or not tupled.)
    fn is_splatted(self) -> bool {
        match self {
            Self::TupleSplattedSelfArg | Self::TupleSplattedArg(_) => true,
            Self::DontTupleArguments | Self::TupleAllCallArgs => false,
        }
    }

    /// Returns the tupled argument index, and whether the `self` argument is splatted.
    /// Returns `None` if the arguments are not tupled, or if the `self` argument is splatted.
    fn tupled_arg_index(self) -> (Option<u16>, bool /* is_self_splatted */) {
        match self {
            Self::TupleSplattedArg(index) => (Some(u16::from(index)), false),
            Self::TupleAllCallArgs => (Some(0), false),
            Self::TupleSplattedSelfArg => (None, true),
            Self::DontTupleArguments => (None, false),
        }
    }
}

fn fatally_break_rust(tcx: TyCtxt<'_>, span: Span) -> ! {
    let dcx = tcx.dcx();
    let mut diag = dcx.struct_span_bug(
        span,
        "It looks like you're trying to break rust; would you like some ICE?",
    );
    diag.note("the compiler expectedly panicked. this is a feature.");
    diag.note(
        "we would appreciate a joke overview: \
         https://github.com/rust-lang/rust/issues/43162#issuecomment-320764675",
    );
    diag.note(format!("rustc {} running on {}", tcx.sess.cfg_version, config::host_tuple(),));
    if let Some((flags, excluded_cargo_defaults)) = rustc_session::utils::extra_compiler_flags() {
        diag.note(format!("compiler flags: {}", flags.join(" ")));
        if excluded_cargo_defaults {
            diag.note("some of the compiler flags provided by cargo are hidden");
        }
    }
    diag.emit()
}

/// Adds query implementations to the [Providers] vtable, see [`rustc_middle::query`]
pub fn provide(providers: &mut Providers) {
    *providers = Providers {
        method_autoderef_steps: method::probe::method_autoderef_steps,
        typeck_root,
        used_trait_imports,
        check_transmutes: intrinsicck::check_transmutes,
        check_offloads: intrinsicck::check_offloads,
        ..*providers
    };
}