CgroupV1Subsystem

java.lang.Object
- com.oracle.svm.core.containers.cgroupv1.CgroupV1Subsystem

All Implemented Interfaces:: CgroupSubsystem, CgroupV1Metrics, Metrics

public class CgroupV1Subsystem
extends Object
implements CgroupSubsystem, CgroupV1Metrics

Field Summary
- Fields inherited from interface com.oracle.svm.core.containers.CgroupSubsystem
  LONG_RETVAL_UNLIMITED

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`getBlkIOServiceCount()` BlKIO Subsystem
`long`	`getBlkIOServiced()` Returns the number of block I/O bytes that have been transferred to/from the disk by the Isolation Group.
`long`	`getCpuNumPeriods()` Returns the number of time-slice periods that have elapsed if a CPU quota has been setup for the Isolation Group
`long`	`getCpuNumThrottled()` Returns the number of time-slice periods that the group has been throttled or limited due to the group exceeding its quota if a CPU quota has been setup for the Isolation Group.
`long`	`getCpuPeriod()` CPU Subsystem
`long`	`getCpuQuota()` Returns the total available run-time allowed, in microseconds, during each scheduling period for all tasks in the Isolation Group.
`int[]`	`getCpuSetCpus()` CPUSet Subsystem
`double`	`getCpuSetMemoryPressure()` Returns the (attempts per second * 1000), if enabled, that the operating system tries to satisfy a memory request for any process in the current Isolation Group when no free memory is readily available.
`int[]`	`getCpuSetMems()` Returns the memory nodes that are available for use by processes in the current Isolation Group.
`long`	`getCpuShares()` Returns the relative weighting of processes with the Isolation Group used for prioritizing the scheduling of processes across all Isolation Groups running on a host.
`long`	`getCpuSystemUsage()` Returns the aggregate system time, in nanoseconds, consumed by all tasks in the Isolation Group.
`long`	`getCpuThrottledTime()` Returns the total time duration, in nanoseconds, that the group has been throttled or limited due to the group exceeding its quota if a CPU quota has been setup for the Isolation Group.
`long`	`getCpuUsage()` CPU Accounting Subsystem
`long`	`getCpuUserUsage()` Returns the aggregate user time, in nanoseconds, consumed by all tasks in the Isolation Group.
`long`	`getEffectiveCpuCount()` Returns the number of effective processors that this Isolation group has available to it.
`int[]`	`getEffectiveCpuSetCpus()` Returns the CPUS that are available and online for execution of processes within the current Isolation Group.
`int[]`	`getEffectiveCpuSetMems()` Returns the memory nodes that are available and online for use by processes within the current Isolation Group.
`static CgroupV1Subsystem`	`getInstance()`
`long`	`getKernelMemoryFailCount()` Returns the number of times that kernel memory requests in the Isolation Group have exceeded the kernel memory limit.
`long`	`getKernelMemoryLimit()` Returns the maximum amount of kernel physical memory, in bytes, that can be allocated in the Isolation Group.
`long`	`getKernelMemoryMaxUsage()` Returns the largest amount of kernel physical memory, in bytes, that have been allocated in the Isolation Group.
`long`	`getKernelMemoryUsage()` Returns the amount of kernel physical memory, in bytes, that is currently allocated in the current Isolation Group.
`long`	`getMemoryAndSwapFailCount()` Returns the number of times that user memory requests in the Isolation Group have exceeded the memory + swap limit.
`long`	`getMemoryAndSwapLimit()` Returns the maximum amount of physical memory and swap space, in bytes, that can be allocated in the Isolation Group.
`long`	`getMemoryAndSwapMaxUsage()` Returns the largest amount of physical memory and swap space, in bytes, that have been allocated in the Isolation Group.
`long`	`getMemoryAndSwapUsage()` Returns the amount of physical memory and swap space, in bytes, that is currently allocated in the current Isolation Group.
`long`	`getMemoryFailCount()` Memory Subsystem
`long`	`getMemoryLimit()` Returns the maximum amount of physical memory, in bytes, that can be allocated in the Isolation Group.
`long`	`getMemoryMaxUsage()` Returns the largest amount of physical memory, in bytes, that have been allocated in the Isolation Group.
`long`	`getMemorySoftLimit()` Returns the hint to the operating system that allows groups to specify the minimum amount of physical memory that they need to achieve reasonable performance in low memory systems.
`long`	`getMemoryUsage()` Returns the amount of physical memory, in bytes, that is currently allocated in the current Isolation Group.
`long[]`	`getPerCpuUsage()` Returns the aggregate time, in nanoseconds, consumed by all tasks in the Isolation Group, separated by CPU.
`String`	`getProvider()` Returns the interface responsible for providing the platform metrics.
`long`	`getTcpMemoryFailCount()` Returns the number of times that networking memory requests in the Isolation Group have exceeded the kernel memory limit.
`long`	`getTcpMemoryLimit()` Returns the maximum amount of networking physical memory, in bytes, that can be allocated in the Isolation Group.
`long`	`getTcpMemoryMaxUsage()` Returns the largest amount of networking physical memory, in bytes, that have been allocated in the Isolation Group.
`long`	`getTcpMemoryUsage()` Returns the amount of networking physical memory, in bytes, that is currently allocated in the current Isolation Group.
`Boolean`	`isCpuSetMemoryPressureEnabled()` Returns the state of the memory pressure detection support.
`Boolean`	`isMemoryOOMKillEnabled()` Returns the state of the Operating System Out of Memory termination policy.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.svm.core.containers.Metrics
systemMetrics

