comments for deduce_param_attrs

Author: RalfJung

compiler/rustc_middle/src/middle/deduced_param_attrs.rs

@@ -3,7 +3,7 @@ use rustc_macros::{Decodable, Encodable, HashStable};
 use crate::ty::{Ty, TyCtxt, TypingEnv};
 
 /// Flags that dictate how a parameter is mutated. If the flags are empty, the param is
-/// read-only. If non-empty, it is read-only with conditions.
+/// read-only. If non-empty, it is read-only if *all* flags' conditions are met.
 #[derive(Clone, Copy, PartialEq, Debug, Decodable, Encodable, HashStable)]
 pub struct DeducedReadOnlyParam(u8);
 
@@ -53,6 +53,7 @@ impl DeducedParamAttrs {
         ty: Ty<'tcx>,
     ) -> bool {
         let read_only = self.read_only;
+        // We have to check *all* set bits; only if all checks pass is this truly read-only.
         if read_only.contains(DeducedReadOnlyParam::MUTATED) {
             return false;
         }

compiler/rustc_mir_transform/src/deduce_param_attrs.rs

@@ -4,6 +4,10 @@
 //! body of the function instead of just the signature. These can be useful for optimization
 //! purposes on a best-effort basis. We compute them here and store them into the crate metadata so
 //! dependent crates can use them.
+//!
+//! Note that this *crucially* relies on codegen *not* doing any more MIR-level transformations
+//! after `optimized_mir`! We check for things that are *not* guaranteed to be preserved by MIR
+//! transforms, such as which local variables happen to be mutated.
 
 use rustc_hir::def_id::LocalDefId;
 use rustc_index::IndexVec;