codeql/cpp/ql/lib/semmle/code/cpp/ir/implementation/IRConfiguration.qll

/**
 * Module used to configure the IR generation process.
 */

private import internal.IRConfigurationInternal

private newtype TIRConfiguration = MkIRConfiguration()

/**
 * The query can extend this class to control which functions have IR generated for them.
 */
class IRConfiguration extends TIRConfiguration {
  /** Gets a textual representation of this element. */
  string toString() { result = "IRConfiguration" }

  /**
   * Holds if IR should be created for function `func`. By default, holds for all functions.
   */
  predicate shouldCreateIRForFunction(Language::Declaration func) { any() }

  /**
   * Holds if the strings used as part of an IR dump should be generated for function `func`.
   *
   * This predicate is overridden in `PrintIR.qll` to avoid the expense of generating a large number
   * of debug strings for IR that will not be dumped. We still generate the actual IR for these
   * functions, however, to preserve the results of any interprocedural analysis.
   */
  predicate shouldEvaluateDebugStringsForFunction(Language::Declaration func) { any() }
}

private newtype TIREscapeAnalysisConfiguration = MkIREscapeAnalysisConfiguration()

/**
 * The query can extend this class to control what escape analysis is used when generating SSA.
 */
class IREscapeAnalysisConfiguration extends TIREscapeAnalysisConfiguration {
  /** Gets a textual representation of this element. */
  string toString() { result = "IREscapeAnalysisConfiguration" }

  /**
   * Holds if the escape analysis done by SSA construction should be sound. By default, the SSA is
   * built assuming that no variable's address ever escapes.
   */
  predicate useSoundEscapeAnalysis() { none() }
}