- Method Detail
  - getInstance
```
public static CgroupV1Subsystem getInstance()
```
  - getProvider
```
public String getProvider()
```
    Description copied from interface: Metrics
    
    Returns the interface responsible for providing the platform metrics. Implementation note: Metrics are currently only supported Linux. The provider for Linux is cgroups (version 1 or 2).
    
    Specified by:
    
    getProvider in interface Metrics
    
    Returns:
    
    The name of the provider.
  - getCpuUsage
```
public long getCpuUsage()
```
    CPU Accounting Subsystem
    
    Specified by:
    
    getCpuUsage in interface Metrics
    
    Returns:
    
    Time in nanoseconds, -1 if unknown or -2 if the metric is not supported.
  - getPerCpuUsage
```
public long[] getPerCpuUsage()
```
    Description copied from interface: Metrics
    
    Returns the aggregate time, in nanoseconds, consumed by all tasks in the Isolation Group, separated by CPU. If the current process is running within a container, the reported time will only be valid for processes running within the same container. The values are returned in an array, one entry for each physical processor on the system. Time values for processors unavailable to this Group are undefined.
    
    Specified by:
    
    getPerCpuUsage in interface Metrics
    
    Returns:
    
    long array of time values. The size of the array is equal to the total number of physical processors in the system. If this metric is not supported or not available, null will be returned.
  - getCpuUserUsage
```
public long getCpuUserUsage()
```
    Description copied from interface: Metrics
    
    Returns the aggregate user time, in nanoseconds, consumed by all tasks in the Isolation Group.
    
    Specified by:
    
    getCpuUserUsage in interface Metrics
    
    Returns:
    
    User time in nanoseconds, -1 if the metric is not available or -2 if the metric is not supported.
  - getCpuSystemUsage
```
public long getCpuSystemUsage()
```
    Description copied from interface: Metrics
    
    Returns the aggregate system time, in nanoseconds, consumed by all tasks in the Isolation Group.
    
    Specified by:
    
    getCpuSystemUsage in interface Metrics
    
    Returns:
    
    System time in nanoseconds, -1 if the metric is not available or -2 if the metric is not supported.
  - getCpuPeriod
