Remove mirai_annotations dependency

justsmth · justsmth · commit 07495564727e · 2024-11-20T19:20:27.000-05:00
diff --git a/.github/workflows/analysis.yml b/.github/workflows/analysis.yml
@@ -205,40 +205,6 @@ jobs:
             exit 0
           }
 
-  mirai-analysis:
-    if: github.repository_owner == 'aws'
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          submodules: 'recursive'
-          lfs: true
-
-      - uses: dtolnay/rust-toolchain@master
-        id: toolchain
-        with:
-          toolchain: ${{ env.MIRAI_TOOLCHAIN }}
-          components: rust-src, rustc-dev, llvm-tools-preview
-      - name: Set Rust toolchain override
-        run: rustup override set ${{ steps.toolchain.outputs.name }}
-
-      # https://github.com/facebookexperimental/MIRAI/blob/main/documentation/InstallationGuide.md#installing-mirai-into-cargo
-      - name: Install MIRAI
-        run: |
-          MIRAI_TMP_SRC=$(mktemp -d)
-          git clone --depth 1 --branch ${{ env.MIRAI_TAG }} https://github.com/facebookexperimental/MIRAI.git ${MIRAI_TMP_SRC}
-          pushd ${MIRAI_TMP_SRC}
-          cargo install --locked --force --path ./checker --no-default-features
-          popd
-          rm -rf ${MIRAI_TMP_SRC}
-
-      - name: Run MIRAI
-        working-directory: ./aws-lc-rs
-        run: |
-          cargo update
-          cargo update -p clap --precise 4.4.18
-          cargo mirai
-
   minimal-versions:
     if: github.repository_owner == 'aws'
     name: Resolve the dependencies to the minimum SemVer version
diff --git a/aws-lc-rs/Cargo.toml b/aws-lc-rs/Cargo.toml
@@ -50,7 +50,6 @@ untrusted = { version = "0.7.1", optional = true }
 aws-lc-sys = { version = "0.23.0", path = "../aws-lc-sys", optional = true }
 aws-lc-fips-sys = { version = "0.12.0", path = "../aws-lc-fips-sys", optional = true }
 zeroize = "1.7"
-mirai-annotations = "1.12.0"
 paste = "1.0.11"
 
 [dev-dependencies]
diff --git a/aws-lc-rs/src/bn.rs b/aws-lc-rs/src/bn.rs
@@ -4,7 +4,6 @@
 use crate::ptr::{ConstPointer, DetachableLcPtr, LcPtr};
 use aws_lc::{BN_bin2bn, BN_bn2bin, BN_new, BN_num_bits, BN_num_bytes, BN_set_u64, BIGNUM};
 use core::ptr::null_mut;
-use mirai_annotations::unrecoverable;
 
 impl TryFrom<&[u8]> for LcPtr<BIGNUM> {
     type Error = ();
@@ -56,9 +55,7 @@ impl ConstPointer<BIGNUM> {
             let bn_bytes = BN_num_bytes(**self);
             let mut byte_vec = Vec::with_capacity(bn_bytes as usize);
             let out_bytes = BN_bn2bin(**self, byte_vec.as_mut_ptr());
-            if out_bytes != (bn_bytes as usize) {
-                unrecoverable!("More bytes written than allocated.");
-            }
+            debug_assert_eq!(out_bytes, bn_bytes as usize);
             byte_vec.set_len(out_bytes);
             byte_vec
         }
diff --git a/aws-lc-rs/src/ptr.rs b/aws-lc-rs/src/ptr.rs
@@ -10,8 +10,6 @@ use aws_lc::{
     RSA,
 };
 
-use mirai_annotations::verify_unreachable;
-
 pub(crate) type LcPtr<T> = ManagedPointer<*mut T>;
 pub(crate) type DetachableLcPtr<T> = DetachablePointer<*mut T>;
 
@@ -100,7 +98,7 @@ impl<P: Pointer> Deref for DetachablePointer<P> {
             Some(pointer) => pointer,
             None => {
                 // Safety: pointer is only None when DetachableLcPtr is detached or dropped
-                verify_unreachable!()
+                unreachable!()
             }
         }
     }
