cea-sec/miasm

View on GitHub
example/ida/graph_ir.py

Summary

Maintainability
D
2 days
Test Coverage

Function build_graph has a Cognitive Complexity of 51 (exceeds 5 allowed). Consider refactoring.
Open

def build_graph(start_addr, type_graph, simplify=False, use_ida_stack=True, dontmodstack=False, loadint=False, verbose=False):
    machine = guess_machine(addr=start_addr)
    dis_engine, lifter_model_call = machine.dis_engine, machine.lifter_model_call

    class IRADelModCallStack(lifter_model_call):
Severity: Minor
Found in example/ida/graph_ir.py - About 7 hrs to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

File graph_ir.py has 292 lines of code (exceeds 250 allowed). Consider refactoring.
Open

from __future__ import print_function
import os
import tempfile
from builtins import int as int_types

Severity: Minor
Found in example/ida/graph_ir.py - About 3 hrs to fix

    Function OnRefresh has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
    Open

        def OnRefresh(self):
            self.Clear()
            addr_id = {}
            for (loc_key, irblock) in viewitems(self.ircfg.blocks):
                id_irblock = self.AddNode(color_irblock(irblock, self.ircfg))
    Severity: Minor
    Found in example/ida/graph_ir.py - About 1 hr to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Function build_graph has 31 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    def build_graph(start_addr, type_graph, simplify=False, use_ida_stack=True, dontmodstack=False, loadint=False, verbose=False):
        machine = guess_machine(addr=start_addr)
        dis_engine, lifter_model_call = machine.dis_engine, machine.lifter_model_call
    
        class IRADelModCallStack(lifter_model_call):
    Severity: Minor
    Found in example/ida/graph_ir.py - About 1 hr to fix

      Function build_graph has 7 arguments (exceeds 4 allowed). Consider refactoring.
      Open

      def build_graph(start_addr, type_graph, simplify=False, use_ida_stack=True, dontmodstack=False, loadint=False, verbose=False):
      Severity: Major
      Found in example/ida/graph_ir.py - About 50 mins to fix

        Identical blocks of code found in 2 locations. Consider refactoring.
        Open

                        for assignblk in assignblks:
                            dct = dict(assignblk)
                            dct = {
                                dst:src for (dst, src) in viewitems(dct) if dst != self.sp
                            }
        Severity: Major
        Found in example/ida/graph_ir.py and 1 other location - About 3 hrs to fix
        example/disasm/full.py on lines 223..228

        Duplicated Code

        Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

        Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

        When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

        Tuning

        This issue has a mass of 63.

        We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

        The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

        If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

        See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

        Refactorings

        Further Reading

        Similar blocks of code found in 2 locations. Consider refactoring.
        Open

                        call_assignblk = AssignBlock(
                            [
                                ExprAssign(self.ret_reg, ExprOp('call_func_ret', addr)),
                                ExprAssign(self.sp, self.sp + ExprInt(stk_diff, self.sp.size))
                            ],
        Severity: Major
        Found in example/ida/graph_ir.py and 1 other location - About 1 hr to fix
        example/ida/ctype_propagation.py on lines 235..240

        Duplicated Code

        Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

        Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

        When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

        Tuning

        This issue has a mass of 49.

        We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

        The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

        If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

        See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

        Refactorings

        Further Reading

        Similar blocks of code found in 2 locations. Consider refactoring.
        Open

        def is_addr_ro_variable(bs, addr, size):
            """
            Return True if address at @addr is a read-only variable.
            WARNING: Quick & Dirty
        
        
        Severity: Major
        Found in example/ida/graph_ir.py and 1 other location - About 1 hr to fix
        example/disasm/full.py on lines 285..298

        Duplicated Code

        Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

        Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

        When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

        Tuning

        This issue has a mass of 42.

        We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

        The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

        If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

        See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

        Refactorings

        Further Reading

        There are no issues that match your filters.

        Category
        Status