High-level disassembly API

[vchuravy]

cc: @gbaraldi

[github-actions]

Your PR requires formatting changes to meet the project's style guidelines.
Please consider running Runic (git runic master) to apply these changes.

Click here to view the suggested changes.

diff --git a/src/disasm.jl b/src/disasm.jl
index fc8f3e98..8cf26bfa 100644
--- a/src/disasm.jl
+++ b/src/disasm.jl
@@ -13,7 +13,7 @@ function dispose(ctx::DisasmContext)
     return nothing
 end
 
-function disassemble_code(io, ctx::DisasmContext, native_code::Vector{UInt8}, code_addr::Csize_t = 0; bufsize=32)
+function disassemble_code(io, ctx::DisasmContext, native_code::Vector{UInt8}, code_addr::Csize_t = 0; bufsize = 32)
     pos = 1
     buf = Vector{UInt8}(undef, bufsize)
 
@@ -37,4 +37,4 @@ function disassemble_code(io, ctx::DisasmContext, native_code::Vector{UInt8}, co
         write(io, '\n')
     end
     return nothing
-end
\ No newline at end of file
+end
diff --git a/test/disasm.jl b/test/disasm.jl
index 679358cc..8e30d500 100644
--- a/test/disasm.jl
+++ b/test/disasm.jl
@@ -10,4 +10,4 @@ import LLVM: create_disasm, disassemble_code
     LLVM.dispose(ctx)
 
     @test disassembled == "\tpushq\t%rbp\n\tmovq\t%rsp, %rbp\n\tmovq\t16(%r13), %rax\n\tmovq\t16(%rax), %rax\n\tmovq\t(%rax), %rax\n\tmovq\t(%rsi), %rdx\n\taddq\t\$8, %rsi\n\tmovabsq\t\$140619409620192, %rax\n\tcallq\t*%rax\n\tpopq\t%rbp\n"
-end
\ No newline at end of file
+end
diff --git a/test/runtests.jl b/test/runtests.jl
index 81ead7d5..6c2e7dd6 100644
--- a/test/runtests.jl
+++ b/test/runtests.jl
@@ -41,7 +41,7 @@ include("debuginfo.jl")
 include("util.jl")
 include("interop.jl")
 include("orc.jl")
-include("disasm.jl")
+    include("disasm.jl")
 if !Sys.iswindows()
     # XXX: hangs on Windows
     include("jljit.jl")

[codecov-commenter]

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

❌ Patch coverage is 96.15385% with 1 line in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
src/disasm.jl	96.15%	1 Missing ⚠️
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

@@            Coverage Diff             @@
##           master     #522      +/-   ##
==========================================
+ Coverage   87.91%   87.98%   +0.07%     
==========================================
  Files          45       46       +1     
  Lines        2705     2731      +26     
==========================================
+ Hits         2378     2403      +25     
- Misses        327      328       +1     

Files with missing lines	Coverage Δ
src/LLVM.jl	76.92% <ø> (ø)
src/disasm.jl	96.15% <96.15%> (ø)

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[gbaraldi]

Maybe a comment explaining the PC

[maleadt]

Maybe this is my OOP kicking in, but why not tie this to a DisasmContext constructor like we do for other objects-like things (Context, IRBuilder, etc)?

[maleadt]

What about simply disassemble? A do-block version could be provided that does the context construction for you.