ocgraph 0.3.0__py3-none-any.whl

ocgraph/interface/drawer.py

@@ -0,0 +1,181 @@
+# SPDX-License-Identifier: GTDGmbH
+"""Class for drawing the output."""
+
+from __future__ import annotations
+
+import tempfile
+from typing import TYPE_CHECKING, Any
+
+from graphviz import Digraph  # type: ignore
+
+from ocgraph.data import Coverage
+
+if TYPE_CHECKING:  # pragma: no cover
+    from ocgraph.configuration import OcGraphConfiguration
+    from ocgraph.data import BasicBlock
+
+coverage_color = {
+    Coverage.MISS: "#f08080",  # light coral
+    Coverage.LINE_TAKEN: "#90ee90",  # light green
+    Coverage.JUMP_BOTH: "#90ee90",  # light green
+    Coverage.JUMP_PASS: "#fdfd96",  # pastel yellow
+    Coverage.JUMP_TAKEN: "#fdfd96",  # pastel yellow
+}
+
+
+class Drawer:
+    """Drawer Class."""
+
+    def __init__(
+        self,
+        config: OcGraphConfiguration,
+        graph_options: dict[str, Any] | None = None,
+    ) -> None:
+        self.config = config
+        self.graph_option = graph_options if graph_options else {}
+
+    def set_graph_option(self, graph_options: dict[str, Any]) -> None:
+        """Set new graph options."""
+        self.graph_option = graph_options
+
+    @staticmethod
+    def _escape(text: str) -> str:
+        """
+        Escape used dot graph characters in given instruction so they will be
+        displayed correctly.
+        """
+        text = text.replace("&", "&")
+        text = text.replace("<", r"&lt;")
+        text = text.replace(">", r"&gt;")
+        return text.replace("\t", "&#9;")
+
+    def _create_label(
+        self,
+        basic_block: BasicBlock,
+        line_coverage: bool = False,
+    ) -> str:
+        """Create annotated graph label."""
+        label = ""
+        returns = set()
+
+        # start label
+        label += '< <TABLE BORDER="1" CELLBORDER="0" CELLSPACING="0" CELLPADDING="0"> \n'
+        # for each instruction in block
+        for instr in basic_block.instructions:
+            if not instr or not instr.address or not instr.opcode:
+                continue
+
+            bg_color = coverage_color[instr.coverage] if line_coverage else "white"
+            label += (
+                "<TR>"
+                f'<TD ALIGN="LEFT" COLSPAN="2" BGCOLOR="{bg_color}" >'
+                f"0x{instr.address.abs_addr:0>8x}:   {instr.opcode:<10} "
+                f"{Drawer._escape(text=', '.join(instr.ops))}"
+                "</TD></TR>\n"
+            )
+            if self.config.architecture.is_sink(instr):
+                for return_addr in instr.returns:
+                    if isinstance(return_addr, int):
+                        returns.add(f"0x{return_addr:x}")
+
+        # add JUMP/NO JUMP cells with dot PORT navigation
+        cells = [basic_block.jump_edge, basic_block.no_jump_edge]
+        span = 3 - len(
+            [x for x in cells if x is not None],
+        )  # 3 - count of trues in cells
+
+        label = self._label_edges(label, basic_block, span, returns)
+        label += " </TABLE> >"
+        return label
+
+    def _label_edges(
+        self,
+        label: str,
+        basic_block: BasicBlock,
+        span: int,
+        returns: set[str],
+    ) -> str:
+        label += "<TR>"
+        if basic_block.no_jump_edge:
+            label += f'<TD BORDER="1" COLSPAN="{span}" PORT="pass">NO JUMP</TD>'
+        if basic_block.jump_edge:
+            label += f'<TD BORDER="1" COLSPAN="{span}" PORT="jump">JUMP</TD>'
+        if not basic_block.jump_edge and not basic_block.no_jump_edge:
+            label += (
+                f'<TD BORDER="1" COLSPAN="2">RETURN targets: '
+                f'{str(returns) if returns else "--"}</TD>'
+            )
+        label += "</TR>"
+        return label
+
+    def _create_cfg(
+        self,
+        name: str,
+        basic_blocks: dict[int, BasicBlock],
+        coverage: bool = False,
+    ) -> Digraph:
+        """Create a control flow graph."""
+        dot = Digraph(name=name, comment=name, engine="dot")
+        dot.attr("graph", label=name)
+        dot.attr("graph", fontname="Mono")
+        dot.attr("node", fontname="Mono")
+        dot.attr("edge", fontname="Mono")
+
+        basic_block_keys = []
+
+        # Create nodes in graph
+        for address, basic_block in basic_blocks.items():
+            key = str(address)
+            label = self._create_label(basic_block, coverage)
+            dot.node(name=key, label=label, shape="plaintext", **self.graph_option)
+            basic_block_keys.append(key)
+
+        # Create edges in graph
+        for basic_block in basic_blocks.values():
+            if basic_block.jump_edge:
+                key = str(basic_block.jump_edge)
+                if key not in basic_block_keys:
+                    dot.node(
+                        name=key,
+                        label=hex(basic_block.jump_edge),
+                        shape="plaintext",
+                        **self.graph_option,
+                    )
+                    basic_block_keys.append(key)
+                dot.edge(f"{basic_block.key}:jump", str(basic_block.jump_edge))
+            if basic_block.no_jump_edge:
+                key = str(basic_block.no_jump_edge)
+                if key not in basic_block_keys:
+                    dot.node(
+                        name=key,
+                        label=hex(basic_block.no_jump_edge),
+                        shape="plaintext",
+                        **self.graph_option,
+                    )
+                    basic_block_keys.append(key)
+                dot.edge(f"{basic_block.key}:pass", str(basic_block.no_jump_edge))
+        return dot
+
+    def view_cfg(self, name: str, basic_blocks: dict[int, BasicBlock]) -> None:  # pragma: no cover
+        """View a function graph."""
+        dot = self._create_cfg(name, basic_blocks)
+        dot.format = "gv"
+        with tempfile.NamedTemporaryFile(mode="w+b", prefix=name) as filename:
+            dot.view(filename.name)
+
+    def draw_cfg(
+        self,
+        name: str,
+        basic_blocks: dict[int, BasicBlock],
+        output: str | None = None,
+    ) -> None:
+        """Draw a function graph."""
+        dot = self._create_cfg(name, basic_blocks, coverage=True)
+
+        filename = output if output else name
+        dot.format = "pdf"
+        dot.render(filename=filename, cleanup=True)
+        self.config.logger.info(f"Saved CFG to a file {filename}.{dot.format}")
+
+        dot.format = "gv"
+        dot.render(filename=filename, cleanup=True)

