mirror of
https://github.com/revng/revng
synced 2026-06-21 14:07:57 +00:00
Alessandro Di Federico
140 lines
3.8 KiB
YAML
140 lines
3.8 KiB
YAML
#
|
|
# This file is distributed under the MIT License. See LICENSE.md for details.
|
|
#
|
|
|
|
version: 1
|
|
|
|
root_type: ControlFlowGraph
|
|
|
|
definitions:
|
|
- name: ControlFlowGraph
|
|
doc: |-
|
|
Metadata attached to a function. As of now, it includes a list of basic
|
|
blocks, representing the control-flow graph.
|
|
type: struct
|
|
key:
|
|
- Entry
|
|
|
|
fields:
|
|
- name: Entry
|
|
doc: Start address of the basic block
|
|
type: MetaAddress
|
|
- name: Name
|
|
type: string
|
|
doc: Optional name for debugging purposes
|
|
default: ""
|
|
- name: Blocks
|
|
sequence:
|
|
type: SortedVector
|
|
elementType: BasicBlock
|
|
|
|
- name: BasicBlock
|
|
doc: The basic block of a function
|
|
type: struct
|
|
|
|
key:
|
|
- ID
|
|
|
|
fields:
|
|
- name: ID
|
|
type: BasicBlockID
|
|
default: ":Invalid"
|
|
- name: End
|
|
doc: |
|
|
End address of the basic block, i.e., the address where the last
|
|
instruction ends
|
|
type: MetaAddress
|
|
default: ":Invalid"
|
|
- name: InlinedFrom
|
|
type: MetaAddress
|
|
doc: Address of the function this basic block has been inlined from
|
|
default: ":Invalid"
|
|
- name: Successors
|
|
doc: List of successor edges
|
|
sequence:
|
|
type: SortedVector
|
|
elementType: FunctionEdgeBase
|
|
|
|
- name: FunctionEdgeBase
|
|
doc: An edge on the CFG
|
|
type: struct
|
|
abstract: true
|
|
|
|
key:
|
|
- Destination
|
|
- Kind
|
|
|
|
fields:
|
|
- name: Destination
|
|
doc: |
|
|
Target of the CFG edge
|
|
|
|
If invalid, it's an indirect edge such as a return instruction or an
|
|
indirect function call.
|
|
If valid, it's either the address of the basic block in case of a direct
|
|
branch, or, in case of a function call, the address of the callee.
|
|
TODO: switch to TupleTreeReference
|
|
type: BasicBlockID
|
|
default: ":Invalid"
|
|
- name: Kind
|
|
type: FunctionEdgeBaseKind
|
|
- name: Type
|
|
doc: Type of the CFG edge
|
|
type: FunctionEdgeType
|
|
|
|
- name: FunctionEdge
|
|
doc: An edge on the CFG
|
|
type: struct
|
|
inherits: FunctionEdgeBase
|
|
|
|
fields: []
|
|
|
|
- name: CallEdge
|
|
doc: A CFG edge to represent function calls (direct, indirect and tail calls)
|
|
type: struct
|
|
inherits: FunctionEdgeBase
|
|
|
|
fields:
|
|
- name: DynamicFunction
|
|
doc: |
|
|
Name of the dynamic function being called, or empty if not a dynamic call
|
|
type: string
|
|
- name: IsTailCall
|
|
doc: Is this a tail call?
|
|
type: bool
|
|
default: false
|
|
- name: Attributes
|
|
doc: |
|
|
Attributes for this function
|
|
|
|
Note: To have the effective list of attributes for this call site, you
|
|
have to add attributes on the called function.
|
|
TODO: switch to std::set
|
|
sequence:
|
|
type: MutableSet
|
|
elementType: model::FunctionAttribute::Values
|
|
|
|
- name: FunctionEdgeType
|
|
doc: Type of edge on the CFG
|
|
type: enum
|
|
|
|
members:
|
|
- name: DirectBranch
|
|
doc: Branch due to function-local CFG (a regular branch)
|
|
- name: FunctionCall
|
|
doc: A function call for which the cache was able to produce a summary
|
|
- name: Return
|
|
doc: A proper function return
|
|
- name: BrokenReturn
|
|
doc: |
|
|
A branch returning to the return address, but leaving the stack in an
|
|
unexpected situation
|
|
- name: LongJmp
|
|
doc: A branch representing a longjmp or similar constructs
|
|
- name: Killer
|
|
doc: A killer basic block (killer syscall or endless loop)
|
|
- name: Unreachable
|
|
doc: The basic block ends with an unreachable instruction
|
|
- name: Unexpected
|
|
doc: The destination of this basic block is corrupted. This is a sign of a lifting error.
|