Package org.apache.flink.runtime.util.config.memory

Class CommonProcessMemorySpec<FM extends FlinkMemory>

java.lang.Object

org.apache.flink.runtime.util.config.memory.CommonProcessMemorySpec<FM>

All Implemented Interfaces:

Serializable, ProcessMemorySpec

Direct Known Subclasses:

JobManagerProcessSpec, TaskExecutorProcessSpec

public class CommonProcessMemorySpec<FM extends FlinkMemory>
extends Object
implements ProcessMemorySpec

Common memory components of Flink processes (e.g. JM or TM).

The process memory consists of the following components.

• Total Flink Memory
• JVM Metaspace
• JVM Overhead

Among all the components, We use the Total Process Memory to refer to all the memory components, while the Total Flink Memory refers to all the internal components except JVM Metaspace and JVM Overhead. The internal components of Total Flink Memory, represented by FlinkMemory, are specific to concrete Flink process (e.g. JM or TM).

The relationships of process memory components are shown below.

               ┌ ─ ─ Total Process Memory  ─ ─ ┐
               │┌─────────────────────────────┐│
                │      Total Flink Memory     │
               │└─────────────────────────────┘│
               │┌─────────────────────────────┐│
                │        JVM Metaspace        │
               │└─────────────────────────────┘│
                ┌─────────────────────────────┐
               ││        JVM Overhead         ││
                └─────────────────────────────┘
               └ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┘
 

See Also:

• Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CommonProcessMemorySpec(FM flinkMemory, JvmMetaspaceAndOverhead jvmMetaspaceAndOverhead)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
FM	getFlinkMemory()
org.apache.flink.configuration.MemorySize	getJvmDirectMemorySize()
org.apache.flink.configuration.MemorySize	getJvmHeapMemorySize()
JvmMetaspaceAndOverhead	getJvmMetaspaceAndOverhead()
org.apache.flink.configuration.MemorySize	getJvmMetaspaceSize()
org.apache.flink.configuration.MemorySize	getJvmOverheadSize()
org.apache.flink.configuration.MemorySize	getTotalFlinkMemorySize()
org.apache.flink.configuration.MemorySize	getTotalProcessMemorySize()
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CommonProcessMemorySpec

protected CommonProcessMemorySpec(FM flinkMemory,
 JvmMetaspaceAndOverhead jvmMetaspaceAndOverhead)

Method Details

getFlinkMemory

public FM getFlinkMemory()

getJvmMetaspaceAndOverhead

public JvmMetaspaceAndOverhead getJvmMetaspaceAndOverhead()

getJvmHeapMemorySize

public org.apache.flink.configuration.MemorySize getJvmHeapMemorySize()

Specified by:

getJvmHeapMemorySize in interface ProcessMemorySpec

getJvmDirectMemorySize

public org.apache.flink.configuration.MemorySize getJvmDirectMemorySize()

Specified by:

getJvmDirectMemorySize in interface ProcessMemorySpec

getJvmMetaspaceSize

public org.apache.flink.configuration.MemorySize getJvmMetaspaceSize()

Specified by:

getJvmMetaspaceSize in interface ProcessMemorySpec

getJvmOverheadSize

public org.apache.flink.configuration.MemorySize getJvmOverheadSize()

Specified by:

getJvmOverheadSize in interface ProcessMemorySpec

getTotalFlinkMemorySize

public org.apache.flink.configuration.MemorySize getTotalFlinkMemorySize()

Specified by:

getTotalFlinkMemorySize in interface ProcessMemorySpec

getTotalProcessMemorySize

public org.apache.flink.configuration.MemorySize getTotalProcessMemorySize()

Specified by:

getTotalProcessMemorySize in interface ProcessMemorySpec

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object