ocgraph-0.3.0.dist-info/LICENSES/GTDGmbH.md

@@ -0,0 +1,24 @@
+Valid-License-Identifier: GTDGmbH
+License-Text:
+
+Copyright (c) 2023 GTD GmbH. All rights reserved.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the “Software”), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ocgraph-0.3.0.dist-info/LICENSES/MauriMustonen.md

@@ -0,0 +1,24 @@
+Valid-License-Identifier: MauriMustonen
+License-Text:
+
+MIT License
+
+Copyright (c) 2021 Mauri Mustonen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ocgraph-0.3.0.dist-info/METADATA

@@ -0,0 +1,55 @@
+Metadata-Version: 2.3
+Name: ocgraph
+Version: 0.3.0
+Summary: Tool to visualize object code as control flow graph
+License: MIT
+Keywords: Object Code,Control Flow Graph,ECSS Category A,asm2cfg,Coverage
+Author: Mauri Mustonen
+Author-email: kazooiebombchu@gmail.com
+Maintainer: Christoph Weiss
+Maintainer-email: christoph.weiss@gtd-gmbh.de
+Requires-Python: >=3.9,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: graphviz (>=0.9,<0.10)
+Project-URL: Documentation, https://gtd-gmbh.gitlab.io/beta-software/ocgraph
+Project-URL: Forked from asm2cfg, https://github.com/Kazhuu/asm2cfg
+Project-URL: Homepage, https://gtd-gmbh.de/cat-a
+Project-URL: Repository, https://gitlab.com/gtd-gmbh/beta-software/ocgraph.git
+Description-Content-Type: text/markdown
+
+# Object Code Graph (ocgraph)
+
+This repo contains *ocgraph*, (**Object Code Graph**), a tool to
+read disassembler output and optionally corresponding coverage data to produce
+control flow graphs including coverage analysis on assembler level.
+
+The *ocgraph* source code implemented by GTD GmbH is forked from the asm2cfg
+repository on [Github](https://github.com/Kazhuu/asm2cfg) and reworked to
+function with several architectures and disassemblers.
+
+The tool source code is subject to the MIT License as indicated by the headers
+of the corresponding source code files.
+
+[!WARNING]
+> **WARNING**:
+>
+> **This tool is currently under development and in beta state It's not intended
+> to be complete and using it is on your own risk.**
+
+## Documentation
+
+Due to the lack of a full documentation, all previous information can be found
+in separate *Markdown* files in the *doc* folder:
+
+1. [Installation](doc/1_Installation.md): Instructions to install the tool
+2. [How to Run](doc/2_HowToRun.md): Guideline to run the tool
+3. [Development](doc/3_Development.md): Information for Developer
+4. [Github asm2cfg](doc/4_Github.md): Original GitHub documentation
+

ocgraph-0.3.0.dist-info/RECORD

@@ -0,0 +1,37 @@
+ocgraph/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ocgraph/__main__.py,sha256=q2MEakTZdeeCC8QGyTQnk-fkh3i5PKZ0WMrzFK1Mflk,2716
+ocgraph/configuration/__init__.py,sha256=caqDzvny40-Z3beWkcc4kHYI4qQo0zxTFVPQJidkdp4,173
+ocgraph/configuration/architecture/__init__.py,sha256=grK51xPwyzfd5JKa98bY875dEsr3eafYyeJj4rWEYJU,379
+ocgraph/configuration/architecture/architecture.py,sha256=wBhKwCJgYwjX6esu6tJz1Q6XpW20ZhcQ4ZA208Z0_hc,2351
+ocgraph/configuration/architecture/arm.py,sha256=Oa-hpKwRv9kc8I5xE5Tdp0DWEBItGJktG0_aRteMsuw,1711
+ocgraph/configuration/architecture/msp430.py,sha256=YEl4obWENoIzJyalfGjJTK1iGs4XIVMBey40hZo6i3g,1212
+ocgraph/configuration/architecture/ppc.py,sha256=_ofKiWaSAl6s_XXg4BPPWiutnC9Ru6e0n4BHxP6tsho,9919
+ocgraph/configuration/architecture/sparc.py,sha256=B8lqJYiWGuOtGS6vgzRZ4XdElSwSiRHauyJRgTL79dk,3198
+ocgraph/configuration/architecture/x86.py,sha256=8fFcQhtOAO05CzUPDFWo8jfncjBNXNF2mEvIAal4OZ8,1067
+ocgraph/configuration/configuration.py,sha256=YarXLhZibqTMuuiw7eT_naX08wXH90ykITx71mc_448,3477
+ocgraph/configuration/disassembler/__init__.py,sha256=Djdux3AJ6zTPRhfwy88CPXsrMUVJWpyYRosR3sLx0NM,618
+ocgraph/configuration/disassembler/disassembler.py,sha256=ApnKzgOI07V1-UD6BL2GmIGyXT5l6dLLq1O09d2Vghg,5367
+ocgraph/configuration/disassembler/gdb_default.py,sha256=c1nsGsT2f3l8LADvIkreBV7etC8RxHyfSNTwy9dPxO4,255
+ocgraph/configuration/disassembler/objdump_arm.py,sha256=z2WdDYcXeX3SKkT2BRk1o3IKwMOt0cnN4Z2O6fZG5uA,263
+ocgraph/configuration/disassembler/objdump_msp430.py,sha256=RwKc2bGdzGomzstOcqmwEZwIfYQm-RaCMbemUlFZoZc,818
+ocgraph/configuration/disassembler/objdump_ppc.py,sha256=JhOcYE2hFzUWWuf__Vqmr9k1U2ASn9QuJWNgcav4GoU,278
+ocgraph/configuration/disassembler/objdump_sparc.py,sha256=aipSMiDXwzWyyT11OWhYGfIBOWPqdI02pb_vTETuy00,290
+ocgraph/configuration/disassembler/objdump_x86.py,sha256=Mm_Of7gr9BPMjdSLJMnrREqGB6eTgslX0c2JKcjgmgQ,270
+ocgraph/configuration/logger.py,sha256=RvcifAk83j1A0dr_ggTB-RjJbce-AfF9FqNt3SkRuOo,1450
+ocgraph/data/__init__.py,sha256=K33Oe6IVtFkZBJCjB3oSvozWUxjggHvbdRjRPelXgLM,377
+ocgraph/data/address.py,sha256=fjtZeXtb4u_tvPCrMADzQvDJP-1FQyb6ITLc4wEnh6o,1541
+ocgraph/data/basic_block.py,sha256=ACGdp7UNSK2_zTqZSmsPIf6jxlYqNXT3C-zFQ3cueJI,1245
+ocgraph/data/encoding.py,sha256=iTd9A4VgUS-Ay_t4P80raOcQlWkn2F6yw_IrUKXdhB4,709
+ocgraph/data/function_header.py,sha256=eXla2drLjaU2h-KJ6Uj4Og7pEpl_xtbPVXTAurYycyQ,539
+ocgraph/data/instruction.py,sha256=2y_j5AJ9PqOtuHit3Zc-Rv9epe1TlJRQMeWATstlZhY,3165
+ocgraph/data/jump_table.py,sha256=kESmsyXegcoufseVBBJ2cTQOpOtcNItxKwfTQk8PEm4,2235
+ocgraph/interface/__init__.py,sha256=LeG2MmjZ-lkTnzt42kVSxbntxC8xQ1WbQIF1luLoZbo,188
+ocgraph/interface/analyzer.py,sha256=4zWLOnnVZ9uaIXB7FYCvAZr0-JhSRgwoYhfjnYU5Gho,8837
+ocgraph/interface/coverage_reader.py,sha256=qBvAIV_L9Jvu5BSUqrJOeJ5AARl4loXRn1rHZNthB3w,2691
+ocgraph/interface/drawer.py,sha256=B1a-4mIS15Wi5-1D0KJSajHqPcAVGts8ve3KCGfjyXE,6307
+ocgraph-0.3.0.dist-info/LICENSES/GTDGmbH.md,sha256=Sh6tQQ93TslzOeB3P5pDOC7aO75_hT2REty8L9fZOlg,1144
+ocgraph-0.3.0.dist-info/LICENSES/MauriMustonen.md,sha256=I9pTZ1awb__C_YoKDciaBx5yPRED5cQx5W2upVVm_n0,1126
+ocgraph-0.3.0.dist-info/METADATA,sha256=0P27zNvzstlvhN4JavHBRLoj4GwbRLJMIyI-cUm5Oks,2265
+ocgraph-0.3.0.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
+ocgraph-0.3.0.dist-info/entry_points.txt,sha256=4PfSLWgRL4CPVakqzZZVpJ223O9b0plfGdhv-OFUxEM,49
+ocgraph-0.3.0.dist-info/RECORD,,

ocgraph-0.3.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.1.1
+Root-Is-Purelib: true
+Tag: py3-none-any

ocgraph-0.3.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+ocgraph=ocgraph.__main__:main
+