Workspace
The Workspace class implements the angr management workspace, providing access to views, plugins, analysis, and job management.
Constructor
Workspace(main_window: MainWindow)
The main window instance that contains this workspace
Properties
The main Instance object containing the angr project and analysis data
Manager for background jobs and tasks
Manager for command execution and history
Manager for all workspace views
Manager for loaded plugins
Manager for running analyses (CFG, decompilation, etc.)
View Management
add_view
add_view(view: BaseView) -> None
The view to add to the workspace
remove_view
remove_view(view: BaseView) -> None
The view to remove from the workspace
raise_view
raise_view(view: BaseView) -> None
reload
reload(categories: list[str] | None = None) -> None
List of view categories to reload. If None, reloads all views.
refresh
refresh(categories: list[str] | None = None) -> None
List of view categories to refresh. If None, refreshes all views.
Navigation
jump_to
jump_to(addr: int, view=None, use_animation: bool = False) -> None
The view to use. If None or not a disassembly view, uses or creates a disassembly view.
Whether to use animation when jumping
viz
viz(obj: int | str | Function) -> None
obj
int | str | Function
required
- For integers: jump to that address
- For strings: look up the symbol and jump to it
- For Function objects: jump to the function address
Breakpoints
add_breakpoint
add_breakpoint(obj: str | int, type_: str | None = None, size: int | None = None) -> None
Address (int) or symbol name (str) for the breakpoint
Breakpoint type: “execute”, “write”, or “read”. Auto-detected based on symbol type if not provided.
Size of the breakpoint in bytes. Defaults to 1 or symbol size.
toggle_exec_breakpoint
toggle_exec_breakpoint() -> None
Analysis
run_analysis
Run analyses on the current project. Shows analysis options dialog if running with GUI.
decompile_current_function
decompile_current_function() -> None
decompile_function
decompile_function(func: Function, curr_ins=None, view=None) -> None
The function to decompile
The instruction address to focus on in the decompiled view
The code view to use. If None, creates or uses existing pseudocode view.
LLM Features
llm_refine_all
Run LLM refinement on the currently decompiled function (all aspects).
llm_suggest_variable_names
llm_suggest_variable_names() -> None
llm_suggest_function_name
llm_suggest_function_name() -> None
llm_suggest_variable_types
llm_suggest_variable_types() -> None
llm_summarize_function
llm_summarize_function() -> None
Patching
patch
patch(addr: int, asm: str, pad: bool = True) -> None
Assembly code to assemble and patch in
Whether to pad with NOPs to maintain instruction size
set_comment(addr: int, comment_text: str) -> None
Address to set comment at
Code Definition
define_code
define_code(addr: int) -> None
Address to define as code
undefine_code
undefine_code(addr: int) -> None
View Creation
new_disassembly_view
new_disassembly_view() -> DisassemblyView
The newly created disassembly view
show_linear_disassembly_view
show_linear_disassembly_view() -> None
show_graph_disassembly_view
show_graph_disassembly_view() -> None
show_pseudocode_view
show_pseudocode_view() -> None
show_hex_view
Show or create the hex editor view.
show_functions_view
show_functions_view() -> None
show_console_view
show_console_view() -> None
Debugging
step_forward
step_forward(until_addr: int | None = None) -> None
Step until reaching this address
continue_forward
continue_forward() -> None
create_simulation_manager
create_simulation_manager(state, state_name: str, view=None) -> None
The initial state for the simulation manager
The symbolic execution view to use
Logging
log
log(msg: str | BaseException) -> None
msg
str | BaseException
required
Message or exception to log
Traces
load_trace_from_path
load_trace_from_path(path: str) -> None
set_current_trace
set_current_trace(trace: Trace | None) -> None
The trace to set as current, or None to clear
remove_trace
remove_trace(trace: Trace) -> None