```
public long getCpuPeriod()
```
    CPU Subsystem
    
    Specified by:
    
    getCpuPeriod in interface Metrics
    
    Returns:
    
    time in microseconds, -1 if the metric is not available or -2 if the metric is not supported.
  - getCpuQuota
```
public long getCpuQuota()
```
    Description copied from interface: Metrics
    
    Returns the total available run-time allowed, in microseconds, during each scheduling period for all tasks in the Isolation Group.
    
    Specified by:
    
    getCpuQuota in interface Metrics
    
    Returns:
    
    time in microseconds, -1 if the quota is unlimited or -2 if not supported.
  - getCpuShares
```
public long getCpuShares()
```
    Description copied from interface: Metrics
    
    Returns the relative weighting of processes with the Isolation Group used for prioritizing the scheduling of processes across all Isolation Groups running on a host. Implementation note: Popular container orchestration systems have standardized shares to be multiples of 1024, where 1024 is interpreted as 1 CPU share of execution. Users can distribute CPU resources to multiple Isolation Groups by specifying the CPU share weighting needed by each process. To request 2 CPUS worth of execution time, CPU shares would be set to 2048.
    
    Specified by:
    
    getCpuShares in interface Metrics
    
    Returns:
    
    shares value, -1 if the metric is not available or -2 if cpu shares are not supported.
  - getCpuNumPeriods
```
public long getCpuNumPeriods()
```
    Description copied from interface: Metrics
    
    Returns the number of time-slice periods that have elapsed if a CPU quota has been setup for the Isolation Group
    
    Specified by:
    
    getCpuNumPeriods in interface Metrics
    
    Returns:
    
    count of elapsed periods, -1 if the metric is not available or -2 if the metric is not supported.
  - getCpuNumThrottled
```
public long getCpuNumThrottled()
```
    Description copied from interface: Metrics
    
    Returns the number of time-slice periods that the group has been throttled or limited due to the group exceeding its quota if a CPU quota has been setup for the Isolation Group.
    
    Specified by:
    
    getCpuNumThrottled in interface Metrics
    
    Returns:
    
    count of throttled periods, -1 if the metric is not available or -2 if it is not supported.
  - getCpuThrottledTime
```
public long getCpuThrottledTime()
```
    Description copied from interface: Metrics
    
    Returns the total time duration, in nanoseconds, that the group has been throttled or limited due to the group exceeding its quota if a CPU quota has been setup for the Isolation Group.
    
    Specified by:
    
    getCpuThrottledTime in interface Metrics
    
    Returns:
    
    Throttled time in nanoseconds, -1 if the metric is not available or -2 if it is not supported.
  - getEffectiveCpuCount
```
public long getEffectiveCpuCount()
```
    Description copied from interface: Metrics
    
    Returns the number of effective processors that this Isolation group has available to it. This effective processor count is computed based on the number of dedicated CPUs, CPU shares and CPU quotas in effect for this isolation group. This method returns the same value as Runtime.availableProcessors().
    
    Specified by:
    
    getEffectiveCpuCount in interface Metrics
    
    Returns:
    
    The number of effective CPUs.
  - getCpuSetCpus
```
public int[] getCpuSetCpus()
```
    CPUSet Subsystem
    
    Specified by:
    
    getCpuSetCpus in interface Metrics
    
    Returns:
    
    An array of available CPUs. Returns null if the metric is not available or the metric is not supported.
  - getEffectiveCpuSetCpus
```
public int[] getEffectiveCpuSetCpus()
```
    Description copied from interface: Metrics
    
    Returns the CPUS that are available and online for execution of processes within the current Isolation Group. The size of the array is equal to the total number of CPUs and the elements in the array are the physical CPU numbers.
    
    Specified by:
    
    getEffectiveCpuSetCpus in interface Metrics
    
    Returns:
    
    An array of available and online CPUs. Returns null if the metric is not available or the metric is not supported.
  - getCpuSetMems