@@ -131,7 +129,7 @@ impl<P: Pointer> From<DetachablePointer<P>> for ManagedPointer<P> {
             Some(pointer) => ManagedPointer { pointer },
             None => {
                 // Safety: pointer is only None when DetachableLcPtr is detached or dropped
-                verify_unreachable!()
+                unreachable!()
             }
         }
     }
diff --git a/aws-lc-rs/src/rsa/encryption/oaep.rs b/aws-lc-rs/src/rsa/encryption/oaep.rs
@@ -16,7 +16,6 @@ use aws_lc::{
     EVP_PKEY_CTX, RSA_PKCS1_OAEP_PADDING,
 };
 use core::{fmt::Debug, mem::size_of_val, ptr::null_mut};
-use mirai_annotations::verify_unreachable;
 
 /// RSA-OAEP with SHA1 Hash and SHA1 MGF1
 pub const OAEP_SHA1_MGF1SHA1: OaepAlgorithm = OaepAlgorithm {
@@ -163,7 +162,7 @@ impl OaepPublicEncryptingKey {
             EncryptionAlgorithmId::OaepSha256Mgf1sha256 => 32,
             EncryptionAlgorithmId::OaepSha384Mgf1sha384 => 48,
             EncryptionAlgorithmId::OaepSha512Mgf1sha512 => 64,
-            _ => verify_unreachable!(),
+            _ => unreachable!(),
         };
 
         // The RSA-OAEP algorithms we support use the hashing algorithm for the hash and mgf1 functions.
diff --git a/aws-lc-rs/src/rsa/key.rs b/aws-lc-rs/src/rsa/key.rs
@@ -40,7 +40,6 @@ use core::{
 // use core::ffi::c_int;
 use std::os::raw::c_int;
 
-use mirai_annotations::verify_unreachable;
 #[cfg(feature = "ring-io")]
 use untrusted::Input;
 use zeroize::Zeroize;
@@ -263,7 +262,7 @@ impl KeyPair {
                 // https://github.com/awslabs/aws-lc/blob/main/include/openssl/rsa.h#L99
                 unsafe { RSA_size(*rsa.as_const()) as usize }
             }
-            Err(_) => verify_unreachable!(),
+            Err(_) => unreachable!(),
         }
     }
 }
diff --git a/aws-lc-rs/src/test.rs b/aws-lc-rs/src/test.rs
@@ -112,7 +112,6 @@
 
 extern crate alloc;
 
-use mirai_annotations::unrecoverable;
 use std::error::Error;
 
 use crate::{digest, error};
@@ -183,7 +182,7 @@ impl TestCase {
             "SHA3_256" => Some(&digest::SHA3_256),
             "SHA3_384" => Some(&digest::SHA3_384),
             "SHA3_512" => Some(&digest::SHA3_512),
-            _ => unrecoverable!("Unsupported digest algorithm: {}", name),
+            _ => unreachable!("Unsupported digest algorithm: {}", name),
         }
     }
 
@@ -213,20 +212,18 @@ impl TestCase {
                             Some(b't') => b'\t',
                             Some(b'n') => b'\n',
                             _ => {
-                                unrecoverable!("Invalid hex escape sequence in string.");
+                                panic!("Invalid hex escape sequence in string.");
                             }
                         }
                     }
                     Some(b'"') => {
                         if s.next().is_some() {
-                            unrecoverable!(
-                                "characters after the closing quote of a quoted string."
-                            );
+                            panic!("characters after the closing quote of a quoted string.");
                         }
                         break;
                     }
                     Some(b) => *b,
-                    None => unrecoverable!("Missing terminating '\"' in string literal."),
+                    None => panic!("Missing terminating '\"' in string literal."),
                 };
                 bytes.push(b);
             }
@@ -236,7 +233,7 @@ impl TestCase {
             match from_hex(&s) {
                 Ok(s) => s,
                 Err(err_str) => {
-                    unrecoverable!("{} in {}", err_str, s);
+                    panic!("{} in {}", err_str, s);
                 }
             }
         };
