Third-Party Import of: https://crates.io/crates/uefi-macros
Request Document: go/android3p
For CL Reviewers: go/android3p#reviewing-a-cl
For Build Team: go/ab-third-party-imports
Generated through these steps
(in ~src/android/aosp-main-future-without-vendor repo):
1. python3 development/scripts/get_rust_pkg.py -add3prf -v -o /tmp
uefi-macros-0.17.0
2. cp -r /tmp/uefi-macros-0.17.0/* external/rust/crates/uefi-macros
Test: -
Bug: 375626990
Original import of the code can be found at: https://googleplex-android.googlesource.com/platform/external/rust/crates/uefi-macros/+/refs/heads/third-party-review.
Security Questionnaire: http://b/375626990#comment1
Change-Id: Ie03bef93a74dae054f209a5f87a4d14056e0b1c9
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..aa75460
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,103 @@
+# uefi-macros - [Unreleased]
+
+
+# uefi-macros - 0.17.0 (2024-10-23)
+
+## Changed
+
+- **Breaking:** The `entry` no longer accepts any arguments.
+
+
+# uefi-macros - 0.16.0 (2024-09-09)
+
+## Changed
+
+- Internal updates to the `entry` macro related to
+ [Deprecating SystemTable/BootServices/RuntimeServices][funcmigrate].
+
+[funcmigrate]: ../docs/funcs_migration.md
+
+
+# uefi-macros - 0.15.0 (2024-08-20)
+
+## Changed
+
+- The `entry` macro now accepts a function with zero arguments in addition to
+ the two-argument form.
+
+
+# uefi-macros - 0.14.0 (2024-07-02)
+
+## Changed
+- The `entry` macro now sets the global system table pointer with `uefi::set_system_table`.
+
+## Removed
+- Removed the `cstr8` and `cstr16` macros. Use the declarative macros of the
+ same names exported by the `uefi` crate as a replacement.
+
+# uefi-macros - 0.13.0 (2023-11-12)
+
+## Changed
+- The dev-dependency on `uefi` is now path-only.
+
+# uefi-macros - 0.12.0 (2023-05-15)
+
+## Changed
+- The `unsafe_protocol` macro no longer makes protocols `!Send` and
+ `!Sync`. Protocols can only be used while boot services are active, and that's
+ already a single-threaded environment, so these negative traits do not have
+ any effect.
+- The `unsafe_protocol` macro now accepts the path of a `Guid` constant in
+ addition to a string literal.
+- The `cstr8` and the `cstr16` macros now both accept `(nothing)` and `""`
+ (empty inputs) to create valid empty strings. They include the null-byte.
+- The `entry` macro now works correctly with docstrings.
+
+# uefi-macros - 0.11.0 (2023-03-19)
+
+## Changed
+- Errors produced by the `entry` macro have been improved.
+
+# uefi-macros - 0.10.0 (2023-01-16)
+
+## Added
+- Added the `unsafe_protocol` macro to provide a slightly nicer way to
+ implement protocols.
+
+## Removed
+- The `unsafe_guid` attribute macro and `Protocol` derive macro have
+ been removed. For implementing protocols, use the `unsafe_protocol`
+ macro instead. For any other implementations of the `Identify` trait,
+ implement it directly.
+
+# uefi-macros - 0.9.0 (2022-11-15)
+
+## Added
+- Added a `guid!` macro. This is similar to `Guid::from_values`, but
+ takes a more convenient string argument like the `unsafe_guid!`
+ attribute macro.
+
+# uefi-macros - 0.8.0 (2022-09-09)
+
+## Changed
+- The `#[entry]` macro now calls `BootServices::set_image_handle` to set
+ the global image handle. Due to this change, the two arguments to main
+ must both be named (e.g. `image: Handle` and `_image: Handle` are both
+ OK, but not `_: Handle`).
+
+# uefi-macros - 0.7.1 (2022-08-26)
+
+## Changed
+- Relaxed the version requirements for the `proc-macro2`, `quote`, and
+ `sync` dependencies to allow earlier patch versions.
+
+# uefi-macros - 0.7.0 (2022-05-16)
+
+## Added
+- Added `cstr8` and `cstr16` macros for creating `CStr8`/`CStr16` string literals
+ at compile time.
+
+# uefi-macros - 0.6.1 (2022-03-15)
+
+## Changed
+- Updated to the 2021 edition.
diff --git a/Cargo.toml b/Cargo.toml
new file mode 100644
index 0000000..0f9c786
--- /dev/null
+++ b/Cargo.toml
@@ -0,0 +1,57 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g., crates.io) dependencies.
+#
+# If you are reading this file be aware that the original Cargo.toml
+# will likely look very different (and much more reasonable).
+# See Cargo.toml.orig for the original contents.
+
+[package]
+edition = "2021"
+rust-version = "1.70"
+name = "uefi-macros"
+version = "0.17.0"
+authors = ["The Rust OSDev team"]
+build = false
+autobins = false
+autoexamples = false
+autotests = false
+autobenches = false
+description = "Procedural macros for the `uefi` crate."
+readme = "README.md"
+keywords = [
+ "uefi",
+ "efi",
+]
+categories = [
+ "embedded",
+ "no-std",
+ "api-bindings",
+]
+license = "MPL-2.0"
+repository = "https://github.com/rust-osdev/uefi-rs"
+
+[lib]
+name = "uefi_macros"
+path = "src/lib.rs"
+proc-macro = true
+
+[[test]]
+name = "compilation"
+path = "tests/compilation.rs"
+
+[dependencies.proc-macro2]
+version = "1.0.28"
+
+[dependencies.quote]
+version = "1.0.9"
+
+[dependencies.syn]
+version = "2.0.4"
+features = ["full"]
+
+[dev-dependencies.trybuild]
+version = "1.0.61"
diff --git a/Cargo.toml.orig b/Cargo.toml.orig
new file mode 100644
index 0000000..046571d
--- /dev/null
+++ b/Cargo.toml.orig
@@ -0,0 +1,25 @@
+[package]
+name = "uefi-macros"
+version = "0.17.0"
+readme = "README.md"
+description = "Procedural macros for the `uefi` crate."
+
+authors.workspace = true
+categories.workspace = true
+edition.workspace = true
+keywords.workspace = true
+license.workspace = true
+repository.workspace = true
+rust-version.workspace = true
+
+[lib]
+proc-macro = true
+
+[dependencies]
+proc-macro2 = "1.0.28"
+quote = "1.0.9"
+syn = { version = "2.0.4", features = ["full"] }
+
+[dev-dependencies]
+trybuild = "1.0.61"
+uefi = { path = "../uefi", default-features = false }
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..a612ad9
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+ means each individual or legal entity that creates, contributes to
+ the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+ means the combination of the Contributions of others (if any) used
+ by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+ means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+ means Source Code Form to which the initial Contributor has attached
+ the notice in Exhibit A, the Executable Form of such Source Code
+ Form, and Modifications of such Source Code Form, in each case
+ including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+ means
+
+ (a) that the initial Contributor has attached the notice described
+ in Exhibit B to the Covered Software; or
+
+ (b) that the Covered Software was made available under the terms of
+ version 1.1 or earlier of the License, but not also under the
+ terms of a Secondary License.
+
+1.6. "Executable Form"
+ means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+ means a work that combines Covered Software with other material, in
+ a separate file or files, that is not Covered Software.
+
+1.8. "License"
+ means this document.
+
+1.9. "Licensable"
+ means having the right to grant, to the maximum extent possible,
+ whether at the time of the initial grant or subsequently, any and
+ all of the rights conveyed by this License.
+
+1.10. "Modifications"
+ means any of the following:
+
+ (a) any file in Source Code Form that results from an addition to,
+ deletion from, or modification of the contents of Covered
+ Software; or
+
+ (b) any new file in Source Code Form that contains any Covered
+ Software.
+
+1.11. "Patent Claims" of a Contributor
+ means any patent claim(s), including without limitation, method,
+ process, and apparatus claims, in any patent Licensable by such
+ Contributor that would be infringed, but for the grant of the
+ License, by the making, using, selling, offering for sale, having
+ made, import, or transfer of either its Contributions or its
+ Contributor Version.
+
+1.12. "Secondary License"
+ means either the GNU General Public License, Version 2.0, the GNU
+ Lesser General Public License, Version 2.1, the GNU Affero General
+ Public License, Version 3.0, or any later versions of those
+ licenses.
+
+1.13. "Source Code Form"
+ means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+ means an individual or a legal entity exercising rights under this
+ License. For legal entities, "You" includes any entity that
+ controls, is controlled by, or is under common control with You. For
+ purposes of this definition, "control" means (a) the power, direct
+ or indirect, to cause the direction or management of such entity,
+ whether by contract or otherwise, or (b) ownership of more than
+ fifty percent (50%) of the outstanding shares or beneficial
+ ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+ Licensable by such Contributor to use, reproduce, make available,
+ modify, display, perform, distribute, and otherwise exploit its
+ Contributions, either on an unmodified basis, with Modifications, or
+ as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+ for sale, have made, import, and otherwise transfer either its
+ Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+ or
+
+(b) for infringements caused by: (i) Your and any other third party's
+ modifications of Covered Software, or (ii) the combination of its
+ Contributions with other software (except as part of its Contributor
+ Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+ its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+ Form, as described in Section 3.1, and You must inform recipients of
+ the Executable Form how they can obtain a copy of such Source Code
+ Form by reasonable means in a timely manner, at a charge no more
+ than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+ License, or sublicense it under different terms, provided that the
+ license for the Executable Form does not attempt to limit or alter
+ the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+* *
+* 6. Disclaimer of Warranty *
+* ------------------------- *
+* *
+* Covered Software is provided under this License on an "as is" *
+* basis, without warranty of any kind, either expressed, implied, or *
+* statutory, including, without limitation, warranties that the *
+* Covered Software is free of defects, merchantable, fit for a *
+* particular purpose or non-infringing. The entire risk as to the *
+* quality and performance of the Covered Software is with You. *
+* Should any Covered Software prove defective in any respect, You *
+* (not any Contributor) assume the cost of any necessary servicing, *
+* repair, or correction. This disclaimer of warranty constitutes an *
+* essential part of this License. No use of any Covered Software is *
+* authorized under this License except under this disclaimer. *
+* *
+************************************************************************
+
+************************************************************************
+* *
+* 7. Limitation of Liability *
+* -------------------------- *
+* *
+* Under no circumstances and under no legal theory, whether tort *
+* (including negligence), contract, or otherwise, shall any *
+* Contributor, or anyone who distributes Covered Software as *
+* permitted above, be liable to You for any direct, indirect, *
+* special, incidental, or consequential damages of any character *
+* including, without limitation, damages for lost profits, loss of *
+* goodwill, work stoppage, computer failure or malfunction, or any *
+* and all other commercial damages or losses, even if such party *
+* shall have been informed of the possibility of such damages. This *
+* limitation of liability shall not apply to liability for death or *
+* personal injury resulting from such party's negligence to the *
+* extent applicable law prohibits such limitation. Some *
+* jurisdictions do not allow the exclusion or limitation of *
+* incidental or consequential damages, so this exclusion and *
+* limitation may not apply to You. *
+* *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+ This Source Code Form is subject to the terms of the Mozilla Public
+ License, v. 2.0. If a copy of the MPL was not distributed with this
+ file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+ This Source Code Form is "Incompatible With Secondary Licenses", as
+ defined by the Mozilla Public License, v. 2.0.
diff --git a/METADATA b/METADATA
new file mode 100644
index 0000000..8ff7d16
--- /dev/null
+++ b/METADATA
@@ -0,0 +1,20 @@
+name: "uefi-macros"
+description: "Procedural macros for the `uefi` crate."
+third_party {
+ identifier {
+ type: "crates.io"
+ value: "uefi-macros"
+ }
+ identifier {
+ type: "Archive"
+ value: "https://static.crates.io/crates/uefi-macros/uefi-macros-0.17.0.crate"
+ primary_source: true
+ }
+ version: "0.17.0"
+ license_type: RECIPROCAL
+ last_upgrade_date {
+ year: 2024
+ month: 11
+ day: 5
+ }
+}
diff --git a/MODULE_LICENSE_MPL b/MODULE_LICENSE_MPL
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/MODULE_LICENSE_MPL
diff --git a/OWNERS b/OWNERS
new file mode 100644
index 0000000..5a2b844
--- /dev/null
+++ b/OWNERS
@@ -0,0 +1 @@
+include platform/prebuilts/rust:main:/OWNERS
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5eff06b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,7 @@
+# uefi-macros
+
+[](https://crates.io/crates/uefi-macros)
+[](https://docs.rs/uefi-macros)
+
+This crate provides procedural macros used by [the `uefi-rs` project](https://github.com/rust-osdev/uefi-rs/)
+to simplify the development of UEFI applications and reduce boilerplate.
diff --git a/src/lib.rs b/src/lib.rs
new file mode 100644
index 0000000..ad46492
--- /dev/null
+++ b/src/lib.rs
@@ -0,0 +1,221 @@
+#![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, parse_quote_spanned, Error, Expr, ExprLit, ExprPath, ItemFn,
+ ItemStruct, Lit, 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()
+}
+
+/// 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 return [`Status`].
+/// * Must have zero parameters.
+/// * Can optionally be `unsafe`.
+///
+/// The global system table pointer and global image handle will be set
+/// automatically.
+///
+/// # Examples
+///
+/// ```no_run
+/// #![no_main]
+///
+/// use uefi::prelude::*;
+///
+/// #[entry]
+/// fn main() -> Status {
+/// Status::SUCCESS
+/// }
+/// ```
+///
+/// [`Status`]: https://docs.rs/uefi/latest/uefi/struct.Status.html
+#[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 function must have no ABI modifier"));
+ }
+ if let Some(asyncness) = f.sig.asyncness {
+ errors.append_all(err!(asyncness, "Entry function should not be async"));
+ }
+ if let Some(constness) = f.sig.constness {
+ errors.append_all(err!(constness, "Entry function should not be const"));
+ }
+ if !f.sig.generics.params.is_empty() {
+ errors.append_all(err!(
+ f.sig.generics.params,
+ "Entry function should not be generic"
+ ));
+ }
+ if !f.sig.inputs.is_empty() {
+ errors.append_all(err!(f.sig.inputs, "Entry function must have no arguments"));
+ }
+
+ // Show most errors all at once instead of one by one.
+ if !errors.is_empty() {
+ return errors.into();
+ }
+
+ let signature_span = f.sig.span();
+
+ // Fill in the image handle and system table arguments automatically.
+ let image_handle_ident = quote!(internal_image_handle);
+ let system_table_ident = quote!(internal_system_table);
+ f.sig.inputs = parse_quote_spanned!(
+ signature_span=>
+ #image_handle_ident: ::uefi::Handle,
+ #system_table_ident: *const ::core::ffi::c_void,
+ );
+
+ // Insert code at the beginning of the entry function to set the global
+ // image handle and system table pointer.
+ f.block.stmts.insert(
+ 0,
+ parse_quote! {
+ unsafe {
+ ::uefi::boot::set_image_handle(#image_handle_ident);
+ ::uefi::table::set_system_table(#system_table_ident.cast());
+ }
+ },
+ );
+
+ // Set the required ABI.
+ f.sig.abi = Some(parse_quote_spanned!(signature_span=> extern "efiapi"));
+
+ // Strip any visibility modifiers.
+ f.vis = Visibility::Inherited;
+
+ let unsafety = &f.sig.unsafety;
+ let fn_ident = &f.sig.ident;
+ let fn_output = &f.sig.output;
+
+ // Get the expected argument types for the main function.
+ let expected_args = quote!(::uefi::Handle, *const core::ffi::c_void);
+
+ 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(#expected_args) -> ::uefi::Status =
+ // Cast from a fn item to a function pointer.
+ #fn_ident as #unsafety extern "efiapi" fn(#expected_args) #fn_output;
+ };
+
+ let result = quote! {
+ #fn_type_check
+
+ #[export_name = "efi_main"]
+ #f
+
+ };
+ result.into()
+}
diff --git a/tests/compilation.rs b/tests/compilation.rs
new file mode 100644
index 0000000..1d65132
--- /dev/null
+++ b/tests/compilation.rs
@@ -0,0 +1,6 @@
+#[test]
+fn ui() {
+ let t = trybuild::TestCases::new();
+ t.compile_fail("tests/ui/fail/*.rs");
+ t.pass("tests/ui/pass/*.rs");
+}
diff --git a/tests/ui/fail/entry_bad_abi.rs b/tests/ui/fail/entry_bad_abi.rs
new file mode 100644
index 0000000..716f2da
--- /dev/null
+++ b/tests/ui/fail/entry_bad_abi.rs
@@ -0,0 +1,8 @@
+#![no_main]
+
+use uefi::prelude::*;
+
+#[entry]
+extern "C" fn main() -> Status {
+ Status::SUCCESS
+}
diff --git a/tests/ui/fail/entry_bad_abi.stderr b/tests/ui/fail/entry_bad_abi.stderr
new file mode 100644
index 0000000..d8157b4
--- /dev/null
+++ b/tests/ui/fail/entry_bad_abi.stderr
@@ -0,0 +1,5 @@
+error: Entry function must have no ABI modifier
+ --> tests/ui/fail/entry_bad_abi.rs:6:1
+ |
+6 | extern "C" fn main() -> Status {
+ | ^^^^^^
diff --git a/tests/ui/fail/entry_bad_arg.rs b/tests/ui/fail/entry_bad_arg.rs
new file mode 100644
index 0000000..857a2dc
--- /dev/null
+++ b/tests/ui/fail/entry_bad_arg.rs
@@ -0,0 +1,8 @@
+#![no_main]
+
+use uefi::prelude::*;
+
+#[entry]
+fn main(_x: usize) -> Status {
+ Status::SUCCESS
+}
diff --git a/tests/ui/fail/entry_bad_arg.stderr b/tests/ui/fail/entry_bad_arg.stderr
new file mode 100644
index 0000000..6baa144
--- /dev/null
+++ b/tests/ui/fail/entry_bad_arg.stderr
@@ -0,0 +1,5 @@
+error: Entry function must have no arguments
+ --> tests/ui/fail/entry_bad_arg.rs:6:9
+ |
+6 | fn main(_x: usize) -> Status {
+ | ^^
diff --git a/tests/ui/fail/entry_bad_async.rs b/tests/ui/fail/entry_bad_async.rs
new file mode 100644
index 0000000..d0bd922
--- /dev/null
+++ b/tests/ui/fail/entry_bad_async.rs
@@ -0,0 +1,8 @@
+#![no_main]
+
+use uefi::prelude::*;
+
+#[entry]
+async fn main() -> Status {
+ Status::SUCCESS
+}
diff --git a/tests/ui/fail/entry_bad_async.stderr b/tests/ui/fail/entry_bad_async.stderr
new file mode 100644
index 0000000..607f5c5
--- /dev/null
+++ b/tests/ui/fail/entry_bad_async.stderr
@@ -0,0 +1,5 @@
+error: Entry function should not be async
+ --> tests/ui/fail/entry_bad_async.rs:6:1
+ |
+6 | async fn main() -> Status {
+ | ^^^^^
diff --git a/tests/ui/fail/entry_bad_attr_arg.rs b/tests/ui/fail/entry_bad_attr_arg.rs
new file mode 100644
index 0000000..9c741ce
--- /dev/null
+++ b/tests/ui/fail/entry_bad_attr_arg.rs
@@ -0,0 +1,8 @@
+#![no_main]
+
+use uefi::prelude::*;
+
+#[entry(some_arg)]
+fn main() -> Status {
+ Status::SUCCESS
+}
diff --git a/tests/ui/fail/entry_bad_attr_arg.stderr b/tests/ui/fail/entry_bad_attr_arg.stderr
new file mode 100644
index 0000000..0c396c3
--- /dev/null
+++ b/tests/ui/fail/entry_bad_attr_arg.stderr
@@ -0,0 +1,5 @@
+error: Entry attribute accepts no arguments
+ --> tests/ui/fail/entry_bad_attr_arg.rs:5:9
+ |
+5 | #[entry(some_arg)]
+ | ^^^^^^^^
diff --git a/tests/ui/fail/entry_bad_const.rs b/tests/ui/fail/entry_bad_const.rs
new file mode 100644
index 0000000..5270c15
--- /dev/null
+++ b/tests/ui/fail/entry_bad_const.rs
@@ -0,0 +1,8 @@
+#![no_main]
+
+use uefi::prelude::*;
+
+#[entry]
+const fn main() -> Status {
+ Status::SUCCESS
+}
diff --git a/tests/ui/fail/entry_bad_const.stderr b/tests/ui/fail/entry_bad_const.stderr
new file mode 100644
index 0000000..677d3df
--- /dev/null
+++ b/tests/ui/fail/entry_bad_const.stderr
@@ -0,0 +1,5 @@
+error: Entry function should not be const
+ --> tests/ui/fail/entry_bad_const.rs:6:1
+ |
+6 | const fn main() -> Status {
+ | ^^^^^
diff --git a/tests/ui/fail/entry_bad_generic.rs b/tests/ui/fail/entry_bad_generic.rs
new file mode 100644
index 0000000..c07e209
--- /dev/null
+++ b/tests/ui/fail/entry_bad_generic.rs
@@ -0,0 +1,8 @@
+#![no_main]
+
+use uefi::prelude::*;
+
+#[entry]
+fn main<T>() -> Status {
+ Status::SUCCESS
+}
diff --git a/tests/ui/fail/entry_bad_generic.stderr b/tests/ui/fail/entry_bad_generic.stderr
new file mode 100644
index 0000000..3ec395a
--- /dev/null
+++ b/tests/ui/fail/entry_bad_generic.stderr
@@ -0,0 +1,5 @@
+error: Entry function should not be generic
+ --> tests/ui/fail/entry_bad_generic.rs:6:9
+ |
+6 | fn main<T>() -> Status {
+ | ^
diff --git a/tests/ui/fail/entry_bad_return_type.rs b/tests/ui/fail/entry_bad_return_type.rs
new file mode 100644
index 0000000..e9ca4c8
--- /dev/null
+++ b/tests/ui/fail/entry_bad_return_type.rs
@@ -0,0 +1,8 @@
+#![no_main]
+
+use uefi::prelude::*;
+
+#[entry]
+fn main() -> bool {
+ false
+}
diff --git a/tests/ui/fail/entry_bad_return_type.stderr b/tests/ui/fail/entry_bad_return_type.stderr
new file mode 100644
index 0000000..6249242
--- /dev/null
+++ b/tests/ui/fail/entry_bad_return_type.stderr
@@ -0,0 +1,8 @@
+error[E0308]: mismatched types
+ --> tests/ui/fail/entry_bad_return_type.rs:6:1
+ |
+6 | fn main() -> bool {
+ | ^^^^^^^^^^^^^^^^^ expected `Status`, found `bool`
+ |
+ = note: expected fn pointer `extern "efiapi" fn(Handle, *const c_void) -> Status`
+ found fn pointer `extern "efiapi" fn(Handle, *const c_void) -> bool`
diff --git a/tests/ui/pass/entry.rs b/tests/ui/pass/entry.rs
new file mode 100644
index 0000000..e2271d5
--- /dev/null
+++ b/tests/ui/pass/entry.rs
@@ -0,0 +1,9 @@
+use uefi::{entry, Status};
+
+#[entry]
+fn efi_main() -> Status {
+ Status::SUCCESS
+}
+
+// trybuild requires a `main` function.
+fn main() {}
diff --git a/tests/ui/pass/entry_docstring.rs b/tests/ui/pass/entry_docstring.rs
new file mode 100644
index 0000000..0b6c33e
--- /dev/null
+++ b/tests/ui/pass/entry_docstring.rs
@@ -0,0 +1,10 @@
+use uefi::{entry, Status};
+
+/// Docstring.
+#[entry]
+fn efi_main() -> Status {
+ Status::SUCCESS
+}
+
+// trybuild requires a `main` function.
+fn main() {}
diff --git a/tests/ui/pass/entry_unsafe.rs b/tests/ui/pass/entry_unsafe.rs
new file mode 100644
index 0000000..93bfed9
--- /dev/null
+++ b/tests/ui/pass/entry_unsafe.rs
@@ -0,0 +1,9 @@
+use uefi::{entry, Status};
+
+#[entry]
+unsafe fn efi_main() -> Status {
+ Status::SUCCESS
+}
+
+// trybuild requires a `main` function.
+fn main() {}