```
public int[] getCpuSetMems()
```
    Description copied from interface: Metrics
    
    Returns the memory nodes that are available for use by processes in the current Isolation Group. The size of the array is equal to the total number of nodes and the elements in the array are the physical node numbers that are available. Some of the nodes returned may be offline. To get the current online memory nodes, use Metrics.getEffectiveCpuSetMems().
    
    Specified by:
    
    getCpuSetMems in interface Metrics
    
    Returns:
    
    An array of available memory nodes or null if the metric is not available or is not supported.
  - getEffectiveCpuSetMems
```
public int[] getEffectiveCpuSetMems()
```
    Description copied from interface: Metrics
    
    Returns the memory nodes that are available and online for use by processes within the current Isolation Group. The size of the array is equal to the total number of nodes and the elements in the array are the physical node numbers.
    
    Specified by:
    
    getEffectiveCpuSetMems in interface Metrics
    
    Returns:
    
    An array of available and online nodes or null if the metric is not available or is not supported.
  - getCpuSetMemoryPressure
```
public double getCpuSetMemoryPressure()
```
    Description copied from interface: CgroupV1Metrics
    
    Returns the (attempts per second * 1000), if enabled, that the operating system tries to satisfy a memory request for any process in the current Isolation Group when no free memory is readily available. Use CgroupV1Metrics.isCpuSetMemoryPressureEnabled() to determine if this support is enabled.
    
    Specified by:
    
    getCpuSetMemoryPressure in interface CgroupV1Metrics
    
    Returns:
    
    Memory pressure or 0 if not enabled or -1 if metric is not available.
  - isCpuSetMemoryPressureEnabled
```
public Boolean isCpuSetMemoryPressureEnabled()
```
    Description copied from interface: CgroupV1Metrics
    
    Returns the state of the memory pressure detection support.
    
    Specified by:
    
    isCpuSetMemoryPressureEnabled in interface CgroupV1Metrics
    
    Returns:
    
    true if support is available and enabled. false otherwise.
  - getMemoryFailCount
```
public long getMemoryFailCount()
```
    Memory Subsystem
    
    Specified by:
    
    getMemoryFailCount in interface Metrics
    
    Returns:
    
    The number of exceeded requests or -1 if the metric is not available. Returns -2 if the metric is not supported.
  - getMemoryLimit
```
public long getMemoryLimit()
```
    Description copied from interface: Metrics
    
    Returns the maximum amount of physical memory, in bytes, that can be allocated in the Isolation Group.
    
    Specified by:
    
    getMemoryLimit in interface Metrics
    
    Returns:
    
    The maximum amount of memory in bytes or -1 if there is no limit or -2 if this metric is not supported.
  - getMemoryMaxUsage
```
public long getMemoryMaxUsage()
```
    Description copied from interface: CgroupV1Metrics
    
    Returns the largest amount of physical memory, in bytes, that have been allocated in the Isolation Group.
    
    Specified by:
    
    getMemoryMaxUsage in interface CgroupV1Metrics
    
    Returns:
    
    The largest amount of memory in bytes or -1 if this metric is not available. Returns -2 if this metric is not supported.
  - getMemoryUsage
```
public long getMemoryUsage()
```
    Description copied from interface: Metrics
    
    Returns the amount of physical memory, in bytes, that is currently allocated in the current Isolation Group.
    
    Specified by:
    
    getMemoryUsage in interface Metrics
    
    Returns:
    
    The amount of memory in bytes allocated or -1 if the metric is not available or -2 if the metric is not supported.
  - getKernelMemoryFailCount
```
public long getKernelMemoryFailCount()
```
    Description copied from interface: CgroupV1Metrics
    
    Returns the number of times that kernel memory requests in the Isolation Group have exceeded the kernel memory limit.
    
    Specified by:
    
    getKernelMemoryFailCount in interface CgroupV1Metrics
    
    Returns:
    
    The number of exceeded requests or -1 if metric is not available.
  - getKernelMemoryLimit
