diff --git a/.github/workflows/fiat-constify.yml b/.github/workflows/fiat-constify.yml deleted file mode 100644 index c7f594bc..00000000 --- a/.github/workflows/fiat-constify.yml +++ /dev/null @@ -1,35 +0,0 @@ -name: fiat-constify - -on: - pull_request: - paths: - - ".github/workflows/fiat-constify.yml" - - "fiat-constify/**" - - "Cargo.*" - push: - branches: master - -permissions: - contents: read - -defaults: - run: - working-directory: fiat-constify - -env: - CARGO_INCREMENTAL: 0 - RUSTFLAGS: "-Dwarnings" - -# Cancels CI jobs when new commits are pushed to a PR branch -concurrency: - group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} - cancel-in-progress: true - -jobs: - test: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v5 - - uses: RustCrypto/actions/cargo-cache@master - - uses: dtolnay/rust-toolchain@stable - - run: cargo test diff --git a/Cargo.lock b/Cargo.lock index fcce7471..c95317cc 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -103,16 +103,6 @@ dependencies = [ "sha3", ] -[[package]] -name = "fiat-constify" -version = "0.1.0" -dependencies = [ - "prettyplease", - "proc-macro2", - "quote", - "syn", -] - [[package]] name = "hex" version = "0.4.3" @@ -186,16 +176,6 @@ checksum = "78ca9ab1a0babb1e7d5695e3530886289c18cf2f87ec19a575a0abdce112e3a3" name = "opaque-debug" version = "0.4.0-pre" -[[package]] -name = "prettyplease" -version = "0.2.32" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "664ec5419c51e34154eec046ebcba56312d5a2fc3b09a06da188e1ad21afadf6" -dependencies = [ - "proc-macro2", - "syn", -] - [[package]] name = "proc-macro2" version = "1.0.95" diff --git a/Cargo.toml b/Cargo.toml index cf2ec7f1..d20ba5cc 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -9,7 +9,6 @@ members = [ "cpufeatures", "dbl", "digest-io", - "fiat-constify", "hex-literal", "inout", "opaque-debug", diff --git a/fiat-constify/CHANGELOG.md b/fiat-constify/CHANGELOG.md deleted file mode 100644 index 1d013ff9..00000000 --- a/fiat-constify/CHANGELOG.md +++ /dev/null @@ -1,6 +0,0 @@ -# Changelog - -All notable changes to this project will be documented in this file. - -The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), -and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). diff --git a/fiat-constify/Cargo.toml b/fiat-constify/Cargo.toml deleted file mode 100644 index b6dbff37..00000000 --- a/fiat-constify/Cargo.toml +++ /dev/null @@ -1,24 +0,0 @@ -[package] -name = "fiat-constify" -version = "0.1.0" -description = """ -Postprocessor for fiat-crypto generated field implementations which rewrites -them as `const fn` -""" -authors = ["RustCrypto Developers"] -license = "MIT OR Apache-2.0" -documentation = "https://docs.rs/fiat-constify" -homepage = "https://github.com/RustCrypto/utils/tree/master/fiat-constify" -repository = "https://github.com/RustCrypto/utils" -categories = ["cryptography"] -keywords = ["fiat-crypto", "field"] -readme = "README.md" -edition = "2024" -rust-version = "1.85" -publish = false - -[dependencies] -prettyplease = "0.2.19" -proc-macro2 = "1" -quote = "1" -syn = { version = "2", features = ["extra-traits", "full"] } diff --git a/fiat-constify/LICENSE-APACHE b/fiat-constify/LICENSE-APACHE deleted file mode 100644 index 78173fa2..00000000 --- a/fiat-constify/LICENSE-APACHE +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - -TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - -1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - -2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - -3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - -4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - -5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - -6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - -7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - -8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - -9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - -END OF TERMS AND CONDITIONS - -APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - -Copyright [yyyy] [name of copyright owner] - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. diff --git a/fiat-constify/LICENSE-MIT b/fiat-constify/LICENSE-MIT deleted file mode 100644 index 3d7cd6a7..00000000 --- a/fiat-constify/LICENSE-MIT +++ /dev/null @@ -1,25 +0,0 @@ -Copyright (c) 2022-2025 The RustCrypto Project Developers - -Permission is hereby granted, free of charge, to any -person obtaining a copy of this software and associated -documentation files (the "Software"), to deal in the -Software without restriction, including without -limitation the rights to use, copy, modify, merge, -publish, distribute, sublicense, and/or sell copies of -the Software, and to permit persons to whom the Software -is furnished to do so, subject to the following -conditions: - -The above copyright notice and this permission notice -shall be included in all copies or substantial portions -of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF -ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED -TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A -PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT -SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR -IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER -DEALINGS IN THE SOFTWARE. diff --git a/fiat-constify/README.md b/fiat-constify/README.md deleted file mode 100644 index ac983c65..00000000 --- a/fiat-constify/README.md +++ /dev/null @@ -1,57 +0,0 @@ -# [RustCrypto]: `const fn` postprocessor for `fiat-crypto` - -[![crate][crate-image]][crate-link] -[![Docs][docs-image]][docs-link] -[![Build Status][build-image]][build-link] -[![Safety Dance][safety-image]][safety-link] -![Apache2/MIT licensed][license-image] -[![Project Chat][chat-image]][chat-link] - -Postprocessor for [fiat-crypto] generated field implementations which rewrites -them as `const fn`. - -[Documentation][docs-link] - -## About - -This crate is a workaround for [mit-plv/fiat-crypto#1086] which provides a -mechanical postprocessing step for [fiat-crypto] generated field -implementations. - -It removes `&mut` references which aren't yet stable with `const fn`, instead -allocating and returning an array on the stack for results. - -## License - -Licensed under either of: - -- [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0) -- [MIT license](http://opensource.org/licenses/MIT) - -at your option. - -### Contribution - -Unless you explicitly state otherwise, any contribution intentionally submitted -for inclusion in the work by you, as defined in the Apache-2.0 license, shall be -dual licensed as above, without any additional terms or conditions. - -[//]: # (badges) - -[crate-image]: https://img.shields.io/crates/v/fiat-constify -[crate-link]: https://crates.io/crates/fiat-constify -[docs-image]: https://docs.rs/fiat-constify/badge.svg -[docs-link]: https://docs.rs/fiat-constify/ -[safety-image]: https://img.shields.io/badge/unsafe-forbidden-success.svg -[safety-link]: https://github.com/rust-secure-code/safety-dance/ -[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg -[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg -[chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/260052-utils -[build-image]: https://github.com/RustCrypto/utils/actions/workflows/fiat-constify.yml/badge.svg?branch=master -[build-link]: https://github.com/RustCrypto/utils/actions/workflows/fiat-constify.yml?query=branch:master - -[//]: # (links) - -[RustCrypto]: https://github.com/rustcrypto -[fiat-crypto]: https://github.com/mit-plv/fiat-crypto/ -[mit-plv/fiat-crypto#1086]: https://github.com/mit-plv/fiat-crypto/issues/1086 diff --git a/fiat-constify/src/main.rs b/fiat-constify/src/main.rs deleted file mode 100644 index cf44706d..00000000 --- a/fiat-constify/src/main.rs +++ /dev/null @@ -1,132 +0,0 @@ -//! Postprocessor for fiat-crypto generated field implementations which rewrites -//! them as `const fn`. -//! -//! Usage: fiat-constify /path/to/field_impl.rs - -#![allow(clippy::single_match, clippy::new_without_default)] - -mod type_registry; - -use proc_macro2::{Punct, Spacing, Span}; -use quote::TokenStreamExt; -use std::{env, fs, ops::Deref}; -use syn::{FnArg, Ident, Item, ItemFn, Meta, Pat, Stmt, TypeReference, parse_quote, token::Const}; -use type_registry::TypeRegistry; - -fn main() -> Result<(), Box> { - let args = env::args().collect::>(); - - if args.len() != 2 { - panic!("Usage: fiat-constify /path/to/field_impl.rs") - } - - let code = fs::read_to_string(&args[1])?; - let mut ast = syn::parse_file(&code)?; - ast.attrs.push(parse_quote! { - #![allow( - clippy::identity_op, - clippy::too_many_arguments, - clippy::unnecessary_cast, - dead_code - )] - }); - - let mut type_registry = TypeRegistry::new(); - - // Iterate over functions, transforming them into `const fn` - for item in &mut ast.items { - match item { - Item::Fn(func) => rewrite_fn_as_const(func, &type_registry), - Item::Type(ty) => type_registry.add_type_alias(ty), - Item::Struct(ty) => { - if let Some(derive) = ty - .attrs - .iter_mut() - .find(|x| x.meta.path().is_ident("derive")) - { - ["Debug", "PartialEq", "Eq", "PartialOrd", "Ord"] - .iter() - .for_each(|x| { - if let Meta::List(derive_list) = &mut derive.meta { - derive_list.tokens.append(Punct::new(',', Spacing::Alone)); - derive_list - .tokens - .append(proc_macro2::Ident::new(x, Span::call_site())); - } - }); - } - - type_registry.add_newtype(ty) - } - _ => (), - } - } - - println!( - "//! fiat-crypto output postprocessed by fiat-constify: " - ); - println!("{}", prettyplease::unparse(&ast)); - Ok(()) -} - -/// Get an `Ident` from a `Pat::Ident`. -fn get_ident_from_pat(pat: &Pat) -> Ident { - match pat { - Pat::Ident(pat_ident) => pat_ident.ident.clone(), - other => panic!("unexpected `Pat`: {other:?} (expecting `Pat::Ident`)"), - } -} - -/// Rewrite a fiat-crypto generated `fn` as a `const fn`, making the necessary -/// transformations to the code in order for it to work in that context. -fn rewrite_fn_as_const(func: &mut ItemFn, type_registry: &TypeRegistry) { - // Mark function as being `const fn`. - func.sig.constness = Some(Const::default()); - - // Transform mutable arguments into return values. - let mut stmts = Vec::::new(); - - for arg in &func.sig.inputs { - // Transform mutable function arguments into return values - if let FnArg::Typed(t) = arg { - match &*t.ty { - syn::Type::Reference(TypeReference { - mutability: Some(_), // look for mutable references - elem, - .. - }) => { - if matches!(elem.deref(), syn::Type::Path(_)) { - // Generation of reborrows, LLVM should optimize this out, and it definitely - // will if `#[repr(transparent)]` is used. - let ty = type_registry::type_to_ident(elem).unwrap(); - let ident = get_ident_from_pat(&t.pat); - if type_registry.is_newtype(ty) { - stmts.push(parse_quote! { - let #ident = &mut #ident.0; - }); - } - } - } - syn::Type::Reference(TypeReference { - mutability: None, - elem, - .. - }) if matches!(elem.deref(), syn::Type::Path(_)) => { - // Generation of reborrows, LLVM should optimize this out, and it definitely - // will if `#[repr(transparent)]` is used. - let ty = type_registry::type_to_ident(elem).unwrap(); - let ident = get_ident_from_pat(&t.pat); - if type_registry.is_newtype(ty) { - stmts.push(parse_quote! { - let #ident = &#ident.0; - }); - } - } - _ => (), - } - } - } - - stmts.extend(func.block.stmts.clone()); - func.block.stmts = stmts; -} diff --git a/fiat-constify/src/type_registry.rs b/fiat-constify/src/type_registry.rs deleted file mode 100644 index a57e1956..00000000 --- a/fiat-constify/src/type_registry.rs +++ /dev/null @@ -1,63 +0,0 @@ -//! Keeps track of which type is aliasing an existing type and which are new types. -//! This is useful because we only need to generate the return type prefixes for new types -//! -use std::collections::BTreeMap as Map; -use syn::{Ident, ItemStruct, ItemType, Path}; -#[derive(Debug, Clone, Copy, PartialEq, Eq)] -pub enum Type { - Alias, - NewType, -} - -/// Registry of types defined by the module being processed. -pub struct TypeRegistry(Map); - -impl TypeRegistry { - /// Create a new type registry. - pub const fn new() -> Self { - Self(Map::new()) - } - - /// Add a type which is a new type to the type registry. - pub fn add_newtype(&mut self, item_struct: &ItemStruct) { - if self - .0 - .insert(item_struct.ident.clone(), Type::NewType) - .is_some() - { - panic!("duplicate type name: {}", &item_struct.ident); - } - } - - /// Add a type which is a type alias - pub fn add_type_alias(&mut self, item_type: &ItemType) { - if self - .0 - .insert(item_type.ident.clone(), Type::Alias) - .is_some() - { - panic!("duplicate type name: {}", &item_type.ident); - } - } - - /// Get the [`Type`] which the identifier is. - /// - /// Returns `None` when ident can't be found. - pub fn get(&self, ident: &Ident) -> Option { - self.0.get(ident).copied() - } - - #[inline] - pub fn is_newtype(&self, ident: &syn::Ident) -> bool { - matches!(self.get(ident), Some(Type::NewType)) - } -} - -#[inline] -pub fn type_to_ident(ty: &syn::Type) -> Option<&Ident> { - if let syn::Type::Path(path) = ty { - return Path::get_ident(&path.path); - } - - None -}