| // Part of the Crubit project, under the Apache License v2.0 with LLVM |
| // Exceptions. See /LICENSE for license information. |
| // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception |
| |
| use anyhow::{bail, Context, Result}; |
| use code_gen_utils::{format_cc_ident, format_cc_includes, CcInclude}; |
| use itertools::Itertools; |
| use proc_macro2::TokenStream; |
| use quote::quote; |
| use rustc_hir::{Item, ItemKind, Node, Unsafety}; |
| use rustc_interface::Queries; |
| use rustc_middle::dep_graph::DepContext; |
| use rustc_middle::ty::{self, Ty, TyCtxt}; // See <internal link>/ty.html#import-conventions |
| use rustc_span::def_id::{DefId, LocalDefId, LOCAL_CRATE}; |
| use rustc_target::spec::abi::Abi; |
| use rustc_target::spec::PanicStrategy; |
| use std::collections::BTreeSet; |
| use std::iter::Sum; |
| use std::ops::{Add, AddAssign}; |
| |
| pub struct GeneratedBindings { |
| pub h_body: TokenStream, |
| pub rs_body: TokenStream, |
| } |
| |
| impl GeneratedBindings { |
| pub fn generate(tcx: TyCtxt) -> Result<Self> { |
| match tcx.sess().panic_strategy() { |
| PanicStrategy::Unwind => bail!("No support for panic=unwind strategy (b/254049425)"), |
| PanicStrategy::Abort => (), |
| }; |
| |
| let top_comment = { |
| let crate_name = tcx.crate_name(LOCAL_CRATE); |
| let txt = format!( |
| "Automatically @generated C++ bindings for the following Rust crate:\n\ |
| {crate_name}" |
| ); |
| quote! { __COMMENT__ #txt __NEWLINE__ } |
| }; |
| |
| let h_body = { |
| let crate_content = format_crate(tcx).unwrap_or_else(|err| { |
| let txt = format!("Failed to generate bindings for the crate: {err}"); |
| quote! { __COMMENT__ #txt } |
| }); |
| // TODO(b/251445877): Replace `#pragma once` with include guards. |
| quote! { |
| #top_comment |
| __HASH_TOKEN__ pragma once __NEWLINE__ |
| __NEWLINE__ |
| #crate_content |
| } |
| }; |
| |
| let rs_body = quote! { |
| #top_comment |
| |
| // TODO(b/254097223): Include Rust thunks here. |
| }; |
| |
| Ok(Self { h_body, rs_body }) |
| } |
| } |
| |
| /// Helper (used by `bindings_driver` and `test::run_compiler`) for invoking |
| /// functions operating on `TyCtxt`. |
| pub fn enter_tcx<'tcx, F, T>( |
| queries: &'tcx Queries<'tcx>, |
| f: F, |
| ) -> rustc_interface::interface::Result<T> |
| where |
| F: FnOnce(TyCtxt<'tcx>) -> T + Send, |
| T: Send, |
| { |
| let query_context = queries.global_ctxt()?; |
| Ok(query_context.peek_mut().enter(f)) |
| } |
| |
| #[derive(Debug)] |
| struct CcSnippet { |
| snippet: TokenStream, |
| |
| /// Set of `#include`s that the `snippet` depends on. For example if |
| /// `snippet` expands to `std::int32_t`, then `includes` need to cover |
| /// the `cstdint`. |
| includes: BTreeSet<CcInclude>, |
| } |
| |
| impl CcSnippet { |
| /// Consumes `self` and returns the main `snippet`, while preserving |
| /// `includes` into the `external_includes` out parameter. |
| fn into_tokens(mut self, external_includes: &mut BTreeSet<CcInclude>) -> TokenStream { |
| external_includes.append(&mut self.includes); |
| self.snippet |
| } |
| } |
| |
| fn format_ret_ty_for_cc(ty: Ty) -> Result<CcSnippet> { |
| let void = Ok(CcSnippet { snippet: quote! { void }, includes: BTreeSet::new() }); |
| match ty.kind() { |
| ty::TyKind::Never => void, // `!` |
| ty::TyKind::Tuple(types) if types.len() == 0 => void, // `()` |
| _ => format_ty_for_cc(ty), |
| } |
| } |
| |
| /// Formats `ty` into a `CcSnippet` that represents how the type should be |
| /// spelled in a C++ declaration of an `extern "C"` function. |
| fn format_ty_for_cc(ty: Ty) -> Result<CcSnippet> { |
| fn cstdint(snippet: TokenStream) -> CcSnippet { |
| let mut includes = BTreeSet::new(); |
| includes.insert(CcInclude::cstdint()); |
| CcSnippet { snippet, includes } |
| } |
| fn keyword(snippet: TokenStream) -> CcSnippet { |
| CcSnippet { snippet, includes: BTreeSet::new() } |
| } |
| Ok(match ty.kind() { |
| ty::TyKind::Never => { |
| // TODO(b/254507801): Maybe translate into `crubit::Never`? |
| bail!("The never type `!` is only supported as a return type (b/254507801)"); |
| }, |
| ty::TyKind::Tuple(types) => { |
| if types.len() == 0 { |
| // TODO(b/254507801): Maybe translate into `crubit::Unit`? |
| bail!("The unit type `()` / `void` is only supported as a return type"); |
| } else { |
| // TODO(b/254099023): Add support for tuples. |
| bail!("Tuples are not supported yet: {} (b/254099023)", ty); |
| } |
| } |
| |
| ty::TyKind::Bool => keyword(quote! { bool }), |
| |
| // https://rust-lang.github.io/unsafe-code-guidelines/layout/scalars.html#fixed-width-floating-point-types |
| // documents that "When the platforms' "math.h" header defines the __STDC_IEC_559__ macro, |
| // Rust's floating-point types are safe to use directly in C FFI where the appropriate C |
| // types are expected (f32 for float, f64 for double)." |
| // |
| // TODO(b/255768062): Generated bindings should explicitly check `__STDC_IEC_559__` |
| ty::TyKind::Float(ty::FloatTy::F32) => keyword(quote! { float }), |
| ty::TyKind::Float(ty::FloatTy::F64) => keyword(quote! { double }), |
| |
| ty::TyKind::Char => { |
| // https://rust-lang.github.io/unsafe-code-guidelines/layout/scalars.html#char |
| // documents that "Rust char is 32-bit wide and represents an unicode scalar value". |
| // |
| // We don't map Rust's `char` to C++ `char32_t` because |
| // - It may be wider than 32 bits - |
| // https://en.cppreference.com/w/c/string/multibyte/char32_t says that "char32_t is |
| // an unsigned integer type used for 32-bit wide characters and is the same type as |
| // uint_least32_t. uint_least32_t is the smallest unsigned integer type with width |
| // of at least 32 bits" |
| // - It is problematic on MacOS - https://github.com/eqrion/cbindgen/issues/423 |
| // points out that `uchar.h` is missing on that platform. |
| cstdint(quote!{ std::uint32_t }) |
| }, |
| |
| // https://rust-lang.github.io/unsafe-code-guidelines/layout/scalars.html#isize-and-usize |
| // documents that "Rust's signed and unsigned fixed-width integer types {i,u}{8,16,32,64} |
| // have the same layout the C fixed-width integer types from the <stdint.h> header |
| // {u,}int{8,16,32,64}_t. These fixed-width integer types are therefore safe to use |
| // directly in C FFI where the corresponding C fixed-width integer types are expected. |
| // |
| // https://rust-lang.github.io/unsafe-code-guidelines/layout/scalars.html#layout-compatibility-with-c-native-integer-types |
| // documents that "Rust does not support C platforms on which the C native integer type are |
| // not compatible with any of Rust's fixed-width integer type (e.g. because of |
| // padding-bits, lack of 2's complement, etc.)." |
| ty::TyKind::Int(ty::IntTy::I8) => cstdint(quote!{ std::int8_t }), |
| ty::TyKind::Int(ty::IntTy::I16) => cstdint(quote!{ std::int16_t }), |
| ty::TyKind::Int(ty::IntTy::I32) => cstdint(quote!{ std::int32_t }), |
| ty::TyKind::Int(ty::IntTy::I64) => cstdint(quote!{ std::int64_t }), |
| ty::TyKind::Uint(ty::UintTy::U8) => cstdint(quote!{ std::uint8_t }), |
| ty::TyKind::Uint(ty::UintTy::U16) => cstdint(quote!{ std::uint16_t }), |
| ty::TyKind::Uint(ty::UintTy::U32) => cstdint(quote!{ std::uint32_t }), |
| ty::TyKind::Uint(ty::UintTy::U64) => cstdint(quote!{ std::uint64_t }), |
| |
| // https://rust-lang.github.io/unsafe-code-guidelines/layout/scalars.html#isize-and-usize |
| // documents that "The isize and usize types are [...] layout compatible with C's uintptr_t |
| // and intptr_t types.". |
| ty::TyKind::Int(ty::IntTy::Isize) => cstdint(quote!{ std::intptr_t }), |
| ty::TyKind::Uint(ty::UintTy::Usize) => cstdint(quote!{ std::uintptr_t }), |
| |
| ty::TyKind::Int(ty::IntTy::I128) | ty::TyKind::Uint(ty::UintTy::U128) => { |
| // Note that "the alignment of Rust's {i,u}128 is unspecified and allowed to |
| // change" according to |
| // https://rust-lang.github.io/unsafe-code-guidelines/layout/scalars.html#fixed-width-integer-types |
| // |
| // TODO(b/254094650): Consider mapping this to Clang's (and GCC's) `__int128` |
| // or to `absl::in128`. |
| bail!("C++ doesn't have a standard equivalent of `{ty}` (b/254094650)"); |
| } |
| |
| ty::TyKind::Adt(..) |
| | ty::TyKind::Foreign(..) |
| | ty::TyKind::Str |
| | ty::TyKind::Array(..) |
| | ty::TyKind::Slice(..) |
| | ty::TyKind::RawPtr(..) |
| | ty::TyKind::Ref(..) |
| | ty::TyKind::FnPtr(..) |
| | ty::TyKind::Dynamic(..) |
| | ty::TyKind::Generator(..) |
| | ty::TyKind::GeneratorWitness(..) |
| | ty::TyKind::Projection(..) |
| | ty::TyKind::Opaque(..) |
| | ty::TyKind::Param(..) |
| | ty::TyKind::Bound(..) |
| | ty::TyKind::Placeholder(..) => { |
| bail!("The following Rust type is not supported yet: {ty}") |
| } |
| ty::TyKind::Closure(..) |
| | ty::TyKind::FnDef(..) |
| | ty::TyKind::Infer(..) |
| | ty::TyKind::Error(..) => { |
| // `Closure` types are assumed to never appear in a public API of a crate (only |
| // function-body-local variables/values should be able to have a closure type). |
| // |
| // `FnDef` is assumed to never appear in a public API of a crate - this seems to |
| // be an internal, compiler-only type similar to `Closure` (e.g. |
| // based on the statement from https://doc.rust-lang.org/stable/nightly-rustc/rustc_middle/ty/enum.TyKind.html#variant.FnDef |
| // that "each function has a unique type" |
| // |
| // `Infer` and `Error` types should be impossible at the time when Crubit's code |
| // runs (after the "analysis" phase of the Rust compiler). |
| panic!("Unexpected TyKind: {:?}", ty.kind()); |
| } |
| }) |
| } |
| |
| /// Formats `ty` for Rust (e.g. to be used as a type of a parameter in a Rust |
| /// thunk inside `..._cc_api_impl.rs`). |
| #[allow(dead_code)] // TODO(b/254097223): Use from `format_fn`. |
| fn format_ty_for_rs(ty: Ty) -> Result<TokenStream> { |
| Ok(match ty.kind() { |
| ty::TyKind::Bool |
| | ty::TyKind::Float(_) |
| | ty::TyKind::Char |
| | ty::TyKind::Int(_) |
| | ty::TyKind::Uint(_) |
| | ty::TyKind::Never => ty |
| .to_string() |
| .parse() |
| .expect("rustc_middle::ty::Ty::to_string() should produce no parsing errors"), |
| ty::TyKind::Tuple(types) => { |
| if types.len() == 0 { |
| quote! { () } |
| } else { |
| // TODO(b/254099023): Add support for tuples. |
| bail!("Tuples are not supported yet: {} (b/254099023)", ty); |
| } |
| } |
| |
| // TODO(b/258232820): Add support for ADT / `struct` bindings. Note that we can't simply |
| // use ty.to_string().parse().expect(...) everywhere - `ty` comes from the target crate but |
| // the result is used in the `..._cc_api_impl.rs` crate and therefore `SomeStruct` needs to |
| // be formatted as `target_crate::SomeStruct`. |
| ty::TyKind::Adt(..) |
| | ty::TyKind::Foreign(..) |
| | ty::TyKind::Str |
| | ty::TyKind::Array(..) |
| | ty::TyKind::Slice(..) |
| | ty::TyKind::RawPtr(..) |
| | ty::TyKind::Ref(..) |
| | ty::TyKind::FnPtr(..) |
| | ty::TyKind::Dynamic(..) |
| | ty::TyKind::Generator(..) |
| | ty::TyKind::GeneratorWitness(..) |
| | ty::TyKind::Projection(..) |
| | ty::TyKind::Opaque(..) |
| | ty::TyKind::Param(..) |
| | ty::TyKind::Bound(..) |
| | ty::TyKind::Placeholder(..) => { |
| bail!("The following Rust type is not supported yet: {ty}") |
| } |
| ty::TyKind::Closure(..) |
| | ty::TyKind::FnDef(..) |
| | ty::TyKind::Infer(..) |
| | ty::TyKind::Error(..) => { |
| // See the comment inside the similar fallback branch in `format_ty_for_cc`. |
| panic!("Unexpected TyKind: {:?}", ty.kind()); |
| } |
| }) |
| } |
| |
| #[derive(Debug)] |
| struct BindingsSnippet { |
| /// `#include`s that go at the top of the generated `..._cc_api.h` file. |
| includes: BTreeSet<CcInclude>, |
| |
| /// Public API of the bindings in the generated `..._cc_api.h` file. |
| api: TokenStream, |
| |
| /// Internal implementation details for `..._cc_api.h` file (e.g. |
| /// declarations of Rust thunks, `static_assert`s about `struct` layout, |
| /// etc.). |
| internals: Option<TokenStream>, |
| // TODO(b/254097223): Add `impl_: Option<TokenStream>` to carry Rust thunks. |
| } |
| |
| impl BindingsSnippet { |
| fn new() -> Self { |
| Self { includes: BTreeSet::new(), api: quote! {}, internals: None } |
| } |
| } |
| |
| impl AddAssign for BindingsSnippet { |
| fn add_assign(&mut self, rhs: Self) { |
| let Self { includes: mut rhs_includes, api: rhs_api, internals: rhs_internals } = rhs; |
| |
| self.includes.append(&mut rhs_includes); |
| self.api.extend(rhs_api); |
| |
| fn concat_optional_tokens( |
| lhs: Option<TokenStream>, |
| rhs: Option<TokenStream>, |
| ) -> Option<TokenStream> { |
| match (lhs, rhs) { |
| (None, None) => None, |
| (Some(lhs), None) => Some(lhs), |
| (None, Some(rhs)) => Some(rhs), |
| (Some(mut lhs), Some(rhs)) => { |
| lhs.extend(rhs); |
| Some(lhs) |
| } |
| } |
| } |
| self.internals = concat_optional_tokens(self.internals.take(), rhs_internals); |
| } |
| } |
| |
| impl Add for BindingsSnippet { |
| type Output = BindingsSnippet; |
| |
| fn add(mut self, rhs: Self) -> Self { |
| self += rhs; |
| self |
| } |
| } |
| |
| impl Sum for BindingsSnippet { |
| fn sum<I: Iterator<Item = Self>>(iter: I) -> Self { |
| iter.fold(BindingsSnippet::new(), Add::add) |
| } |
| } |
| |
| /// Formats a function with the given `def_id`. |
| /// |
| /// Will panic if `def_id` |
| /// - is invalid |
| /// - doesn't identify a function, |
| /// - has generic parameters of any kind - lifetime parameters (see also |
| /// b/258235219), type parameters, or const parameters. |
| fn format_fn(tcx: TyCtxt, def_id: LocalDefId) -> Result<BindingsSnippet> { |
| let def_id: DefId = def_id.to_def_id(); // Convert LocalDefId to DefId. |
| |
| let item_name = tcx.item_name(def_id); |
| let symbol_name = { |
| // Call to `mono` is ok - doc comment requires no generic parameters (although |
| // lifetime parameters would have been okay). |
| let instance = ty::Instance::mono(tcx, def_id); |
| tcx.symbol_name(instance) |
| }; |
| |
| let sig = tcx |
| .fn_sig(def_id) |
| .no_bound_vars() |
| .expect("Doc comment points out there should be no generic parameters"); |
| |
| if sig.c_variadic { |
| // TODO(b/254097223): Add support for variadic functions. |
| bail!("C variadic functions are not supported (b/254097223)"); |
| } |
| |
| match sig.unsafety { |
| Unsafety::Normal => (), |
| Unsafety::Unsafe => { |
| // TODO(b/254095482): Figure out how to handle `unsafe` functions. |
| bail!("Bindings for `unsafe` functions are not fully designed yet (b/254095482)"); |
| } |
| } |
| |
| match sig.abi { |
| // "C" ABI is okay: Before https://rust-lang.github.io/rfcs/2945-c-unwind-abi.html a Rust |
| // panic that "escapes" a "C" ABI function leads to Undefined Behavior. This is |
| // unfortunate, but Crubit's `panics_and_exceptions.md` documents that `-Cpanic=abort` is |
| // the only supported configuration. |
| // |
| // After https://rust-lang.github.io/rfcs/2945-c-unwind-abi.html a Rust panic that |
| // tries to "escape" a "C" ABI function will terminate the program. This is okay. |
| Abi::C { unwind: false } => (), |
| |
| // "C-unwind" ABI is okay: After https://rust-lang.github.io/rfcs/2945-c-unwind-abi.html a |
| // new "C-unwind" ABI may be used by Rust functions that want to safely propagate Rust |
| // panics through frames that may belong to another language. |
| Abi::C { unwind: true } => (), |
| |
| // TODO(b/254097223): Add support for Rust thunks. |
| _ => bail!("Non-C ABI is not supported yet (b/254097223)"), |
| }; |
| |
| let mut includes = BTreeSet::new(); |
| let ret_type = format_ret_ty_for_cc(sig.output()) |
| .context("Error formatting function return type")? |
| .into_tokens(&mut includes); |
| let fn_name = format_cc_ident(item_name.as_str()).context("Error formatting function name")?; |
| let arg_names = tcx |
| .fn_arg_names(def_id) |
| .iter() |
| .enumerate() |
| .map(|(index, ident)| { |
| format_cc_ident(ident.as_str()) |
| .unwrap_or_else(|_err| format_cc_ident(&format!("__param_{index}")).unwrap()) |
| }) |
| .collect_vec(); |
| let arg_types = sig |
| .inputs() |
| .iter() |
| .enumerate() |
| .map(|(index, ty)| Ok( |
| format_ty_for_cc(*ty) |
| .with_context(|| format!("Error formatting the type of parameter #{index}"))? |
| .into_tokens(&mut includes) |
| )) |
| .collect::<Result<Vec<_>>>()?; |
| let api: TokenStream; |
| let internals: Option<TokenStream>; |
| if item_name.as_str() == symbol_name.name { |
| api = quote! { |
| extern "C" #ret_type #fn_name ( |
| #( #arg_types #arg_names ),* |
| ); |
| }; |
| internals = None; |
| } else { |
| let exported_name = |
| format_cc_ident(symbol_name.name).context("Error formatting exported name")?; |
| api = quote! { |
| inline #ret_type #fn_name ( |
| #( #arg_types #arg_names ),* ) { |
| return :: __crubit_internal :: #exported_name( #( #arg_names ),* ); |
| } |
| }; |
| internals = Some(quote! { |
| extern "C" #ret_type #exported_name ( |
| #( #arg_types #arg_names ),* |
| ); |
| }); |
| }; |
| Ok(BindingsSnippet { includes, api, internals }) |
| } |
| |
| /// Formats a Rust item idenfied by `def_id`. |
| /// |
| /// Will panic if `def_id` is invalid (i.e. doesn't identify a Rust node or |
| /// item). |
| fn format_def(tcx: TyCtxt, def_id: LocalDefId) -> Result<BindingsSnippet> { |
| match tcx.hir().get_by_def_id(def_id) { |
| Node::Item(item) => match item { |
| Item { kind: ItemKind::Fn(_, generics, _) | |
| ItemKind::Struct(_, generics) | |
| ItemKind::Enum(_, generics) | |
| ItemKind::Union(_, generics), |
| .. } if !generics.params.is_empty() => { |
| // TODO(b/258235219): Supporting function parameter types (or return types) that |
| // are references requires adding support for generic lifetime parameters. The |
| // required changes may cascade into `format_fn`'s usage of `no_bound_vars`. |
| bail!("Generics (even lifetime generics) are not supported yet"); |
| }, |
| Item { kind: ItemKind::Fn(..), .. } => { |
| format_fn(tcx, def_id) |
| } |
| Item { kind, .. } => bail!("Unsupported rustc_hir::hir::ItemKind: {}", kind.descr()), |
| }, |
| _unsupported_node => bail!("Unsupported rustc_hir::hir::Node"), |
| } |
| } |
| |
| /// Formats a C++ comment explaining why no bindings have been generated for |
| /// `local_def_id`. |
| fn format_unsupported_def( |
| tcx: TyCtxt, |
| local_def_id: LocalDefId, |
| err: anyhow::Error, |
| ) -> BindingsSnippet { |
| let span = tcx.sess().source_map().span_to_embeddable_string(tcx.def_span(local_def_id)); |
| let name = tcx.def_path_str(local_def_id.to_def_id()); |
| |
| // https://docs.rs/anyhow/latest/anyhow/struct.Error.html#display-representations |
| // says: To print causes as well [...], use the alternate selector “{:#}”. |
| let msg = format!("Error generating bindings for `{name}` defined at {span}: {err:#}"); |
| let comment = quote! { __NEWLINE__ __NEWLINE__ __COMMENT__ #msg __NEWLINE__ }; |
| |
| BindingsSnippet { api: comment, ..BindingsSnippet::new() } |
| } |
| |
| /// Formats all public items from the Rust crate being compiled. |
| fn format_crate(tcx: TyCtxt) -> Result<TokenStream> { |
| let snippets: BindingsSnippet = tcx |
| .hir() |
| .items() |
| .filter_map(|item_id| { |
| let def_id: LocalDefId = item_id.owner_id.def_id; |
| if !tcx.local_visibility(def_id).is_public() { |
| None |
| } else { |
| Some( |
| format_def(tcx, def_id) |
| .unwrap_or_else(|err| format_unsupported_def(tcx, def_id, err)), |
| ) |
| } |
| }) |
| .sum(); |
| |
| let includes = format_cc_includes(&snippets.includes); |
| let api = { |
| // TODO(b/254690602): Decide whether using `#crate_name` as the name of the |
| // top-level namespace is okay (e.g. investigate if this name is globally |
| // unique + ergonomic). |
| let crate_name = format_cc_ident(tcx.crate_name(LOCAL_CRATE).as_str())?; |
| let api_body = &snippets.api; |
| quote! { |
| namespace #crate_name { |
| #api_body |
| } |
| } |
| }; |
| let internals = { |
| match snippets.internals { |
| None => quote! {}, |
| Some(details_body) => quote! { |
| namespace __crubit_internal { |
| #details_body |
| } |
| __NEWLINE__ |
| }, |
| } |
| }; |
| Ok(quote! { |
| #includes __NEWLINE__ |
| #internals |
| #api |
| }) |
| } |
| |
| #[cfg(test)] |
| pub mod tests { |
| use super::{ |
| format_def, format_ret_ty_for_cc, format_ty_for_cc, format_ty_for_rs, BindingsSnippet, |
| GeneratedBindings, |
| }; |
| |
| use anyhow::Result; |
| use code_gen_utils::{format_cc_ident, format_cc_includes}; |
| use itertools::Itertools; |
| use proc_macro2::TokenStream; |
| use quote::quote; |
| use rustc_middle::ty::{Ty, TyCtxt}; |
| use rustc_span::def_id::LocalDefId; |
| use std::path::PathBuf; |
| |
| use token_stream_matchers::{assert_cc_matches, assert_cc_not_matches, assert_rs_not_matches}; |
| |
| pub fn get_sysroot_for_testing() -> PathBuf { |
| let runfiles = runfiles::Runfiles::create().unwrap(); |
| runfiles.rlocation(if std::env::var("LEGACY_TOOLCHAIN_RUST_TEST").is_ok() { |
| "google3/third_party/unsupported_toolchains/rust/toolchains/nightly" |
| } else { |
| "google3/nowhere/llvm/rust" |
| }) |
| } |
| |
| #[test] |
| #[should_panic(expected = "Test inputs shouldn't cause compilation errors")] |
| fn test_infra_panic_when_test_input_contains_syntax_errors() { |
| run_compiler("syntax error here", |_tcx| panic!("This part shouldn't execute")) |
| } |
| |
| #[test] |
| #[should_panic(expected = "Test inputs shouldn't cause compilation errors")] |
| fn test_infra_panic_when_test_input_triggers_analysis_errors() { |
| run_compiler("#![feature(no_such_feature)]", |_tcx| panic!("This part shouldn't execute")) |
| } |
| |
| #[test] |
| #[should_panic(expected = "Test inputs shouldn't cause compilation errors")] |
| fn test_infra_panic_when_test_input_triggers_warnings() { |
| run_compiler("pub fn foo(unused_parameter: i32) {}", |_tcx| { |
| panic!("This part shouldn't execute") |
| }) |
| } |
| |
| #[test] |
| fn test_infra_nightly_features_ok_in_test_input() { |
| // This test arbitrarily picks `yeet_expr` as an example of a feature that |
| // hasn't yet been stabilized. |
| let test_src = r#" |
| // This test is supposed to test that *nightly* features are ok |
| // in the test input. The `forbid` directive below helps to |
| // ensure that we'll realize in the future when the `yeet_expr` |
| // feature gets stabilized, making it not quite fitting for use |
| // in this test. |
| #![forbid(stable_features)] |
| |
| #![feature(yeet_expr)] |
| "#; |
| run_compiler(test_src, |_tcx| ()) |
| } |
| |
| #[test] |
| fn test_infra_stabilized_features_ok_in_test_input() { |
| // This test arbitrarily picks `const_ptr_offset_from` as an example of a |
| // feature that has been already stabilized. |
| run_compiler("#![feature(const_ptr_offset_from)]", |_tcx| ()) |
| } |
| |
| #[test] |
| #[should_panic(expected = "No items named `missing_name`.\n\ |
| Instead found:\n`bar`,\n`foo`,\n`m1`,\n`m2`,\n`std`")] |
| fn test_find_def_id_by_name_panic_when_no_item_with_matching_name() { |
| let test_src = r#" |
| pub extern "C" fn foo() {} |
| |
| pub mod m1 { |
| pub fn bar() {} |
| } |
| pub mod m2 { |
| pub fn bar() {} |
| } |
| "#; |
| run_compiler(test_src, |tcx| find_def_id_by_name(tcx, "missing_name")); |
| } |
| |
| #[test] |
| #[should_panic(expected = "More than one item named `some_name`")] |
| fn test_find_def_id_by_name_panic_when_multiple_items_with_matching_name() { |
| let test_src = r#" |
| pub mod m1 { |
| pub fn some_name() {} |
| } |
| pub mod m2 { |
| pub fn some_name() {} |
| } |
| "#; |
| run_compiler(test_src, |tcx| find_def_id_by_name(tcx, "some_name")); |
| } |
| |
| #[test] |
| fn test_generated_bindings_fn_extern_c() { |
| // This test covers only a single example of a function that should get a C++ |
| // binding. Additional coverage of how items are formatted is provided by |
| // `test_format_def_...` tests. |
| let test_src = r#" |
| #[no_mangle] |
| pub extern "C" fn public_function() { |
| println!("foo"); |
| } |
| "#; |
| test_generated_bindings(test_src, |bindings| { |
| let bindings = bindings.expect("Test expects success"); |
| assert_cc_matches!( |
| bindings.h_body, |
| quote! { |
| extern "C" void public_function(); |
| } |
| ); |
| // TODO(b/254097223): Verify Rust thunks here (once they actually get generated). |
| }); |
| } |
| |
| #[test] |
| fn test_generated_bindings_fn_export_name() { |
| // Coverage of how `BindingsSnippet::internals` are propagated when there are no |
| // `BindingsSnippet::impl` (e.g. no Rust thunks are needed). |
| let test_src = r#" |
| #[export_name = "export_name"] |
| pub extern "C" fn public_function(x: f64, y: f64) -> f64 { x + y } |
| "#; |
| test_generated_bindings(test_src, |bindings| { |
| let bindings = bindings.expect("Test expects success"); |
| assert_cc_matches!( |
| bindings.h_body, |
| quote! { |
| namespace __crubit_internal { |
| extern "C" double export_name(double x, double y); |
| } |
| namespace rust_out { |
| inline double public_function(double x, double y) { |
| return ::__crubit_internal::export_name(x, y); |
| } |
| } |
| } |
| ); |
| }); |
| } |
| |
| #[test] |
| fn test_generated_bindings_includes() { |
| let test_src = r#" |
| #[no_mangle] |
| pub extern "C" fn public_function(i: i32, d: isize, u: u64) { |
| dbg!(i); |
| dbg!(d); |
| dbg!(u); |
| } |
| "#; |
| test_generated_bindings(test_src, |bindings| { |
| let bindings = bindings.expect("Test expects success"); |
| assert_cc_matches!( |
| bindings.h_body, |
| quote! { |
| __HASH_TOKEN__ include <cstdint> ... |
| namespace ... { |
| extern "C" void public_function( |
| std::int32_t i, |
| std::intptr_t d, |
| std::uint64_t u); |
| } |
| } |
| ); |
| }); |
| } |
| |
| #[test] |
| fn test_generated_bindings_fn_non_pub() { |
| let test_src = r#" |
| #![allow(dead_code)] |
| extern "C" fn private_function() { |
| println!("foo"); |
| } |
| "#; |
| test_generated_bindings(test_src, |bindings| { |
| let bindings = bindings.expect("Test expects success"); |
| |
| // Non-public functions should not be present in the generated bindings. |
| assert_cc_not_matches!(bindings.h_body, quote! { private_function }); |
| assert_rs_not_matches!(bindings.rs_body, quote! { private_function }); |
| }); |
| } |
| |
| #[test] |
| fn test_generated_bindings_top_level_items() { |
| let test_src = "pub fn public_function() {}"; |
| test_generated_bindings(test_src, |bindings| { |
| let bindings = bindings.expect("Test expects success"); |
| let expected_comment_txt = |
| "Automatically @generated C++ bindings for the following Rust crate:\n\ |
| rust_out"; |
| assert_cc_matches!( |
| bindings.h_body, |
| quote! { |
| __COMMENT__ #expected_comment_txt |
| ... |
| __HASH_TOKEN__ pragma once |
| ... |
| namespace rust_out { |
| ... |
| } |
| } |
| ); |
| assert_cc_matches!( |
| bindings.rs_body, |
| quote! { |
| __COMMENT__ #expected_comment_txt |
| } |
| ); |
| }) |
| } |
| |
| #[test] |
| fn test_generated_bindings_unsupported_item() { |
| // This test verifies how `Err` from `format_def` is formatted as a C++ comment |
| // (in `format_crate` and `format_unsupported_def`). |
| // - This test covers only a single example of an unsupported item. Additional |
| // coverage is provided by `test_format_def_unsupported_...` tests. |
| // - This test somewhat arbitrarily chooses an example of an unsupported item, |
| // trying to pick one that 1) will never be supported (b/254104998 has some extra |
| // notes about APIs named after reserved C++ keywords) and 2) tests that the |
| // full error chain is included in the message. |
| let test_src = r#" |
| #[no_mangle] |
| pub extern "C" fn reinterpret_cast() {} |
| "#; |
| test_generated_bindings(test_src, |bindings| { |
| let bindings = bindings.expect("Test expects success"); |
| let expected_comment_txt = "Error generating bindings for `reinterpret_cast` \ |
| defined at <crubit_unittests.rs>:3:17: 3:53: \ |
| Error formatting function name: \ |
| `reinterpret_cast` is a C++ reserved keyword \ |
| and can't be used as a C++ identifier"; |
| assert_cc_matches!( |
| bindings.h_body, |
| quote! { |
| __COMMENT__ #expected_comment_txt |
| } |
| ); |
| }) |
| } |
| |
| #[test] |
| fn test_format_def_fn_extern_c_no_mangle_no_params_no_return_type() { |
| let test_src = r#" |
| #[no_mangle] |
| pub extern "C" fn public_function() {} |
| "#; |
| test_format_def(test_src, "public_function", |result| { |
| let result = result.expect("Test expects success here"); |
| assert!(result.includes.is_empty()); |
| assert!(result.internals.is_none()); |
| assert_cc_matches!( |
| result.api, |
| quote! { |
| extern "C" void public_function(); |
| } |
| ); |
| }); |
| } |
| |
| #[test] |
| fn test_format_def_fn_explicit_unit_return_type() { |
| // This test is very similar to the |
| // `test_format_def_fn_extern_c_no_mangle_no_params_no_return_type` above, except that the |
| // return type is explicitly spelled out. There is no difference in `ty::FnSig` so our |
| // code behaves exactly the same, but the test has been planned based on earlier, |
| // hir-focused approach and having this extra test coverage shouldn't hurt. (`hir::FnSig` |
| // and `hir::FnRetTy` _do_ see a difference between the two tests). |
| let test_src = r#" |
| #[no_mangle] |
| pub extern "C" fn explicit_unit_return_type() -> () {} |
| "#; |
| test_format_def(test_src, "explicit_unit_return_type", |result| { |
| let result = result.expect("Test expects success here"); |
| assert!(result.includes.is_empty()); |
| assert!(result.internals.is_none()); |
| assert_cc_matches!( |
| result.api, |
| quote! { |
| extern "C" void explicit_unit_return_type(); |
| } |
| ); |
| }); |
| } |
| |
| #[test] |
| fn test_format_def_fn_never_return_type() { |
| let test_src = r#" |
| #[no_mangle] |
| pub extern "C" fn never_returning_function() -> ! { |
| panic!("This function panics and therefore never returns"); |
| } |
| "#; |
| test_format_def(test_src, "never_returning_function", |result| { |
| // TODO(b/254507801): The function should be annotated with the `[[noreturn]]` |
| // attribute. |
| // TODO(b/254507801): Expect `crubit::Never` instead (see the bug for more |
| // details). |
| let result = result.expect("Test expects success here"); |
| assert!(result.includes.is_empty()); |
| assert!(result.internals.is_none()); |
| assert_cc_matches!( |
| result.api, |
| quote! { |
| extern "C" void never_returning_function(); |
| } |
| ); |
| }) |
| } |
| |
| #[test] |
| fn test_format_def_fn_mangling() { |
| // This test checks that bindings can be generated for `extern "C"` functions |
| // that do *not* have `#[no_mangle]` attribute. The test elides away |
| // the mangled name in the `assert_cc_matches` checks below, but |
| // end-to-end test coverage is provided by `test/functions`. |
| let test_src = r#" |
| pub extern "C" fn public_function(x: f64, y: f64) -> f64 { x + y } |
| "#; |
| test_format_def(test_src, "public_function", |result| { |
| let result = result.expect("Test expects success here"); |
| assert!(result.includes.is_empty()); |
| assert_cc_matches!( |
| result.api, |
| quote! { |
| inline double public_function(double x, double y) { |
| return ...(x, y); |
| } |
| } |
| ); |
| assert_cc_matches!( |
| result.internals.expect("This test expects separate extern-C decl"), |
| quote! { |
| extern "C" double ...(double x, double y); |
| } |
| ); |
| }); |
| } |
| |
| #[test] |
| fn test_format_def_fn_export_name() { |
| let test_src = r#" |
| #[export_name = "export_name"] |
| pub extern "C" fn public_function(x: f64, y: f64) -> f64 { x + y } |
| "#; |
| test_format_def(test_src, "public_function", |result| { |
| let result = result.expect("Test expects success here"); |
| assert!(result.includes.is_empty()); |
| assert_cc_matches!( |
| result.api, |
| quote! { |
| inline double public_function(double x, double y) { |
| return ::__crubit_internal::export_name(x, y); |
| } |
| } |
| ); |
| assert_cc_matches!( |
| result.internals.expect("This test expects separate extern-C decl"), |
| quote! { |
| extern "C" double export_name(double x, double y); |
| } |
| ); |
| }); |
| } |
| |
| #[test] |
| fn test_format_def_unsupported_fn_unsafe() { |
| // This tests how bindings for an `unsafe fn` are generated. |
| let test_src = r#" |
| #[no_mangle] |
| pub unsafe extern "C" fn foo() {} |
| "#; |
| test_format_def(test_src, "foo", |result| { |
| let err = result.expect_err("Test expects an error here"); |
| assert_eq!( |
| err, |
| "Bindings for `unsafe` functions \ |
| are not fully designed yet (b/254095482)" |
| ); |
| }); |
| } |
| |
| #[test] |
| fn test_format_def_fn_const() { |
| // This tests how bindings for an `const fn` are generated. |
| // |
| // Right now the `const` qualifier is ignored, but one can imagine that in the |
| // (very) long-term future such functions (including their bodies) could |
| // be translated into C++ `consteval` functions. |
| let test_src = r#" |
| pub const fn foo(i: i32) -> i32 { i * 42 } |
| "#; |
| test_format_def(test_src, "foo", |result| { |
| // TODO(lukasza): Update test expectations below once `const fn` example from |
| // the testcase doesn't just error out (and is instead supported as |
| // a non-`consteval` binding). |
| // TODO(b/254095787): Update test expectations below once `const fn` from Rust |
| // is translated into a `consteval` C++ function. |
| let err = result.expect_err("Test expects an error here"); |
| assert_eq!(err, "Non-C ABI is not supported yet (b/254097223)"); |
| }); |
| } |
| |
| #[test] |
| fn test_format_def_fn_with_c_unwind_abi() { |
| // See also https://rust-lang.github.io/rfcs/2945-c-unwind-abi.html |
| let test_src = r#" |
| #![feature(c_unwind)] |
| |
| #[no_mangle] |
| pub extern "C-unwind" fn may_throw() {} |
| "#; |
| test_format_def(test_src, "may_throw", |result| { |
| let result = result.expect("Test expects success here"); |
| assert!(result.includes.is_empty()); |
| assert!(result.internals.is_none()); |
| assert_cc_matches!( |
| result.api, |
| quote! { |
| extern "C" void may_throw(); |
| } |
| ); |
| }); |
| } |
| |
| #[test] |
| fn test_format_def_fn_with_type_aliased_return_type() { |
| // Type aliases disappear at the `rustc_middle::ty::Ty` level and therefore in |
| // the short-term the generated bindings also ignore type aliases. |
| // |
| // TODO(b/254096006): Consider preserving `type` aliases when generating |
| // bindings. |
| let test_src = r#" |
| type MyTypeAlias = f64; |
| |
| #[no_mangle] |
| pub extern "C" fn type_aliased_return() -> MyTypeAlias { 42.0 } |
| "#; |
| test_format_def(test_src, "type_aliased_return", |result| { |
| let result = result.expect("Test expects success here"); |
| assert!(result.includes.is_empty()); |
| assert!(result.internals.is_none()); |
| assert_cc_matches!( |
| result.api, |
| quote! { |
| extern "C" double type_aliased_return(); |
| } |
| ); |
| }); |
| } |
| |
| #[test] |
| fn test_format_def_unsupported_fn_name_is_reserved_cpp_keyword() { |
| let test_src = r#" |
| #[no_mangle] |
| pub extern "C" fn reinterpret_cast() -> () {} |
| "#; |
| test_format_def(test_src, "reinterpret_cast", |result| { |
| let err = result.expect_err("Test expects an error here"); |
| assert_eq!( |
| err, |
| "Error formatting function name: \ |
| `reinterpret_cast` is a C++ reserved keyword \ |
| and can't be used as a C++ identifier" |
| ); |
| }); |
| } |
| |
| #[test] |
| fn test_format_def_unsupported_fn_ret_type() { |
| let test_src = r#" |
| #[no_mangle] |
| pub extern "C" fn foo() -> *const i32 { std::ptr::null() } |
| "#; |
| test_format_def(test_src, "foo", |result| { |
| let err = result.expect_err("Test expects an error here"); |
| assert_eq!( |
| err, |
| "Error formatting function return type: \ |
| The following Rust type is not supported yet: *const i32" |
| ); |
| }); |
| } |
| |
| #[test] |
| fn test_format_def_unsupported_fn_with_late_bound_lifetimes() { |
| // TODO(b/258235219): Expect success after adding support for references. |
| let test_src = r#" |
| pub fn foo(arg: &i32) -> &i32 { arg } |
| |
| // Lifetime inference translates the above into: |
| // pub fn foo<'a>(arg: &'a i32) -> &'a i32 { ... } |
| // leaving 'a lifetime late-bound (it is bound with a lifetime |
| // taken from each of the callsites). In other words, we can't |
| // just call `no_bound_vars` on this `FnSig`'s `Binder`. |
| "#; |
| test_format_def(test_src, "foo", |result| { |
| let err = result.expect_err("Test expects an error here"); |
| assert_eq!( |
| err, |
| "Generics (even lifetime generics) are not supported yet" |
| ); |
| }); |
| } |
| |
| #[test] |
| fn test_format_def_unsupported_generic_fn() { |
| let test_src = r#" |
| use std::default::Default; |
| use std::fmt::Display; |
| pub fn generic_function<T: Default + Display>() { |
| println!("{}", T::default()); |
| } |
| "#; |
| test_format_def(test_src, "generic_function", |result| { |
| let err = result.expect_err("Test expects an error here"); |
| assert_eq!( |
| err, |
| "Generics (even lifetime generics) are not supported yet" |
| ); |
| }); |
| } |
| |
| #[test] |
| fn test_format_def_unsupported_generic_struct() { |
| let test_src = r#" |
| pub struct Point<T> { |
| pub x: T, |
| pub y: T, |
| } |
| "#; |
| test_format_def(test_src, "Point", |result| { |
| let err = result.expect_err("Test expects an error here"); |
| assert_eq!(err, "Generics (even lifetime generics) are not supported yet"); |
| }); |
| } |
| |
| #[test] |
| fn test_format_def_unsupported_generic_enum() { |
| let test_src = r#" |
| pub enum Point<T> { |
| Cartesian{x: T, y: T}, |
| Polar{angle: T, dist: T}, |
| } |
| "#; |
| test_format_def(test_src, "Point", |result| { |
| let err = result.expect_err("Test expects an error here"); |
| assert_eq!(err, "Generics (even lifetime generics) are not supported yet"); |
| }); |
| } |
| |
| #[test] |
| fn test_format_def_unsupported_generic_union() { |
| let test_src = r#" |
| pub union SomeUnion<T> { |
| pub x: std::mem::ManuallyDrop<T>, |
| pub y: i32, |
| } |
| "#; |
| test_format_def(test_src, "SomeUnion", |result| { |
| let err = result.expect_err("Test expects an error here"); |
| assert_eq!(err, "Generics (even lifetime generics) are not supported yet"); |
| }); |
| } |
| |
| #[test] |
| fn test_format_def_unsupported_fn_async() { |
| let test_src = r#" |
| pub async fn async_function() {} |
| "#; |
| test_format_def(test_src, "async_function", |result| { |
| let err = result.expect_err("Test expects an error here"); |
| assert_eq!(err, "Non-C ABI is not supported yet (b/254097223)"); |
| }); |
| } |
| |
| #[test] |
| fn test_format_def_unsupported_fn_non_c_abi() { |
| let test_src = r#" |
| pub fn default_rust_abi_function() {} |
| "#; |
| test_format_def(test_src, "default_rust_abi_function", |result| { |
| let err = result.expect_err("Test expects an error here"); |
| assert_eq!(err, "Non-C ABI is not supported yet (b/254097223)"); |
| }) |
| } |
| |
| #[test] |
| fn test_format_def_unsupported_fn_variadic() { |
| let test_src = r#" |
| #![feature(c_variadic)] |
| |
| #[no_mangle] |
| pub unsafe extern "C" fn variadic_function(_fmt: *const u8, ...) {} |
| "#; |
| test_format_def(test_src, "variadic_function", |result| { |
| // TODO(b/254097223): Add support for variadic functions. |
| let err = result.expect_err("Test expects an error here"); |
| assert_eq!(err, "C variadic functions are not supported (b/254097223)"); |
| }); |
| } |
| |
| #[test] |
| fn test_format_def_fn_params() { |
| let test_src = r#" |
| #[allow(unused_variables)] |
| #[no_mangle] |
| pub extern "C" fn foo(b: bool, f: f64) {} |
| "#; |
| test_format_def(test_src, "foo", |result| { |
| let result = result.expect("Test expects success here"); |
| assert!(result.includes.is_empty()); |
| assert!(result.internals.is_none()); |
| assert_cc_matches!( |
| result.api, |
| quote! { |
| extern "C" void foo(bool b, double f); |
| } |
| ); |
| }); |
| } |
| |
| #[test] |
| fn test_format_def_fn_param_name_reserved_keyword() { |
| let test_src = r#" |
| #[allow(unused_variables)] |
| #[no_mangle] |
| pub extern "C" fn some_function(reinterpret_cast: f64) {} |
| "#; |
| test_format_def(test_src, "some_function", |result| { |
| let result = result.expect("Test expects success here"); |
| assert!(result.includes.is_empty()); |
| assert!(result.internals.is_none()); |
| assert_cc_matches!( |
| result.api, |
| quote! { |
| extern "C" void some_function(double __param_0); |
| } |
| ); |
| }); |
| } |
| |
| #[test] |
| fn test_format_def_fn_export_name_with_anonymous_parameter_names() { |
| let test_src = r#" |
| #[export_name = "export_name"] |
| pub extern "C" fn public_function(_: f64, _: f64) {} |
| "#; |
| test_format_def(test_src, "public_function", |result| { |
| let result = result.expect("Test expects success here"); |
| assert!(result.includes.is_empty()); |
| assert_cc_matches!( |
| result.api, |
| quote! { |
| inline void public_function(double __param_0, double __param_1) { |
| return ::__crubit_internal::export_name(__param_0, __param_1); |
| } |
| } |
| ); |
| assert_cc_matches!( |
| result.internals.expect("This test expects separate extern-C decl"), |
| quote! { |
| extern "C" void export_name(double __param_0, double __param_1); |
| } |
| ); |
| }); |
| } |
| |
| |
| #[test] |
| fn test_format_def_unsupported_fn_param_type() { |
| let test_src = r#" |
| #[no_mangle] |
| pub extern "C" fn fn_with_params(_param: *const i32) {} |
| "#; |
| test_format_def(test_src, "fn_with_params", |result| { |
| let err = result.expect_err("Test expects an error here"); |
| assert_eq!(err, "Error formatting the type of parameter #0: \ |
| The following Rust type is not supported yet: \ |
| *const i32"); |
| }); |
| } |
| |
| #[test] |
| fn test_format_def_unsupported_fn_param_type_unit() { |
| let test_src = r#" |
| #[no_mangle] |
| pub fn fn_with_params(_param: ()) {} |
| "#; |
| test_format_def(test_src, "fn_with_params", |result| { |
| // TODO(b/254097223): Change the expectations once Rust-ABI functions are |
| // supported. Note that the test cannot use `extern "C"` in the |
| // meantime, because `()` is not FFI-safe (i.e. Rust won't allow |
| // using it with `extern "C"`). |
| let err = result.expect_err("Test expects an error here"); |
| assert_eq!(err, "Non-C ABI is not supported yet (b/254097223)"); |
| }); |
| } |
| |
| #[test] |
| fn test_format_def_unsupported_fn_param_type_never() { |
| let test_src = r#" |
| #![feature(never_type)] |
| |
| #[no_mangle] |
| pub extern "C" fn fn_with_params(_param: !) {} |
| "#; |
| test_format_def(test_src, "fn_with_params", |result| { |
| let err = result.expect_err("Test expects an error here"); |
| assert_eq!( |
| err, |
| "Error formatting the type of parameter #0: \ |
| The never type `!` is only supported as a return type (b/254507801)" |
| ); |
| }); |
| } |
| |
| #[test] |
| fn test_format_def_unsupported_hir_item_kind() { |
| let test_src = r#" |
| pub struct SomeStruct(i32); |
| "#; |
| test_format_def(test_src, "SomeStruct", |result| { |
| let err = result.expect_err("Test expects an error here"); |
| assert_eq!(err, "Unsupported rustc_hir::hir::ItemKind: struct"); |
| }); |
| } |
| |
| #[test] |
| fn test_format_ret_ty_for_cc_successes() { |
| // Test coverage for cases where `format_ret_ty_for_cc` returns an `Ok(...)`. |
| // Additional testcases are covered by `test_format_ty_for_cc_successes` |
| // (because `format_ret_ty_for_cc` delegates most cases to `format_ty_for_cc`). |
| let testcases = [ |
| // ( <Rust type>, <expected C++ type> ) |
| ("bool", "bool"), // TyKind::Bool |
| ("()", "void"), |
| // TODO(b/254507801): Expect `crubit::Never` instead (see the bug for more |
| // details). |
| ("!", "void"), |
| ]; |
| test_ty(&testcases, quote! {}, |desc, ty, expected| { |
| let actual = { |
| let cc_snippet = format_ret_ty_for_cc(ty).unwrap(); |
| assert!(cc_snippet.includes.is_empty()); |
| cc_snippet.snippet.to_string() |
| }; |
| let expected = expected.parse::<TokenStream>().unwrap().to_string(); |
| assert_eq!(actual, expected, "{desc}"); |
| }); |
| } |
| |
| #[test] |
| fn test_format_ty_for_cc_successes() { |
| // Test coverage for cases where `format_ty_for_cc` returns an `Ok(...)`. |
| // |
| // Using `std::int8_t` (instead of `::std::int8_t`) has been an explicit decision. The |
| // "Google C++ Style Guide" suggests to "avoid nested namespaces that match well-known |
| // top-level namespaces" and "in particular, [...] not create any nested std namespaces.". |
| // It seems desirable if the generated bindings conform to this aspect of the style guide, |
| // because it makes things easier for *users* of these bindings. |
| let testcases = [ |
| // ( <Rust type>, (<expected C++ type>, <expected #include>) ) |
| ("bool", ("bool", "")), |
| ("f32", ("float", "")), |
| ("f64", ("double", "")), |
| ("i8", ("std::int8_t", "cstdint")), |
| ("i16", ("std::int16_t", "cstdint")), |
| ("i32", ("std::int32_t", "cstdint")), |
| ("i64", ("std::int64_t", "cstdint")), |
| ("isize", ("std::intptr_t", "cstdint")), |
| ("u8", ("std::uint8_t", "cstdint")), |
| ("u16", ("std::uint16_t", "cstdint")), |
| ("u32", ("std::uint32_t", "cstdint")), |
| ("u64", ("std::uint64_t", "cstdint")), |
| ("usize", ("std::uintptr_t", "cstdint")), |
| ("char", ("std::uint32_t", "cstdint")), |
| // Extra parens/sugar are expected to be ignored: |
| ("(bool)", ("bool", "")), |
| ]; |
| let preamble = quote! { |
| #![allow(unused_parens)] |
| }; |
| test_ty(&testcases, preamble, |desc, ty, (expected_snippet, expected_include)| { |
| let (actual_snippet, actual_includes) = { |
| let cc_snippet = format_ty_for_cc(ty).unwrap(); |
| (cc_snippet.snippet.to_string(), cc_snippet.includes) |
| }; |
| |
| let expected_snippet = expected_snippet.parse::<TokenStream>().unwrap().to_string(); |
| assert_eq!(actual_snippet, expected_snippet, "{desc}"); |
| |
| if expected_include.is_empty() { |
| assert!(actual_includes.is_empty()); |
| } else { |
| let expected_header = format_cc_ident(expected_include).unwrap(); |
| assert_cc_matches!( |
| format_cc_includes(&actual_includes), |
| quote! { include <#expected_header> } |
| ); |
| } |
| }); |
| } |
| |
| #[test] |
| fn test_format_ty_for_cc_failures() { |
| // This test provides coverage for cases where `format_ty_for_cc` returns an |
| // `Err(...)`. |
| // |
| // TODO(lukasza): Add test coverage (here and in the "for_rs" flavours) for: |
| // - TyKind::Bound |
| // - TyKind::Dynamic (`dyn Eq`) |
| // - TyKind::Foreign (`extern type T`) |
| // - https://doc.rust-lang.org/beta/unstable-book/language-features/generators.html: |
| // TyKind::Generator, TyKind::GeneratorWitness |
| // - TyKind::Param |
| // - TyKind::Placeholder |
| // - TyKind::Projection |
| // |
| // It seems okay to have no test coverage for now for the following types (which |
| // should never be encountered when generating bindings and where |
| // `format_ty_for_cc` should panic): |
| // - TyKind::Closure |
| // - TyKind::Error |
| // - TyKind::FnDef |
| // - TyKind::Infer */ |
| let testcases = [ |
| // ( <Rust type>, <expected error message> ) |
| ( |
| "()", // Empty TyKind::Tuple |
| "The unit type `()` / `void` is only supported as a return type" |
| ), |
| ( |
| // TODO(b/254507801): Expect `crubit::Never` instead (see the bug for more |
| // details). |
| "!", // TyKind::Never |
| "The never type `!` is only supported as a return type (b/254507801)" |
| ), |
| ( |
| "(i32, i32)", // Non-empty TyKind::Tuple |
| "Tuples are not supported yet: (i32, i32) (b/254099023)", |
| ), |
| ( |
| "*const i32", // TyKind::Ptr |
| "The following Rust type is not supported yet: *const i32", |
| ), |
| ( |
| "&'static i32", // TyKind::Ref |
| "The following Rust type is not supported yet: &'static i32", |
| ), |
| ( |
| "[i32; 42]", // TyKind::Array |
| "The following Rust type is not supported yet: [i32; 42]", |
| ), |
| ( |
| "&'static [i32]", // TyKind::Slice (nested underneath TyKind::Ref) |
| "The following Rust type is not supported yet: &'static [i32]", |
| ), |
| ( |
| "&'static str", // TyKind::Str (nested underneath TyKind::Ref) |
| "The following Rust type is not supported yet: &'static str", |
| ), |
| ( |
| "impl Eq", // TyKind::Opaque |
| "The following Rust type is not supported yet: impl std::cmp::Eq", |
| ), |
| ( |
| "fn(i32) -> i32", // TyKind::FnPtr |
| "The following Rust type is not supported yet: fn(i32) -> i32", |
| ), |
| // TODO(b/254094650): Consider mapping this to Clang's (and GCC's) `__int128` |
| // or to `absl::in128`. |
| ("i128", "C++ doesn't have a standard equivalent of `i128` (b/254094650)"), |
| ("u128", "C++ doesn't have a standard equivalent of `u128` (b/254094650)"), |
| ("SomeStruct", "The following Rust type is not supported yet: SomeStruct"), |
| ("SomeEnum", "The following Rust type is not supported yet: SomeEnum"), |
| ("SomeUnion", "The following Rust type is not supported yet: SomeUnion"), |
| ]; |
| let preamble = quote! { |
| pub struct SomeStruct { |
| pub x: i32, |
| pub y: i32, |
| } |
| pub enum SomeEnum { |
| Cartesian{x: f64, y: f64}, |
| Polar{angle: f64, dist: f64}, |
| } |
| pub union SomeUnion { |
| pub x: i32, |
| pub y: i32, |
| } |
| }; |
| test_ty(&testcases, preamble, |desc, ty, expected_err| { |
| let anyhow_err = format_ty_for_cc(ty).unwrap_err(); |
| let actual_err = format!("{anyhow_err:#}"); |
| assert_eq!(&actual_err, *expected_err, "{desc}"); |
| }); |
| } |
| |
| #[test] |
| fn test_format_ty_for_rs_successes() { |
| // Test coverage for cases where `format_ty_for_rs` returns an `Ok(...)`. |
| let testcases = [ |
| // ( <Rust type>, <expected Rust spelling for ..._cc_api_impl.rs> ) |
| ("bool", "bool"), |
| ("f32", "f32"), |
| ("f64", "f64"), |
| ("i8", "i8"), |
| ("i16", "i16"), |
| ("i32", "i32"), |
| ("i64", "i64"), |
| ("i128", "i128"), |
| ("isize", "isize"), |
| ("u8", "u8"), |
| ("u16", "u16"), |
| ("u32", "u32"), |
| ("u64", "u64"), |
| ("u128", "u128"), |
| ("usize", "usize"), |
| ("char", "char"), |
| ("!", "!"), |
| ("()", "()"), |
| ]; |
| let preamble = quote! {}; |
| test_ty(&testcases, preamble, |desc, ty, expected_snippet| { |
| let actual_snippet = format_ty_for_rs(ty).unwrap().to_string(); |
| let expected_snippet = expected_snippet.parse::<TokenStream>().unwrap().to_string(); |
| assert_eq!(actual_snippet, expected_snippet, "{desc}"); |
| }); |
| } |
| |
| #[test] |
| fn test_format_ty_for_rs_failures() { |
| // This test provides coverage for cases where `format_ty_for_rs` returns an |
| // `Err(...)`. |
| let testcases = [ |
| // ( <Rust type>, <expected error message> ) |
| ( |
| "(i32, i32)", // Non-empty TyKind::Tuple |
| "Tuples are not supported yet: (i32, i32) (b/254099023)", |
| ), |
| ( |
| "*const i32", // TyKind::Ptr |
| "The following Rust type is not supported yet: *const i32", |
| ), |
| ( |
| "&'static i32", // TyKind::Ref |
| "The following Rust type is not supported yet: &'static i32", |
| ), |
| ( |
| "[i32; 42]", // TyKind::Array |
| "The following Rust type is not supported yet: [i32; 42]", |
| ), |
| ( |
| "&'static [i32]", // TyKind::Slice (nested underneath TyKind::Ref) |
| "The following Rust type is not supported yet: &'static [i32]", |
| ), |
| ( |
| "&'static str", // TyKind::Str (nested underneath TyKind::Ref) |
| "The following Rust type is not supported yet: &'static str", |
| ), |
| ( |
| "impl Eq", // TyKind::Opaque |
| "The following Rust type is not supported yet: impl std::cmp::Eq", |
| ), |
| ( |
| "fn(i32) -> i32", // TyKind::FnPtr |
| "The following Rust type is not supported yet: fn(i32) -> i32", |
| ), |
| ("SomeStruct", "The following Rust type is not supported yet: SomeStruct"), |
| ("SomeEnum", "The following Rust type is not supported yet: SomeEnum"), |
| ("SomeUnion", "The following Rust type is not supported yet: SomeUnion"), |
| ]; |
| let preamble = quote! { |
| pub struct SomeStruct { |
| pub x: i32, |
| pub y: i32, |
| } |
| pub enum SomeEnum { |
| Cartesian{x: f64, y: f64}, |
| Polar{angle: f64, dist: f64}, |
| } |
| pub union SomeUnion { |
| pub x: i32, |
| pub y: i32, |
| } |
| }; |
| test_ty(&testcases, preamble, |desc, ty, expected_err| { |
| let anyhow_err = format_ty_for_rs(ty).unwrap_err(); |
| let actual_err = format!("{anyhow_err:#}"); |
| assert_eq!(&actual_err, *expected_err, "{desc}"); |
| }); |
| } |
| |
| fn test_ty<TestFn, Expectation>( |
| testcases: &[(&str, Expectation)], |
| preamble: TokenStream, |
| test_fn: TestFn, |
| ) where |
| TestFn: Fn(/* testcase_description: */ &str, Ty, &Expectation) + Sync, |
| Expectation: Sync, |
| { |
| for (index, (input, expected)) in testcases.iter().enumerate() { |
| let desc = format!("test #{index}: test input: `{input}`"); |
| let input = { |
| let ty_tokens: TokenStream = input.parse().unwrap(); |
| let input = quote! { |
| #preamble |
| pub fn test_function() -> #ty_tokens { panic!("") } |
| }; |
| input.to_string() |
| }; |
| run_compiler(input, |tcx| { |
| let def_id = find_def_id_by_name(tcx, "test_function"); |
| let ty = tcx.fn_sig(def_id.to_def_id()).no_bound_vars().unwrap().output(); |
| test_fn(&desc, ty, expected); |
| }); |
| } |
| } |
| |
| /// Tests invoking `format_def` on the item with the specified `name` from |
| /// the given Rust `source`. Returns the result of calling |
| /// `test_function` with `format_def`'s result as an argument. |
| /// (`test_function` should typically `assert!` that it got the expected |
| /// result from `format_def`.) |
| fn test_format_def<F, T>(source: &str, name: &str, test_function: F) -> T |
| where |
| F: FnOnce(Result<BindingsSnippet, String>) -> T + Send, |
| T: Send, |
| { |
| run_compiler(source, |tcx| { |
| let def_id = find_def_id_by_name(tcx, name); |
| let result = format_def(tcx, def_id); |
| |
| // https://docs.rs/anyhow/latest/anyhow/struct.Error.html#display-representations says: |
| // To print causes as well [...], use the alternate selector “{:#}”. |
| let result = result.map_err(|anyhow_err| format!("{anyhow_err:#}")); |
| |
| test_function(result) |
| }) |
| } |
| |
| /// Finds the definition id of a Rust item with the specified `name`. |
| /// Panics if no such item is found, or if there is more than one match. |
| fn find_def_id_by_name(tcx: TyCtxt, name: &str) -> LocalDefId { |
| let hir_items = || tcx.hir().items().map(|item_id| tcx.hir().item(item_id)); |
| let items_with_matching_name = |
| hir_items().filter(|item| item.ident.name.as_str() == name).collect_vec(); |
| match *items_with_matching_name.as_slice() { |
| [] => { |
| let found_names = hir_items() |
| .map(|item| item.ident.name.as_str()) |
| .filter(|s| !s.is_empty()) |
| .sorted() |
| .dedup() |
| .map(|name| format!("`{name}`")) |
| .join(",\n"); |
| panic!("No items named `{name}`.\nInstead found:\n{found_names}"); |
| } |
| [item] => item.owner_id.def_id, |
| _ => panic!("More than one item named `{name}`"), |
| } |
| } |
| |
| /// Tests invoking `GeneratedBindings::generate` on the given Rust `source`. |
| /// Returns the result of calling `test_function` with the generated |
| /// bindings as an argument. (`test_function` should typically `assert!` |
| /// that it got the expected `GeneratedBindings`.) |
| fn test_generated_bindings<F, T>(source: &str, test_function: F) -> T |
| where |
| F: FnOnce(Result<GeneratedBindings>) -> T + Send, |
| T: Send, |
| { |
| run_compiler(source, |tcx| test_function(GeneratedBindings::generate(tcx))) |
| } |
| |
| /// Invokes the Rust compiler on the given Rust `source` and then calls `f` |
| /// on the `TyCtxt` representation of the compiled `source`. |
| fn run_compiler<F, T>(source: impl Into<String>, f: F) -> T |
| where |
| F: for<'tcx> FnOnce(TyCtxt<'tcx>) -> T + Send, |
| T: Send, |
| { |
| use rustc_session::config::{ |
| CodegenOptions, CrateType, Input, Options, OutputType, OutputTypes, |
| }; |
| |
| const TEST_FILENAME: &str = "crubit_unittests.rs"; |
| |
| // Setting `output_types` that will trigger code gen - otherwise some parts of |
| // the analysis will be missing (e.g. `tcx.exported_symbols()`). |
| // The choice of `Bitcode` is somewhat arbitrary (e.g. `Assembly`, |
| // `Mir`, etc. would also trigger code gen). |
| let output_types = OutputTypes::new(&[(OutputType::Bitcode, None /* PathBuf */)]); |
| |
| let opts = Options { |
| crate_types: vec![CrateType::Rlib], // Test inputs simulate library crates. |
| maybe_sysroot: Some(get_sysroot_for_testing()), |
| output_types, |
| edition: rustc_span::edition::Edition::Edition2021, |
| unstable_features: rustc_feature::UnstableFeatures::Allow, |
| lint_opts: vec![ |
| ("warnings".to_string(), rustc_lint_defs::Level::Deny), |
| ("stable_features".to_string(), rustc_lint_defs::Level::Allow), |
| ], |
| cg: CodegenOptions { |
| panic: Some(rustc_target::spec::PanicStrategy::Abort), |
| ..Default::default() |
| }, |
| ..Default::default() |
| }; |
| |
| let config = rustc_interface::interface::Config { |
| opts, |
| crate_cfg: Default::default(), |
| crate_check_cfg: Default::default(), |
| input: Input::Str { |
| name: rustc_span::FileName::Custom(TEST_FILENAME.to_string()), |
| input: source.into(), |
| }, |
| input_path: None, |
| output_file: None, |
| output_dir: None, |
| file_loader: None, |
| lint_caps: Default::default(), |
| parse_sess_created: None, |
| register_lints: None, |
| override_queries: None, |
| make_codegen_backend: None, |
| registry: rustc_errors::registry::Registry::new(rustc_error_codes::DIAGNOSTICS), |
| }; |
| |
| rustc_interface::interface::run_compiler(config, |compiler| { |
| compiler.enter(|queries| { |
| use rustc_interface::interface::Result; |
| let result: Result<Result<()>> = super::enter_tcx(queries, |tcx| { |
| // Explicitly force full `analysis` stage to detect compilation |
| // errors that the earlier stages might miss. This helps ensure that the |
| // test inputs are valid Rust (even if `f` wouldn't |
| // have triggered full analysis). |
| tcx.analysis(()) |
| }); |
| |
| // Flatten the outer and inner results into a single result. (outer result |
| // comes from `enter_tcx`; inner result comes from `analysis`). |
| // |
| // TODO(lukasza): Use `Result::flatten` API when it gets stabilized. See also |
| // https://github.com/rust-lang/rust/issues/70142 |
| let result: Result<()> = result.and_then(|result| result); |
| |
| // `analysis` might succeed even if there are some lint / warning errors. |
| // Detecting these requires explicitly checking `compile_status`. |
| let result: Result<()> = result.and_then(|()| compiler.session().compile_status()); |
| |
| // Run the provided callback. |
| let result: Result<T> = result.and_then(|()| super::enter_tcx(queries, f)); |
| result.expect("Test inputs shouldn't cause compilation errors") |
| }) |
| }) |
| } |
| } |