diff --git a/aws-lc-rs/tests/aead_test.rs b/aws-lc-rs/tests/aead_test.rs
@@ -7,7 +7,6 @@ use aws_lc_rs::{aead, error, test, test_file};
 
 use aws_lc_rs::aead::{Nonce, NONCE_LEN};
 use core::ops::RangeFrom;
-use mirai_annotations::unrecoverable;
 
 #[test]
 fn aead_aes_gcm_128() {
@@ -230,7 +229,7 @@ fn test_aead<Seal, Open>(
                     assert_eq!(Err(error::Unspecified), o_result);
                 }
                 Some(error) => {
-                    unrecoverable!("Unexpected error test case: {}", error);
+                    panic!("Unexpected error test case: {}", error);
                 }
             };
         }
diff --git a/aws-lc-rs/tests/ecdsa_tests.rs b/aws-lc-rs/tests/ecdsa_tests.rs
@@ -10,7 +10,6 @@ use aws_lc_rs::{
     signature::{self, EcdsaKeyPair, KeyPair, Signature, UnparsedPublicKey},
     test, test_file,
 };
-use mirai_annotations::unrecoverable;
 
 #[test]
 fn ecdsa_traits() {
@@ -93,9 +92,9 @@ fn ecdsa_from_pkcs8_test() {
             match (EcdsaKeyPair::from_pkcs8(this_asn1, &input), error) {
                 (Ok(_), None) => (),
                 (Err(e), None) => {
-                    unrecoverable!("Failed with error \"{}\", but expected to succeed", e);
+                    panic!("Failed with error \"{}\", but expected to succeed", e);
                 }
-                (Ok(_), Some(e)) => unrecoverable!("Succeeded, but expected error \"{}\"", e),
+                (Ok(_), Some(e)) => panic!("Succeeded, but expected error \"{}\"", e),
                 (Err(actual), Some(expected)) => assert_eq!(format!("{actual}"), expected),
             };
 
@@ -230,7 +229,7 @@ fn test_signature_ecdsa_verify_fixed(data_file: test::File) {
             ("secp256k1", "SHA256") => &signature::ECDSA_P256K1_SHA256_FIXED,
             ("secp256k1", "SHA3-256") => &signature::ECDSA_P256K1_SHA3_256_FIXED,
             _ => {
-                unrecoverable!("Unsupported curve+digest: {}+{}", curve_name, digest_name);
+                panic!("Unsupported curve+digest: {}+{}", curve_name, digest_name);
             }
         };
 

Original file line number	Diff line number	Diff line change
`@@ -10,8 +10,6 @@ use aws_lc::{`
`10`	`10`	`RSA,`
`11`	`11`	`};`
`12`	`12`
`13`		`-use mirai_annotations::verify_unreachable;`
`14`		`-`
`15`	`13`	`pub(crate) type LcPtr<T> = ManagedPointer<*mut T>;`
`16`	`14`	`pub(crate) type DetachableLcPtr<T> = DetachablePointer<*mut T>;`
`17`	`15`
`@@ -100,7 +98,7 @@ impl<P: Pointer> Deref for DetachablePointer<P> {`
`100`	`98`	`Some(pointer) => pointer,`
`101`	`99`	`None => {`
`102`	`100`	`// Safety: pointer is only None when DetachableLcPtr is detached or dropped`
`103`		`- verify_unreachable!()`
	`101`	`+ unreachable!()`
`104`	`102`	`}`
`105`	`103`	`}`
`106`	`104`	`}`
`@@ -131,7 +129,7 @@ impl<P: Pointer> From<DetachablePointer<P>> for ManagedPointer<P> {`
`131`	`129`	`Some(pointer) => ManagedPointer { pointer },`
`132`	`130`	`None => {`
`133`	`131`	`// Safety: pointer is only None when DetachableLcPtr is detached or dropped`
`134`		`- verify_unreachable!()`
	`132`	`+ unreachable!()`
`135`	`133`	`}`
`136`	`134`	`}`
`137`	`135`	`}`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,6 @@ use core::{`
`40`	`40`	`// use core::ffi::c_int;`
`41`	`41`	`use std::os::raw::c_int;`
`42`	`42`
`43`		`-use mirai_annotations::verify_unreachable;`
`44`	`43`	`#[cfg(feature = "ring-io")]`
`45`	`44`	`use untrusted::Input;`
`46`	`45`	`use zeroize::Zeroize;`
`@@ -263,7 +262,7 @@ impl KeyPair {`
`263`	`262`	`// https://github.com/awslabs/aws-lc/blob/main/include/openssl/rsa.h#L99`
`264`	`263`	`unsafe { RSA_size(*rsa.as_const()) as usize }`
`265`	`264`	`}`
`266`		`- Err(_) => verify_unreachable!(),`
	`265`	`+ Err(_) => unreachable!(),`
`267`	`266`	`}`
`268`	`267`	`}`
`269`	`268`	`}`
Original file line number	Diff line number	Diff line change
`@@ -112,7 +112,6 @@`
`112`	`112`
`113`	`113`	`extern crate alloc;`
`114`	`114`
`115`		`-use mirai_annotations::unrecoverable;`
`116`	`115`	`use std::error::Error;`
`117`	`116`
`118`	`117`	`use crate::{digest, error};`
`@@ -183,7 +182,7 @@ impl TestCase {`
`183`	`182`	`"SHA3_256" => Some(&digest::SHA3_256),`
`184`	`183`	`"SHA3_384" => Some(&digest::SHA3_384),`
`185`	`184`	`"SHA3_512" => Some(&digest::SHA3_512),`
`186`		`- _ => unrecoverable!("Unsupported digest algorithm: {}", name),`
	`185`	`+ _ => unreachable!("Unsupported digest algorithm: {}", name),`
`187`	`186`	`}`
`188`	`187`	`}`
`189`	`188`
`@@ -213,20 +212,18 @@ impl TestCase {`
`213`	`212`	`Some(b't') => b'\t',`
`214`	`213`	`Some(b'n') => b'\n',`
`215`	`214`	`_ => {`
`216`		`- unrecoverable!("Invalid hex escape sequence in string.");`
	`215`	`+ panic!("Invalid hex escape sequence in string.");`
`217`	`216`	`}`
`218`	`217`	`}`
`219`	`218`	`}`
`220`	`219`	`Some(b'"') => {`
`221`	`220`	`if s.next().is_some() {`
`222`		`- unrecoverable!(`
`223`		`- "characters after the closing quote of a quoted string."`
`224`		`- );`
	`221`	`+ panic!("characters after the closing quote of a quoted string.");`
`225`	`222`	`}`
`226`	`223`	`break;`
`227`	`224`	`}`
`228`	`225`	`Some(b) => *b,`
`229`		`- None => unrecoverable!("Missing terminating '\"' in string literal."),`
	`226`	`+ None => panic!("Missing terminating '\"' in string literal."),`
`230`	`227`	`};`
`231`	`228`	`bytes.push(b);`
`232`	`229`	`}`
`@@ -236,7 +233,7 @@ impl TestCase {`
`236`	`233`	`match from_hex(&s) {`
`237`	`234`	`Ok(s) => s,`
`238`	`235`	`Err(err_str) => {`
`239`		`- unrecoverable!("{} in {}", err_str, s);`
	`236`	`+ panic!("{} in {}", err_str, s);`
`240`	`237`	`}`
`241`	`238`	`}`
`242`	`239`	`};`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,6 @@ use aws_lc_rs::{aead, error, test, test_file};`
`7`	`7`
`8`	`8`	`use aws_lc_rs::aead::{Nonce, NONCE_LEN};`
`9`	`9`	`use core::ops::RangeFrom;`
`10`		`-use mirai_annotations::unrecoverable;`
`11`	`10`
`12`	`11`	`#[test]`
`13`	`12`	`fn aead_aes_gcm_128() {`
`@@ -230,7 +229,7 @@ fn test_aead<Seal, Open>(`
`230`	`229`	`assert_eq!(Err(error::Unspecified), o_result);`
`231`	`230`	`}`
`232`	`231`	`Some(error) => {`
`233`		`- unrecoverable!("Unexpected error test case: {}", error);`
	`232`	`+ panic!("Unexpected error test case: {}", error);`
`234`	`233`	`}`
`235`	`234`	`};`
`236`	`235`	`}`