PhutilSystem.php
View Options

	<?php

	/**
	* Interact with the operating system.
	*
	* @task stdio Interacting with Standard I/O
	* @task memory Interacting with System Memory
	*/
	final class PhutilSystem extends Phobject {

	private static $stdin = false;
	private static $stderr = false;
	private static $stdout = false;

	/**
	* @task stdio
	*/
	public static function getStdinHandle() {
	if (self::$stdin === false) {
	self::$stdin = self::getStdioHandle('STDIN');
	}

	return self::$stdin;
	}

	/**
	* @task stdio
	*/
	public static function getStdoutHandle() {
	if (self::$stdout === false) {
	self::$stdout = self::getStdioHandle('STDOUT');
	}

	return self::$stdout;
	}

	/**
	* @task stdio
	*/
	public static function getStderrHandle() {
	if (self::$stderr === false) {
	self::$stderr = self::getStdioHandle('STDERR');
	}

	return self::$stderr;
	}

	/**
	* @task stdio
	*/
	public static function writeStderr($message) {
	$stderr = self::getStderrHandle();

	if ($stderr === null) {
	return;
	}

	$message = phutil_string_cast($message);
	@fwrite($stderr, $message);
	}


	/**
	* @task stdio
	*/
	private static function getStdioHandle($ref) {
	if (defined($ref)) {
	return constant($ref);
	}

	return null;
	}

	/**
	* Get information about total and free memory on the system.
	*
	* Because "free memory" is a murky concept, the interpretation of the values
	* returned from this method will vary from system to system and the numbers
	* themselves may be only roughly accurate.
	*
	* @return map<string, wild> Dictionary of memory information.
	* @task memory
	*/
	public static function getSystemMemoryInformation() {
	$meminfo_path = '/proc/meminfo';
	if (Filesystem::pathExists($meminfo_path)) {
	$meminfo_data = Filesystem::readFile($meminfo_path);
	return self::parseMemInfo($meminfo_data);
	} else if (Filesystem::binaryExists('vm_stat')) {
	list($vm_stat_stdout) = execx('vm_stat');
	return self::parseVMStat($vm_stat_stdout);
	} else {
	throw new Exception(
	pht(
	'Unable to access %s or `%s` on this system to '.
	'get system memory information.',
	'/proc/meminfo',
	'vm_stat'));
	}
	}


	/**
	* Parse the output of `/proc/meminfo`.
	*
	* See @{method:getSystemMemoryInformation}. This method is used to get memory
	* information on Linux.
	*
	* @param string Raw `/proc/meminfo`.
	* @return map<string, wild> Parsed memory information.
	* @task memory
	*/
	public static function parseMemInfo($data) {
	$data = phutil_split_lines($data);

	$map = array();
	foreach ($data as $line) {
	list($key, $value) = explode(':', $line, 2);
	$key = trim($key);
	$value = trim($value);

	$matches = null;
	if (preg_match('/^(\d+) kB\z/', $value, $matches)) {
	$value = (int)$matches[1] * 1024;
	}

	$map[$key] = $value;
	}

	$expect = array(
	'MemTotal',
	'MemFree',
	'Buffers',
	'Cached',
	);
	foreach ($expect as $key) {
	if (!array_key_exists($key, $map)) {
	throw new Exception(
	pht(
	'Expected to find "%s" in "%s" output, but did not.',
	$key,
	'/proc/meminfo'));
	}
	}

	$total = $map['MemTotal'];
	$free = $map['MemFree'] + $map['Buffers'] + $map['Cached'];

	return array(
	'total' => $total,
	'free' => $free,
	);
	}


	/**
	* Parse the output of `vm_stat`.
	*
	* See @{method:getSystemMemoryInformation}. This method is used to get memory
	* information on Mac OS X.
	*
	* @param string Raw `vm_stat` output.
	* @return map<string, wild> Parsed memory information.
	* @task memory
	*/
	public static function parseVMStat($data) {
	$data = phutil_split_lines($data);

	$page_size = null;
	$map = array();

	foreach ($data as $line) {
	list($key, $value) = explode(':', $line, 2);
	$key = trim($key);
	$value = trim($value);

	$matches = null;
	if (preg_match('/page size of (\d+) bytes/', $value, $matches)) {
	$page_size = (int)$matches[1];
	continue;
	}

	$value = trim($value, '.');
	$map[$key] = $value;
	}

	if (!$page_size) {
	throw new Exception(
	pht(
	'Expected to find "%s" in `%s` output, but did not.',
	'page size',
	'vm_stat'));
	}

	$expect = array(
	'Pages free',
	'Pages active',
	'Pages inactive',
	'Pages wired down',
	);
	foreach ($expect as $key) {
	if (!array_key_exists($key, $map)) {
	throw new Exception(
	pht(
	'Expected to find "%s" in `%s` output, but did not.',
	$key,
	'vm_stat'));
	}
	}

	// NOTE: This calculation probably isn't quite right. In particular,
	// the numbers don't exactly add up, and "Pages inactive" includes a
	// bunch of disk cache. So these numbers aren't totally reliable and they
	// aren't directly comparable to the /proc/meminfo numbers.

	$free = $map['Pages free'];
	$active = $map['Pages active'];
	$inactive = $map['Pages inactive'];
	$wired = $map['Pages wired down'];

	return array(
	'total' => ($free + $active + $inactive + $wired) * $page_size,
	'free' => ($free) * $page_size,
	);
	}

	}

File Metadata

Mime Type: text/x-php
Expires: Sun, Feb 23, 10:32 (1 d, 14 h ago)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 1115737
Default Alt Text: PhutilSystem.php (5 KB)

PhutilSystem.php
No OneTemporary
Actions

PhutilSystem.php
View Options

File Metadata

Event Timeline

PhutilSystem.phpNo OneTemporaryActions

PhutilSystem.phpView Options

File Metadata

Event Timeline

PhutilSystem.php
No OneTemporary
Actions

PhutilSystem.php
View Options