1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
#![recursion_limit = "128"]
extern crate proc_macro;
use proc_macro::TokenStream;
use proc_macro2::TokenStream as TokenStream2;
use quote::{quote, quote_spanned, TokenStreamExt};
use syn::spanned::Spanned;
use syn::{
parse_macro_input, parse_quote, Error, Expr, ExprLit, ExprPath, FnArg, Ident, ItemFn,
ItemStruct, Lit, LitStr, Pat, Visibility,
};
macro_rules! err {
($span:expr, $message:expr $(,)?) => {
Error::new($span.span(), $message).to_compile_error()
};
($span:expr, $message:expr, $($args:expr),*) => {
Error::new($span.span(), format!($message, $($args),*)).to_compile_error()
};
}
/// Attribute macro for marking structs as UEFI protocols.
///
/// The macro takes one argument, either a GUID string or the path to a `Guid`
/// constant.
///
/// The macro can only be applied to a struct. It implements the
/// [`Protocol`] trait and the `unsafe` [`Identify`] trait for the
/// struct.
///
/// # Safety
///
/// The caller must ensure that the correct GUID is attached to the
/// type. An incorrect GUID could lead to invalid casts and other
/// unsound behavior.
///
/// # Example
///
/// ```
/// use uefi::{Guid, Identify, guid};
/// use uefi::proto::unsafe_protocol;
///
/// #[unsafe_protocol("12345678-9abc-def0-1234-56789abcdef0")]
/// struct ExampleProtocol1 {}
///
/// const PROTO_GUID: Guid = guid!("12345678-9abc-def0-1234-56789abcdef0");
/// #[unsafe_protocol(PROTO_GUID)]
/// struct ExampleProtocol2 {}
///
/// assert_eq!(ExampleProtocol1::GUID, PROTO_GUID);
/// assert_eq!(ExampleProtocol2::GUID, PROTO_GUID);
/// ```
///
/// [`Identify`]: https://docs.rs/uefi/latest/uefi/trait.Identify.html
/// [`Protocol`]: https://docs.rs/uefi/latest/uefi/proto/trait.Protocol.html
/// [send-and-sync]: https://doc.rust-lang.org/nomicon/send-and-sync.html
#[proc_macro_attribute]
pub fn unsafe_protocol(args: TokenStream, input: TokenStream) -> TokenStream {
let expr = parse_macro_input!(args as Expr);
let guid_val = match expr {
Expr::Lit(ExprLit {
lit: Lit::Str(lit), ..
}) => {
quote!(::uefi::guid!(#lit))
}
Expr::Path(ExprPath { path, .. }) => quote!(#path),
_ => {
return err!(
expr,
"macro input must be either a string literal or path to a constant"
)
.into()
}
};
let item_struct = parse_macro_input!(input as ItemStruct);
let ident = &item_struct.ident;
let (impl_generics, ty_generics, where_clause) = item_struct.generics.split_for_impl();
quote! {
#item_struct
unsafe impl #impl_generics ::uefi::Identify for #ident #ty_generics #where_clause {
const GUID: ::uefi::Guid = #guid_val;
}
impl #impl_generics ::uefi::proto::Protocol for #ident #ty_generics #where_clause {}
}
.into()
}
/// Get the name of a function's argument at `arg_index`.
fn get_function_arg_name(f: &ItemFn, arg_index: usize, errors: &mut TokenStream2) -> Option<Ident> {
if let Some(FnArg::Typed(arg)) = f.sig.inputs.iter().nth(arg_index) {
if let Pat::Ident(pat_ident) = &*arg.pat {
// The argument has a valid name such as `handle` or `_handle`.
Some(pat_ident.ident.clone())
} else {
// The argument is unnamed, i.e. `_`.
errors.append_all(err!(
arg.pat.span(),
"Entry method's arguments must be named"
));
None
}
} else {
// Either there are too few arguments, or it's the wrong kind of
// argument (e.g. `self`).
//
// Don't append an error in this case. The error will be caught
// by the typecheck later on, which will give a better error
// message.
None
}
}
/// Custom attribute for a UEFI executable entry point.
///
/// This attribute modifies a function to mark it as the entry point for
/// a UEFI executable. The function must have two parameters, [`Handle`]
/// and [`SystemTable<Boot>`], and return a [`Status`]. The function can
/// optionally be `unsafe`.
///
/// Due to internal implementation details the parameters must both be
/// named, so `arg` or `_arg` are allowed, but not `_`.
///
/// The [`BootServices::set_image_handle`] function will be called
/// automatically with the image [`Handle`] argument.
///
/// # Examples
///
/// ```no_run
/// #![no_main]
///
/// use uefi::prelude::*;
///
/// #[entry]
/// fn main(image: Handle, st: SystemTable<Boot>) -> Status {
/// Status::SUCCESS
/// }
/// ```
///
/// [`Handle`]: https://docs.rs/uefi/latest/uefi/data_types/struct.Handle.html
/// [`SystemTable<Boot>`]: https://docs.rs/uefi/latest/uefi/table/struct.SystemTable.html
/// [`Status`]: https://docs.rs/uefi/latest/uefi/struct.Status.html
/// [`BootServices::set_image_handle`]: https://docs.rs/uefi/latest/uefi/table/boot/struct.BootServices.html#method.set_image_handle
#[proc_macro_attribute]
pub fn entry(args: TokenStream, input: TokenStream) -> TokenStream {
// This code is inspired by the approach in this embedded Rust crate:
// https://github.com/rust-embedded/cortex-m-rt/blob/965bf1e3291571e7e3b34834864117dc020fb391/macros/src/lib.rs#L85
let mut errors = TokenStream2::new();
if !args.is_empty() {
errors.append_all(err!(
TokenStream2::from(args),
"Entry attribute accepts no arguments"
));
}
let mut f = parse_macro_input!(input as ItemFn);
if let Some(ref abi) = f.sig.abi {
errors.append_all(err!(abi, "Entry method must have no ABI modifier"));
}
if let Some(asyncness) = f.sig.asyncness {
errors.append_all(err!(asyncness, "Entry method should not be async"));
}
if let Some(constness) = f.sig.constness {
errors.append_all(err!(constness, "Entry method should not be const"));
}
if !f.sig.generics.params.is_empty() {
errors.append_all(err!(
f.sig.generics.params,
"Entry method should not be generic"
));
}
let image_handle_ident = get_function_arg_name(&f, 0, &mut errors);
let system_table_ident = get_function_arg_name(&f, 1, &mut errors);
// show most errors at once instead of one by one
if !errors.is_empty() {
return errors.into();
}
let signature_span = f.sig.span();
f.sig.abi = Some(syn::parse2(quote_spanned! (signature_span=> extern "efiapi")).unwrap());
// allow the entry function to be unsafe (by moving the keyword around so that it actually works)
let unsafety = &f.sig.unsafety;
// strip any visibility modifiers
f.vis = Visibility::Inherited;
// Set the global image handle. If `image_handle_ident` is `None`
// then the typecheck is going to fail anyway.
if let Some(image_handle_ident) = image_handle_ident {
f.block.stmts.insert(
0,
parse_quote! {
unsafe {
#system_table_ident.boot_services().set_image_handle(#image_handle_ident);
}
},
);
}
let fn_ident = &f.sig.ident;
// Get an iterator of the function inputs types. This is needed instead of
// directly using `sig.inputs` because patterns you can use in fn items like
// `mut <arg>` aren't valid in fn pointers.
let fn_inputs = f.sig.inputs.iter().map(|arg| match arg {
FnArg::Receiver(arg) => quote!(#arg),
FnArg::Typed(arg) => {
let ty = &arg.ty;
quote!(#ty)
}
});
let fn_output = &f.sig.output;
let fn_type_check = quote_spanned! {signature_span=>
// Cast from the function type to a function pointer with the same
// signature first, then try to assign that to an unnamed constant with
// the desired function pointer type.
//
// The cast is used to avoid an "expected fn pointer, found fn item"
// error if the signature is wrong, since that's not what we are
// interested in here. Instead we want to tell the user what
// specifically in the function signature is incorrect.
const _:
// The expected fn pointer type.
#unsafety extern "efiapi" fn(::uefi::Handle, ::uefi::table::SystemTable<::uefi::table::Boot>) -> ::uefi::Status =
// Cast from a fn item to a function pointer.
#fn_ident as #unsafety extern "efiapi" fn(#(#fn_inputs),*) #fn_output;
};
let result = quote! {
#fn_type_check
#[export_name = "efi_main"]
#f
};
result.into()
}
/// Builds a `CStr8` literal at compile time from a string literal.
///
/// This will throw a compile error if an invalid character is in the passed string.
///
/// # Example
/// ```
/// # use uefi_macros::cstr8;
/// // Empty string
/// assert_eq!(cstr8!().to_u16_slice_with_nul(), [0]);
/// assert_eq!(cstr8!("").to_u16_slice_with_nul(), [0]);
/// // Non-empty string
/// assert_eq!(cstr8!("test").as_bytes(), [116, 101, 115, 116, 0]);
/// ```
#[proc_macro]
pub fn cstr8(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
// Accept empty input.
if input.is_empty() {
return quote!(unsafe { ::uefi::CStr16::from_u16_with_nul_unchecked(&[0]) }).into();
}
let input: LitStr = parse_macro_input!(input);
let input = input.value();
// Accept "" input.
if input.is_empty() {
return quote!(unsafe { ::uefi::CStr16::from_u16_with_nul_unchecked(&[0]) }).into();
}
// Accept any non-empty string input.
match input
.chars()
.map(u8::try_from)
.collect::<Result<Vec<u8>, _>>()
{
Ok(c) => {
quote!(unsafe { ::uefi::CStr8::from_bytes_with_nul_unchecked(&[ #(#c),* , 0 ]) }).into()
}
Err(_) => syn::Error::new_spanned(input, "invalid character in string")
.into_compile_error()
.into(),
}
}
/// Builds a `CStr16` literal at compile time from a string literal.
///
/// This will throw a compile error if an invalid character is in the passed string.
///
/// # Example
/// ```rust
/// # use uefi_macros::cstr16;
/// // Empty string
/// assert_eq!(cstr16!().to_u16_slice_with_nul(), [0]);
/// assert_eq!(cstr16!("").to_u16_slice_with_nul(), [0]);
/// // Non-empty string
/// assert_eq!(cstr16!("test €").to_u16_slice_with_nul(), [116, 101, 115, 116, 32, 8364, 0]);
/// ```
#[proc_macro]
pub fn cstr16(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
// Accept empty input.
if input.is_empty() {
return quote!(unsafe { ::uefi::CStr16::from_u16_with_nul_unchecked(&[0]) }).into();
}
let input: LitStr = parse_macro_input!(input);
let input = input.value();
// Accept "" input.
if input.is_empty() {
return quote!(unsafe { ::uefi::CStr16::from_u16_with_nul_unchecked(&[0]) }).into();
}
// Accept any non-empty string input.
match input
.chars()
.map(|c| u16::try_from(c as u32))
.collect::<Result<Vec<u16>, _>>()
{
Ok(c) => {
quote!(unsafe { ::uefi::CStr16::from_u16_with_nul_unchecked(&[ #(#c),* , 0 ]) }).into()
}
Err(_) => syn::Error::new_spanned(
input,
"There are UTF-8 characters that can't be transformed to UCS-2 character",
)
.into_compile_error()
.into(),
}
}