Class SouffleDetectorAbstract

Abstract class for Souffle-based detectors that implement Datalog-based analyses.

Hierarchy (view full)

Constructors

Properties

Accessors

  • get id(): string
  • Gets the short identifier of the detector, used in analyzer warnings.

    Returns string

    The unique identifier of the detector.

  • get shareImportedWarnings(): WarningsBehavior
  • Defines the behavior of warnings generated by this detector when working with multiple projects within a single Tact configuration.

    Here are the available options:

    1. "union" Leave this value if you don't care about warnings generated in other projects.
    2. "intersect" If the warning is generated for some source location of the imported file, it should be generated by each of the projects. Example: Constants from an imported file should not be reported iff they are unused in all the projects, so you need "intersect".

    Returns WarningsBehavior

  • get usesSouffle(): boolean
  • Checks whether this detector needs the Soufflé binary to be executed.

    Returns boolean

Methods

  • Creates a Soufflé context with unique name.

    Parameters

    • cu: CompilationUnit
    • docstring: undefined | string | string[] = ...

      A comment introduced on the top of the generated program if ctx.config.souffleVerbose is set.

      It should be used to avoid name clashes in the Soufflé directory when working with multiple projects.

    Returns SouffleContext<SrcInfo>

  • Executes Souffle program for this detector converting output facts to warnings.

    Parameters

    • ctx: SouffleContext<SrcInfo>

      Souffle context with all the declarations, rules and facts added.

    • callback: ((fact: SouffleFact<SrcInfo>) => undefined | MistiTactWarning)

      A function that creates warnings from output facts.

    Returns Promise<MistiTactWarning[]>

  • Returns true if the identifier with the given name should not be reported by unused variables detectors.

    Parameters

    • name: string

    Returns boolean