```
public long getKernelMemoryLimit()
```
    Description copied from interface: CgroupV1Metrics
    
    Returns the maximum amount of kernel physical memory, in bytes, that can be allocated in the Isolation Group.
    
    Specified by:
    
    getKernelMemoryLimit in interface CgroupV1Metrics
    
    Returns:
    
    The maximum amount of memory in bytes or -1 if there is no limit set.
  - getKernelMemoryMaxUsage
```
public long getKernelMemoryMaxUsage()
```
    Description copied from interface: CgroupV1Metrics
    
    Returns the largest amount of kernel physical memory, in bytes, that have been allocated in the Isolation Group.
    
    Specified by:
    
    getKernelMemoryMaxUsage in interface CgroupV1Metrics
    
    Returns:
    
    The largest amount of memory in bytes or -1 if this metric is not available.
  - getKernelMemoryUsage
```
public long getKernelMemoryUsage()
```
    Description copied from interface: CgroupV1Metrics
    
    Returns the amount of kernel physical memory, in bytes, that is currently allocated in the current Isolation Group.
    
    Specified by:
    
    getKernelMemoryUsage in interface CgroupV1Metrics
    
    Returns:
    
    The amount of memory in bytes allocated or -1 if this metric is not available.
  - getTcpMemoryFailCount
```
public long getTcpMemoryFailCount()
```
    Description copied from interface: CgroupV1Metrics
    
    Returns the number of times that networking memory requests in the Isolation Group have exceeded the kernel memory limit.
    
    Specified by:
    
    getTcpMemoryFailCount in interface CgroupV1Metrics
    
    Returns:
    
    The number of exceeded requests or -1 if the metric is not available.
  - getTcpMemoryLimit
```
public long getTcpMemoryLimit()
```
    Description copied from interface: CgroupV1Metrics
    
    Returns the maximum amount of networking physical memory, in bytes, that can be allocated in the Isolation Group.
    
    Specified by:
    
    getTcpMemoryLimit in interface CgroupV1Metrics
    
    Returns:
    
    The maximum amount of memory in bytes or -1 if there is no limit.
  - getTcpMemoryMaxUsage
```
public long getTcpMemoryMaxUsage()
```
    Description copied from interface: CgroupV1Metrics
    
    Returns the largest amount of networking physical memory, in bytes, that have been allocated in the Isolation Group.
    
    Specified by:
    
    getTcpMemoryMaxUsage in interface CgroupV1Metrics
    
    Returns:
    
    The largest amount of memory in bytes or -1 if this metric is not available.
  - getTcpMemoryUsage
```
public long getTcpMemoryUsage()
```
    Description copied from interface: Metrics
    
    Returns the amount of networking physical memory, in bytes, that is currently allocated in the current Isolation Group.
    
    Specified by:
    
    getTcpMemoryUsage in interface Metrics
    
    Returns:
    
    The amount of memory in bytes allocated or -1 if the metric is not available. Returns -2 if this metric is not supported.
  - getMemoryAndSwapFailCount
```
public long getMemoryAndSwapFailCount()
```
    Description copied from interface: CgroupV1Metrics
    
    Returns the number of times that user memory requests in the Isolation Group have exceeded the memory + swap limit.
    
    Specified by:
    
    getMemoryAndSwapFailCount in interface CgroupV1Metrics
    
    Returns:
    
    The number of exceeded requests or -1 if the metric is not available.
  - getMemoryAndSwapLimit
```
public long getMemoryAndSwapLimit()
```
    Description copied from interface: Metrics
    
    Returns the maximum amount of physical memory and swap space, in bytes, that can be allocated in the Isolation Group.
    
    Specified by:
    
    getMemoryAndSwapLimit in interface Metrics
    
    Returns:
    
    The maximum amount of memory in bytes or -1 if there is no limit set or -2 if this metric is not supported.
  - getMemoryAndSwapMaxUsage
