GaloisInc/macaw
1
1
Fork 0
mirror of https://github.com/GaloisInc/macaw.git synced 2024-11-22 14:27:51 +03:00
Code Issues Projects Releases Wiki Activity

Merge pull request #341 from GaloisInc/vr/block-invariants-docstrings

Browse Source 
fix BlockInvariants docstrings
This commit is contained in:
Valentin Robert 2023-09-08 08:42:00 -07:00 committed by GitHub
commit 4ad9984185
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
base/src/Data/Macaw/Analysis/RegisterUse.hs
View File

@ -1956,30 +1956,32 @@ instance Semigroup (LocList r tp) where
-- | This describes information about a block inferred by
-- register-use.
data BlockInvariants arch ids = BI
{ biUsedAssignSet :: !(Set (Some (AssignId ids)))
-- | Indices of write and cond-write statements that write to stack
-- and whose value is later needed to execute the program.
, biUsedWriteSet :: !(Set StmtIndex)
-- | In-order list of memory accesses in block.
, biMemAccessList :: ![(StmtIndex, MemAccessInfo arch ids)]
-- | Map from locations to the non-representative locations that are
-- equal to them.
, biLocMap :: !(MapF (BoundLoc (ArchReg arch)) (LocList (ArchReg arch)))
-- | Map predecessors for this block along with map from locations
-- to phi value
, biPredPostValues :: !(Map (ArchSegmentOff arch) (PostValueMap arch ids))
-- | Locations from previous block used to initial phi variables.
, biPhiLocs :: ![Some (BoundLoc (ArchReg arch))]
-- | Start constraints for block
, biStartConstraints :: !(BlockStartConstraints arch)
-- | If this block ends with a call, this has the type of the function called.
-- Otherwise, the value should be @Nothing@.
, biCallFunType :: !(Maybe (ArchFunType arch))
-- | Maps assignment identifiers to the associated value.
--
-- If an assignment id @aid@ is not in this map, then we assume it
-- is equal to @SAVEqualAssign aid@
, biAssignMap :: !(MapF (AssignId ids) (BlockInferValue arch ids))
-- | Subset of assignments that are actually needed to execute the block,
-- i.e. **not dead** assignments.
{ biUsedAssignSet :: !(Set (Some (AssignId ids)))
-- | Indices of write and cond-write statements that write to stack
-- and whose value is later needed to execute the program.
, biUsedWriteSet :: !(Set StmtIndex)
-- | In-order list of memory accesses in block.
, biMemAccessList :: ![(StmtIndex, MemAccessInfo arch ids)]
-- | Map from locations to the non-representative locations that are
-- equal to them.
, biLocMap :: !(MapF (BoundLoc (ArchReg arch)) (LocList (ArchReg arch)))
-- | Map predecessors for this block along with map from locations
-- to phi value
, biPredPostValues :: !(Map (ArchSegmentOff arch) (PostValueMap arch ids))
-- | Locations from previous block used to initial phi variables.
, biPhiLocs :: ![Some (BoundLoc (ArchReg arch))]
-- | Start constraints for block
, biStartConstraints :: !(BlockStartConstraints arch)
-- | If this block ends with a call, this has the type of the function called.
-- Otherwise, the value should be @Nothing@.
, biCallFunType :: !(Maybe (ArchFunType arch))
-- | Maps assignment identifiers to the associated value.
--
-- If an assignment id @aid@ is not in this map, then we assume it
-- is equal to @SAVEqualAssign aid@
, biAssignMap :: !(MapF (AssignId ids) (BlockInferValue arch ids))
}
-- | Return true if assignment is needed to execute block.