Table of Contents

Class EnvironmentMode

Namespace
BenchmarkDotNet.Jobs
Assembly
BenchmarkDotNet.dll
public sealed class EnvironmentMode : JobMode<EnvironmentMode>
Inheritance
EnvironmentMode
Inherited Members
Extension Methods

Constructors

EnvironmentMode() 

public EnvironmentMode()

EnvironmentMode(Runtime) 

public EnvironmentMode(Runtime runtime)

Parameters

runtime Runtime

EnvironmentMode(string) 

public EnvironmentMode(string id)

Parameters

id string

EnvironmentMode(string, Jit, Platform) 

public EnvironmentMode(string id, Jit jit, Platform platform)

Parameters

id string
jit Jit
platform Platform

Fields

AffinityCharacteristic 

public static readonly Characteristic<nint> AffinityCharacteristic

Field Value

Characteristic<nint>

EnvironmentVariablesCharacteristic 

public static readonly Characteristic<IReadOnlyList<EnvironmentVariable>> EnvironmentVariablesCharacteristic

Field Value

Characteristic<IReadOnlyList<EnvironmentVariable>>

GcCharacteristic 

public static readonly Characteristic<GcMode> GcCharacteristic

Field Value

Characteristic<GcMode>

JitCharacteristic 

public static readonly Characteristic<Jit> JitCharacteristic

Field Value

Characteristic<Jit>

LargeAddressAwareCharacteristic 

public static readonly Characteristic<bool> LargeAddressAwareCharacteristic

Field Value

Characteristic<bool>

LegacyJitX64 

public static readonly EnvironmentMode LegacyJitX64

Field Value

EnvironmentMode

LegacyJitX86 

public static readonly EnvironmentMode LegacyJitX86

Field Value

EnvironmentMode

PlatformCharacteristic 

public static readonly Characteristic<Platform> PlatformCharacteristic

Field Value

Characteristic<Platform>

PowerPlanModeCharacteristic 

public static readonly Characteristic<Guid?> PowerPlanModeCharacteristic

Field Value

Characteristic<Guid?>

RuntimeCharacteristic 

public static readonly Characteristic<Runtime> RuntimeCharacteristic

Field Value

Characteristic<Runtime>

RyuJitX64 

public static readonly EnvironmentMode RyuJitX64

Field Value

EnvironmentMode

RyuJitX86 

public static readonly EnvironmentMode RyuJitX86

Field Value

EnvironmentMode

Properties

Affinity

ProcessorAffinity for the benchmark process. See also: https://msdn.microsoft.com/library/system.diagnostics.process.processoraffinity.aspx

public nint Affinity { get; set; }

Property Value

nint

EnvironmentVariables 

public IReadOnlyList<EnvironmentVariable> EnvironmentVariables { get; set; }

Property Value

IReadOnlyList<EnvironmentVariable>

Gc

GcMode

public GcMode Gc { get; }

Property Value

GcMode

Jit

JIT (Just-In-Time compiler)

public Jit Jit { get; set; }

Property Value

Jit

LargeAddressAware

Specifies that benchmark can handle addresses larger than 2 gigabytes. false: Benchmark uses the default (64-bit: enabled; 32-bit:disabled). This is the default. true: Explicitly specify that benchmark can handle addresses larger than 2 gigabytes.

public bool LargeAddressAware { get; set; }

Property Value

bool

Platform

Platform (x86 or x64)

public Platform Platform { get; set; }

Property Value

Platform

PowerPlanMode

Power Plan Mode

public Guid? PowerPlanMode { get; set; }

Property Value

Guid?

Remarks

Supported only on Windows.

Runtime

Runtime

public Runtime Runtime { get; set; }

Property Value

Runtime

Methods

SetEnvironmentVariable(EnvironmentVariable)

Adds the specified variable to EnvironmentVariables. If EnvironmentVariables already contains a variable with the same key, it will be overriden.

public void SetEnvironmentVariable(EnvironmentVariable variable)

Parameters

variable EnvironmentVariable

The new environment variable which should be added to EnvironmentVariables