Class BenchmarkInstanceAbstract

constructor

• new BenchmarkInstance(name: string): BenchmarkInstance

  Parameters

  • name: string

  Returns BenchmarkInstance

StaticCACHE_ENABLE

close

• close(): void

  Restores the AST previous to load().

  Returns void

compile

• compile(): File | undefined

  Compiles the current version of the benchmark that is in the AST. Requires calling .load() first.

  Returns File | undefined

execute

• execute(): ProcessExecutor

  Executes the current version of the benchmark. Requires calling .compile() first.

  Returns ProcessExecutor

  the ProcessExecutor used to execute this instance

getBaseFolder

• getBaseFolder(): File

  Returns File

  The base folder for all benchmark instances. Currently is a folder 'laraBenchmarks' inside the working directory.

getCompilationEngine

• getCompilationEngine(): BenchmarkCompilationEngine

  Returns BenchmarkCompilationEngine

  An available BenchmarkCompilationEngine that can be used to run compiled the program (implementations may vary). If used, can be used to configure the compilation.

getExecutor

• getExecutor(): ProcessExecutor

  Returns ProcessExecutor

  The executor that will be used to run the compiled program, can be used to configure the execution.

AbstractgetKernel

• getKernel(): LaraJoinPoint

  Returns LaraJoinPoint

  Point in the code representing the execution of the benchmark kernel, around which metrics should be measured.

getName

• getName(): string

  Returns string

  The name of this BenchmarkInstance.

isCachedAst

• isCachedAst(): boolean

  Returns boolean

load

• load(): void

  Saves the current AST and loads this benchmark into the AST.

  Returns void

setCompilationEngine

• setCompilationEngine<T extends BenchmarkCompilationEngine>(
      compilationEngineProvider: new (name: string) => T,
  ): void

  Type Parameters

  • T extends BenchmarkCompilationEngine

  Parameters

  • compilationEngineProvider: new (name: string) => T

  Returns void

setExecutable

• setExecutable(executable: File): void

  Parameters

  • executable: File

  Returns void

test

• test(
      worker?: (instance: BenchmarkInstance) => boolean,
      executeCode?: boolean,
      outputProcessor?: (executor: ProcessExecutor) => void,
  ): boolean

  Test the current instance.

  Parameters

  • worker: (instance: BenchmarkInstance) => boolean = ...

    Function with no parameters that will be called after loading the benchmark code as AST.

  • executeCode: boolean = false

    If true, executes the code after worker is applied.

  • outputProcessor: (executor: ProcessExecutor) => void = ...

    If execution is enabled, will be called after execution with the corresponding ProcessExecutor.

  Returns boolean

  True, if finished without problems

StaticpurgeCache

• purgeCache(): void

  Clears compilation cache of all BenchmarkInstances.

  Returns void

StaticsetCache

• setCache(enable: boolean): void

  Parameters

  • enable: boolean

    If true, enables caching of parsed files. By default, caching is enabled.

  Returns void