Memory Class Reference

Public Member Functions
	__construct (\Magento\Framework\Shell $shell)
	getRealMemoryUsage ()

Static Public Member Functions
static	convertToBytes ($number)
static	isMacOs ()

Data Fields
const	MEMORY_UNITS = 'BKMGTPE'

Protected Member Functions
	_getUnixProcessMemoryUsage ($pid)
	_getWinProcessMemoryUsage ($pid)

Static Protected Member Functions
static	_convertToNumber ($number)

Detailed Description

Definition at line 13 of file Memory.php.

Constructor & Destructor Documentation

__construct()

__construct

(

\Magento\Framework\Shell

$shell

)

Inject dependencies

Parameters

\Magento\Framework\Shell

$shell

Definition at line 33 of file Memory.php.

    {
        $this->_shell = $shell;
    }

Member Function Documentation

_convertToNumber()

static _convertToNumber (   $number )

staticprotected

Remove non-numeric characters in the string to cast it to a numeric value

Incoming number can be presented in arbitrary format that depends on locale. We don't possess locale information. So the best can be done is to treat number as an integer and eliminate delimiters. Method will not behave correctly with non-integer numbers for the following reason:

• if value has more than one delimiter, such as in French notation: "1 234,56" – then we can infer decimal part
• but the value has only one delimiter, such as "234,56", then it is impossible to know whether it is decimal separator or not. Only knowing the right format would allow this.

Parameters

$number

Returns

string

Exceptions

Definition at line 139 of file Memory.php.

    {
        preg_match_all('/(\D+)/', $number, $matches);
        if (count(array_unique($matches[0])) > 1) {
            throw new \InvalidArgumentException(
                "The number '{$number}' seems to have decimal part. Only integer numbers are supported."
            );
        }
        return preg_replace('/\D+/', '', $number);
    }

_getUnixProcessMemoryUsage()

_getUnixProcessMemoryUsage (   $pid )

protected

Retrieve the current process' memory usage using Unix command line interface

int $pid int Memory usage in bytes

Definition at line 67 of file Memory.php.

    {
        // RSS - resident set size, the non-swapped physical memory
        $command = 'ps --pid %s --format rss --no-headers';
        if ($this->isMacOS()) {
            $command = 'ps -p %s -o rss=';
        }
        $output = $this->_shell->execute($command, [$pid]);
        $result = $output . 'k';
        // kilobytes
        return self::convertToBytes($result);
    }

_getWinProcessMemoryUsage()

_getWinProcessMemoryUsage (   $pid )

protected

Retrieve the current process' memory usage using Windows command line interface

int $pid int Memory usage in bytes

Definition at line 87 of file Memory.php.

    {
        $output = $this->_shell->execute('tasklist.exe /fi %s /fo CSV /nh', ["PID eq {$pid}"]);

        $arr = str_getcsv($output);
        $memory = $arr[4];
        return self::convertToBytes($memory);
    }

convertToBytes()

static convertToBytes (   $number )

static

Convert a number optionally followed by the unit symbol (B, K, M, G, etc.) to bytes

Parameters

string

$number

String representation of a number

Returns

int

Exceptions

Definition at line 104 of file Memory.php.

    {
        if (!preg_match('/^(.*\d)\h*(\D)$/', $number, $matches)) {
            throw new \InvalidArgumentException("Number format '{$number}' is not recognized.");
        }
        $unitSymbol = strtoupper($matches[2]);
        if (false === strpos(self::MEMORY_UNITS, $unitSymbol)) {
            throw new \InvalidArgumentException("The number '{$number}' has an unrecognized unit: '{$unitSymbol}'.");
        }
        $result = self::_convertToNumber($matches[1]);
        $pow = $unitSymbol ? strpos(self::MEMORY_UNITS, $unitSymbol) : 0;
        $is32Bit = PHP_INT_SIZE == 4;
        if ($is32Bit && $pow >= 4) {
            throw new \OutOfBoundsException("A 32-bit system is unable to process such a number.");
        }
        if ($unitSymbol) {
            $result *= pow(1024, $pow);
        }
        return (int)$result;
    }

getRealMemoryUsage()

getRealMemoryUsage

(

)

Retrieve the effective memory usage of the current process

memory_get_usage() cannot be used because of the bug int Memory usage in bytes

Definition at line 46 of file Memory.php.

    {
        $pid = getmypid();
        try {
            // try to use the Windows command line
            // some ports of Unix commands on Windows, such as MinGW, have limited capabilities and cannot be used
            $result = $this->_getWinProcessMemoryUsage($pid);
        } catch (\Magento\Framework\Exception\LocalizedException $e) {
            // fall back to the Unix command line
            $result = $this->_getUnixProcessMemoryUsage($pid);
        }
        return $result;
    }

isMacOs()

static isMacOs ( )

static

Whether the operating system belongs to the Mac family

boolean

Definition at line 156 of file Memory.php.

    {
        return strtoupper(PHP_OS) === 'DARWIN';
    }

Field Documentation

MEMORY_UNITS

const MEMORY_UNITS = 'BKMGTPE'

Prefixes to specify unit of measure for memory amount

Warning: it is important to maintain the exact order of letters in this literal, as it is used to convert string with units to bytes

Definition at line 21 of file Memory.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/magento2-base/dev/tests/integration/framework/Magento/TestFramework/Helper/Memory.php