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 #342 from GaloisInc/vr/fix-doc

Browse Source 
fix incorrect documentation
This commit is contained in:
Valentin Robert 2023-09-11 10:26:31 -07:00 committed by GitHub
commit e05a9db243
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
x86/src/Data/Macaw/X86.hs
View File

@ -179,8 +179,12 @@ disassembleInstruction curIPAddr contents =
Right r -> do
pure r
-- | Translate block, returning blocks read, ending
-- PC, and an optional error. and ending PC.
-- | Translate one instruction, returning:
-- * the parsed instruction,
-- * an updated block, either unfinished or finished,
-- * the size of the parsed instruction,
-- * the next PC,
-- * the rest of the instruction memory contents.
translateStep :: forall st_s ids
. NonceGenerator (ST st_s) ids
-- ^ Generator for new assign ids
@ -282,8 +286,9 @@ translateInstruction gen initRegs addr =
(_i, res, instSize, _nextIP, _nextContents) <- translateStep gen pblock 0 addr contents
pure $! (finishPartialBlock res, fromIntegral instSize)
-- | Translate block, returning block read, number of bytes in block,
-- remaining bytes to parse, and an optional error.
-- | Translate one block, returning:
-- * the read block,
-- * the offset of the next instruction after this block.
translateBlockImpl :: forall st_s ids
. NonceGenerator (ST st_s) ids
-- ^ Generator for new assign ids