org.apache.flink.runtime.clusterframework.types

Class ResourceProfile

java.lang.Object

org.apache.flink.runtime.clusterframework.types.ResourceProfile

All Implemented Interfaces:

Serializable, Comparable<ResourceProfile>

public class ResourceProfile
extends Object
implements Serializable, Comparable<ResourceProfile>

Describe the immutable resource profile of the slot, either when requiring or offering it. The profile can be checked whether it can match another profile's requirement, and furthermore we may calculate a matching score to decide which profile we should choose when we have lots of candidate slots. It should be generated from ResourceSpec with the input and output memory calculated in JobMaster.

Resource Profiles have a total ordering, defined by comparing these fields in sequence:

1. Memory Size
2. CPU cores
3. Extended resources

The extended resources are compared ordered by the resource names.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ResourceProfile	ANY ResourceProfile which matches any other ResourceProfile.
static ResourceProfile	UNKNOWN

Constructor Summary

Constructors

Constructor and Description
ResourceProfile(double cpuCores, int heapMemoryInMB) Creates a new simple ResourceProfile used for testing.
ResourceProfile(double cpuCores, int heapMemoryInMB, int directMemoryInMB, int nativeMemoryInMB, int networkMemoryInMB, Map<String,org.apache.flink.api.common.resources.Resource> extendedResources) Creates a new ResourceProfile.
ResourceProfile(ResourceProfile other) Creates a copy of the given ResourceProfile.

Method Summary

Modifier and Type	Method and Description
int	compareTo(ResourceProfile other)
boolean	equals(Object obj)
double	getCpuCores() Get the cpu cores needed.
int	getDirectMemoryInMB() Get the direct memory needed in MB.
Map<String,org.apache.flink.api.common.resources.Resource>	getExtendedResources() Get the extended resources.
int	getHeapMemoryInMB() Get the heap memory needed in MB.
int	getMemoryInMB() Get the total memory needed in MB.
int	getNativeMemoryInMB() Get the native memory needed in MB.
int	getNetworkMemoryInMB() Get the memory needed for task to communicate with its upstreams and downstreams in MB.
int	getOperatorsMemoryInMB() Get the memory the operators needed in MB.
int	hashCode()
boolean	isMatching(ResourceProfile required) Check whether required resource profile can be matched.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN

public static final ResourceProfile UNKNOWN

ANY

public static final ResourceProfile ANY

ResourceProfile which matches any other ResourceProfile.

Constructor Detail

ResourceProfile

public ResourceProfile(double cpuCores,
                       int heapMemoryInMB,
                       int directMemoryInMB,
                       int nativeMemoryInMB,
                       int networkMemoryInMB,
                       Map<String,org.apache.flink.api.common.resources.Resource> extendedResources)

Creates a new ResourceProfile.

Parameters:

cpuCores - The number of CPU cores (possibly fractional, i.e., 0.2 cores)

heapMemoryInMB - The size of the heap memory, in megabytes.

directMemoryInMB - The size of the direct memory, in megabytes.

nativeMemoryInMB - The size of the native memory, in megabytes.

networkMemoryInMB - The size of the memory for input and output, in megabytes.

extendedResources - The extended resources such as GPU and FPGA

ResourceProfile

public ResourceProfile(double cpuCores,
                       int heapMemoryInMB)

Creates a new simple ResourceProfile used for testing.

Parameters:

cpuCores - The number of CPU cores (possibly fractional, i.e., 0.2 cores)

heapMemoryInMB - The size of the heap memory, in megabytes.

ResourceProfile

public ResourceProfile(ResourceProfile other)

Creates a copy of the given ResourceProfile.

Parameters:

other - The ResourceProfile to copy.

Method Detail

getCpuCores

public double getCpuCores()

Get the cpu cores needed.

Returns:

The cpu cores, 1.0 means a full cpu thread

getHeapMemoryInMB

public int getHeapMemoryInMB()

Get the heap memory needed in MB.

Returns:

The heap memory in MB

getDirectMemoryInMB

public int getDirectMemoryInMB()

Get the direct memory needed in MB.

Returns:

The direct memory in MB

getNativeMemoryInMB

public int getNativeMemoryInMB()

Get the native memory needed in MB.

Returns:

The native memory in MB

getNetworkMemoryInMB

public int getNetworkMemoryInMB()

Get the memory needed for task to communicate with its upstreams and downstreams in MB.

Returns:

The network memory in MB

getMemoryInMB

public int getMemoryInMB()

Get the total memory needed in MB.

Returns:

The total memory in MB

getOperatorsMemoryInMB

public int getOperatorsMemoryInMB()

Get the memory the operators needed in MB.

Returns:

The operator memory in MB

getExtendedResources

public Map<String,org.apache.flink.api.common.resources.Resource> getExtendedResources()

Get the extended resources.

Returns:

The extended resources

isMatching

public boolean isMatching(ResourceProfile required)

Check whether required resource profile can be matched.

Parameters:

required - the required resource profile

Returns:

true if the requirement is matched, otherwise false

compareTo

public int compareTo(@Nonnull
                     ResourceProfile other)

Specified by:

compareTo in interface Comparable<ResourceProfile>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object