```
public long getMemoryAndSwapMaxUsage()
```
    Description copied from interface: CgroupV1Metrics
    
    Returns the largest amount of physical memory and swap space, in bytes, that have been allocated in the Isolation Group.
    
    Specified by:
    
    getMemoryAndSwapMaxUsage in interface CgroupV1Metrics
    
    Returns:
    
    The largest amount of memory in bytes or -1 if this metric is not available.
  - getMemoryAndSwapUsage
```
public long getMemoryAndSwapUsage()
```
    Description copied from interface: Metrics
    
    Returns the amount of physical memory and swap space, in bytes, that is currently allocated in the current Isolation Group.
    
    Specified by:
    
    getMemoryAndSwapUsage in interface Metrics
    
    Returns:
    
    The amount of memory in bytes allocated or -1 if the metric is not available. Returns -2 if this metric is not supported.
  - isMemoryOOMKillEnabled
```
public Boolean isMemoryOOMKillEnabled()
```
    Description copied from interface: CgroupV1Metrics
    
    Returns the state of the Operating System Out of Memory termination policy.
    
    Specified by:
    
    isMemoryOOMKillEnabled in interface CgroupV1Metrics
    
    Returns:
    
    Returns true if operating system will terminate processes in the Isolation Group that exceed the amount of available memory, otherwise false. null will be returned if this capability is not available on the current operating system.
  - getMemorySoftLimit
```
public long getMemorySoftLimit()
```
    Description copied from interface: Metrics
    
    Returns the hint to the operating system that allows groups to specify the minimum amount of physical memory that they need to achieve reasonable performance in low memory systems. This allows host systems to provide greater sharing of memory.
    
    Specified by:
    
    getMemorySoftLimit in interface Metrics
    
    Returns:
    
    The minimum amount of physical memory, in bytes, that the operating system will try to maintain under low memory conditions. If this metric is not available, -1 will be returned. Returns -2 if the metric is not supported.
  - getBlkIOServiceCount
```
public long getBlkIOServiceCount()
```
    BlKIO Subsystem
    
    Specified by:
    
    getBlkIOServiceCount in interface Metrics
    
    Returns:
    
    The count of requests or -1 if the metric is not available. Returns -2 if this metric is not supported.
  - getBlkIOServiced
```
public long getBlkIOServiced()
```
    Description copied from interface: Metrics
    
    Returns the number of block I/O bytes that have been transferred to/from the disk by the Isolation Group.
    
    Specified by:
    
    getBlkIOServiced in interface Metrics
    
    Returns:
    
    The number of bytes transferred or -1 if the metric is not available. Returns -2 if this metric is not supported.

Class CgroupV1Subsystem

Field Summary

Fields inherited from interface com.oracle.svm.core.containers.CgroupSubsystem

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.oracle.svm.core.containers.Metrics

Method Detail

getInstance

getProvider

getCpuUsage

getPerCpuUsage

getCpuUserUsage

getCpuSystemUsage

getCpuPeriod

getCpuQuota

getCpuShares

getCpuNumPeriods

getCpuNumThrottled

getCpuThrottledTime

getEffectiveCpuCount

getCpuSetCpus

getEffectiveCpuSetCpus

getCpuSetMems

getEffectiveCpuSetMems

getCpuSetMemoryPressure

isCpuSetMemoryPressureEnabled

getMemoryFailCount

getMemoryLimit

getMemoryMaxUsage

getMemoryUsage

getKernelMemoryFailCount

getKernelMemoryLimit

getKernelMemoryMaxUsage

getKernelMemoryUsage

getTcpMemoryFailCount

getTcpMemoryLimit

getTcpMemoryMaxUsage

getTcpMemoryUsage

getMemoryAndSwapFailCount

getMemoryAndSwapLimit

getMemoryAndSwapMaxUsage

getMemoryAndSwapUsage

isMemoryOOMKillEnabled

getMemorySoftLimit

getBlkIOServiceCount

getBlkIOServiced