NAME

       ipmctl-show-memory-resources - Shows DCPMM and DDR memory allocation

SYNOPSIS

       ipmctl show [OPTIONS] -memoryresources

DESCRIPTION

       Shows DCPMM and DDR memory allocation information for this platform.

OPTIONS

       -h, -help
           Displays help for the command.

       -ddrt
           Used to specify DDRT as the desired transport protocol for the current invocation of
           ipmctl.

       -smbus
           Used to specify SMBUS as the desired transport protocol for the current invocation of
           ipmctl.

           Note
           The -ddrt and -smbus options are mutually exclusive and may not be used together.

       -o (text|nvmxml), -output (text|nvmxml)
           Changes the output format. One of: "text" (default) or "nvmxml".

       -u (B|MB|MiB|GB|GiB|TB| TiB), -units (B|MB|MiB|GB|GiB|TB| TiB)
           Changes the units that capacities are displayed in for this command. One of: bytes
           (B), megabytes (MB), mebibytes (MiB), gigabytes (GB), gibibytes (GiB), terabytes (TB)
           or tebibytes (TiB).

EXAMPLES

       Shows the DCPMM and DDR memory allocation.

       ipmctl show -memoryresources

LIMITATIONS

       In order to successfully execute this command:

       •   The caller must have the appropriate privileges.

       •   The specified DCPMM(s) must be manageable by the host software.

RETURN DATA

       Returns a table containing the attributes listed below.

           Note
           Capacities from unmanageable DCPMMs are not included in the following aggregated
           totals.

       Volatile DDR Capacity
           Total DDR capacity that is used as volatile memory.

       Volatile DCPMM Capacity
           Total DCPMM capacity that is used as volatile memory.

       Total Volatile Capacity
           Total DDR and DCPMM capacity that is used as volatile memory.

       AppDirect DCPMM Capacity
           Total DCPMM capacity used as persistent memory.

       Total AppDirect Capacity
           Total DDR and DCPMM capacity used as persistent memory.

       Cache DDR Capacity
           Total DDR capacity used as a cache for DCPMMs.

       Total Cache Capacity
           Total DDR capacity used as a cache for DCPMMs.

       Inaccessible DDR Capacity
           Total DDR capacity that is inaccessible. This cell will not be populated.

       Inaccessible DCPMM Capacity
           Total DCPMM capacity that is inaccessible due to any of:

           •   Platform configuration prevents accessing this capacity. e.g. MemoryCapacity is
               configured but MemoryMode is not enabled by platform FW (current Memory Mode is
               1LM).

           •   Capacity is inaccessible because it is not mapped into the system physical address
               (SPA) space. This is usually due to platform firmware memory alignment
               requirements.

           •   Persistent capacity that is reserved. This capacity is the persistent memory
               partition capacity (rounded down for alignment) less any App Direct capacity.
               Reserved capacity typically results from a Memory Allocation Goal request that
               specified the Reserved property. This capacity is not mapped to system physical
               address (SPA) space.

           •   Capacity that is unusable because it has not been configured.

           •   DCPMM configured capacity but SKU prevents usage. e.g. AppDirectCapcity but DCPMM
               SKU is MemoryMode only.

       Total Inaccessible Capacity
           Total capacity of DDR and DCPMM that is inaccessible.

       Physical DDR Capacity
           Total physical DDR capacity populated on the platform.

       Physical DCPMM Capacity
           Total physical DCPMM capacity populated on the plaform.

       Total Physical Capacity
           Total physical capacity populated on the platform.

DETAILS

       DCPMMs are partitioned into Memory and Persistent partitions. Memory partitions are
       aligned on a 1 GiB boundary by ipmctl with the Persistent partition consuming the
       remaining capacity. Any capacity that falls outside the Memory and Persistent partitions
       is InaccessibleCapacity and is not useable. If the DCPMM is configured for 100% Memory
       Mode, then the Memory partition consumes all of the capacity and the Persistent partition
       has none.

       The mode determines how the DDR capacities are allocated. In 1LM and AppDirect, all DDR
       capacity is used as additional volatile memory. In MemoryMode, all DDR capacity that the
       CPU will support is used as a cache for the DCPMM.

       Platform firmware alignment restrictions may result in some capacity from the Memory and
       Persistent partitions not mapped to system physical address (SPA) space. This memory is
       considered InaccessibleCapacity and is not usable.

       The definitions and calculations that follow intend to describe how each of the values are
       determined.

       Definitions:

       Intel NVDIMM Current Config
           See Intel® NVM Dimm Management Software-Firmware Interface Specification for details.

       DCPMM DIMM Partition Info
           DIMM partition info provided by DCPMM firmware. See Intel® Optane™ DC Persistent
           Memory Module Firmware Interface Specification for details.

       DCPMM Physical Capacity (DCPC)
           Raw capacity (total usable) reported by DCPMM DIMM Partition Info

       DCPMM Memory Partition Capacity (DCMPC)
           Volatile capacity reported by DCPMM DIMM Partition Info

       DCPMM Persistent Partition Capacity (DCPPC)
           Persistent capacity reported by DCPMM DIMM Partition Info

       DCPMM Volatile Memory Capacity (DCVMC)
           Usable voliatile memory capacity as reported by platform FW via Intel NVDIMM Current
           Config→Volatile Memory Size Mapped into SPA field

       DCPMM Persistent Memory Capacity (DCPMC)
           Usable persistent memory capacity as reported by platform FW via Intel NVDIMM Current
           Config→Persistent Memory Size Mapped into SPA field

       DDR Total Capacity (DDRTC)
           Total amount of memory available for use on the populated DDRs

       Calculations:

       if (CurrentMode == 1LM) then
         DDRCacheCapacity = 0
         DDRVolatileCapacity = DDRTC
       else if (CurrentMode == 2LM) then
         DDRCacheCapacity = DDRTC
         DDRVolatileCapacity = 0

       TotalVolatileCapacity = DCVMC + DDRVolatileCapacity

       InaccessibleCapacity = DCPC - DCPMC
        if (CurrentMode != 1LM) then
         InaccessibleCapacity -= DCVMC (rounded down for alignment)