// Copyright (c) 2013 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
// This file contains routines for gathering resource statistics for processes
// running on the system.
#ifndef BASE_PROCESS_PROCESS_METRICS_H_
#define BASE_PROCESS_PROCESS_METRICS_H_
#include <string>
#include "base/base_export.h"
#include "base/basictypes.h"
#include "base/gtest_prod_util.h"
#include "base/process/process_handle.h"
#include "base/time/time.h"
#include "base/values.h"
#if defined(OS_MACOSX)
#include <mach/mach.h>
#endif
namespace base {
#if defined(OS_WIN)
struct IoCounters : public IO_COUNTERS {
};
#elif defined(OS_POSIX)
struct IoCounters {
uint64_t ReadOperationCount;
uint64_t WriteOperationCount;
uint64_t OtherOperationCount;
uint64_t ReadTransferCount;
uint64_t WriteTransferCount;
uint64_t OtherTransferCount;
};
#endif
// Working Set (resident) memory usage broken down by
//
// On Windows:
// priv (private): These pages (kbytes) cannot be shared with any other process.
// shareable: These pages (kbytes) can be shared with other processes under
// the right circumstances.
// shared : These pages (kbytes) are currently shared with at least one
// other process.
//
// On Linux:
// priv: Pages mapped only by this process.
// shared: PSS or 0 if the kernel doesn't support this.
// shareable: 0
// On ChromeOS:
// priv: Pages mapped only by this process.
// shared: PSS or 0 if the kernel doesn't support this.
// shareable: 0
// swapped Pages swapped out to zram.
//
// On OS X: TODO(thakis): Revise.
// priv: Memory.
// shared: 0
// shareable: 0
//
struct WorkingSetKBytes {
WorkingSetKBytes() : priv(0), shareable(0), shared(0) {}
size_t priv;
size_t shareable;
size_t shared;
#if defined(OS_CHROMEOS)
size_t swapped;
#endif
};
// Committed (resident + paged) memory usage broken down by
// private: These pages cannot be shared with any other process.
// mapped: These pages are mapped into the view of a section (backed by
// pagefile.sys)
// image: These pages are mapped into the view of an image section (backed by
// file system)
struct CommittedKBytes {
CommittedKBytes() : priv(0), mapped(0), image(0) {}
size_t priv;
size_t mapped;
size_t image;
};
// Free memory (Megabytes marked as free) in the 2G process address space.
// total : total amount in megabytes marked as free. Maximum value is 2048.
// largest : size of the largest contiguous amount of memory found. It is
// always smaller or equal to FreeMBytes::total.
// largest_ptr: starting address of the largest memory block.
struct FreeMBytes {
size_t total;
size_t largest;
void* largest_ptr;
};
// Convert a POSIX timeval to microseconds.
BASE_EXPORT int64 TimeValToMicroseconds(const struct timeval& tv);
// Provides performance metrics for a specified process (CPU usage, memory and
// IO counters). To use it, invoke CreateProcessMetrics() to get an instance
// for a specific process, then access the information with the different get
// methods.
class BASE_EXPORT ProcessMetrics {
public:
~ProcessMetrics();
// Creates a ProcessMetrics for the specified process.
// The caller owns the returned object.
#if !defined(OS_MACOSX) || defined(OS_IOS)
static ProcessMetrics* CreateProcessMetrics(ProcessHandle process);
#else
class PortProvider {
public:
virtual ~PortProvider() {}
// Should return the mach task for |process| if possible, or else
// |MACH_PORT_NULL|. Only processes that this returns tasks for will have
// metrics on OS X (except for the current process, which always gets
// metrics).
virtual mach_port_t TaskForPid(ProcessHandle process) const = 0;
};
// The port provider needs to outlive the ProcessMetrics object returned by
// this function. If NULL is passed as provider, the returned object
// only returns valid metrics if |process| is the current process.
static ProcessMetrics* CreateProcessMetrics(ProcessHandle process,
PortProvider* port_provider);
#endif // !defined(OS_MACOSX) || defined(OS_IOS)
// Returns the current space allocated for the pagefile, in bytes (these pages
// may or may not be in memory). On Linux, this returns the total virtual
// memory size.
size_t GetPagefileUsage() const;
// Returns the peak space allocated for the pagefile, in bytes.
size_t GetPeakPagefileUsage() const;
// Returns the current working set size, in bytes. On Linux, this returns
// the resident set size.
size_t GetWorkingSetSize() const;
// Returns the peak working set size, in bytes.
size_t GetPeakWorkingSetSize() const;
// Returns private and sharedusage, in bytes. Private bytes is the amount of
// memory currently allocated to a process that cannot be shared. Returns
// false on platform specific error conditions. Note: |private_bytes|
// returns 0 on unsupported OSes: prior to XP SP2.
bool GetMemoryBytes(size_t* private_bytes,
size_t* shared_bytes);
// Fills a CommittedKBytes with both resident and paged
// memory usage as per definition of CommittedBytes.
void GetCommittedKBytes(CommittedKBytes* usage) const;
// Fills a WorkingSetKBytes containing resident private and shared memory
// usage in bytes, as per definition of WorkingSetBytes.
bool GetWorkingSetKBytes(WorkingSetKBytes* ws_usage) const;
// Computes the current process available memory for allocation.
// It does a linear scan of the address space querying each memory region
// for its free (unallocated) status. It is useful for estimating the memory
// load and fragmentation.
bool CalculateFreeMemory(FreeMBytes* free) const;
// Returns the CPU usage in percent since the last time this method or
// GetPlatformIndependentCPUUsage() was called. The first time this method
// is called it returns 0 and will return the actual CPU info on subsequent
// calls. On Windows, the CPU usage value is for all CPUs. So if you have
// 2 CPUs and your process is using all the cycles of 1 CPU and not the other
// CPU, this method returns 50.
double GetCPUUsage();
// Returns the number of average idle cpu wakeups per second since the last
// call.
int GetIdleWakeupsPerSecond();
// Same as GetCPUUsage(), but will return consistent values on all platforms
// (cancelling the Windows exception mentioned above) by returning a value in
// the range of 0 to (100 * numCPUCores) everywhere.
double GetPlatformIndependentCPUUsage();
// Retrieves accounting information for all I/O operations performed by the
// process.
// If IO information is retrieved successfully, the function returns true
// and fills in the IO_COUNTERS passed in. The function returns false
// otherwise.
bool GetIOCounters(IoCounters* io_counters) const;
private:
#if !defined(OS_MACOSX) || defined(OS_IOS)
explicit ProcessMetrics(ProcessHandle process);
#else
ProcessMetrics(ProcessHandle process, PortProvider* port_provider);
#endif // !defined(OS_MACOSX) || defined(OS_IOS)
#if defined(OS_LINUX) || defined(OS_ANDROID)
bool GetWorkingSetKBytesStatm(WorkingSetKBytes* ws_usage) const;
#endif
#if defined(OS_CHROMEOS)
bool GetWorkingSetKBytesTotmaps(WorkingSetKBytes *ws_usage) const;
#endif
ProcessHandle process_;
int processor_count_;
// Used to store the previous times and CPU usage counts so we can
// compute the CPU usage between calls.
int64 last_cpu_time_;
int64 last_system_time_;
// Same thing for idle wakeups.
int64 last_idle_wakeups_time_;
int64 last_absolute_idle_wakeups_;
#if !defined(OS_IOS)
#if defined(OS_MACOSX)
// Queries the port provider if it's set.
mach_port_t TaskForPid(ProcessHandle process) const;
PortProvider* port_provider_;
#elif defined(OS_POSIX)
// Jiffie count at the last_cpu_time_ we updated.
int last_cpu_;
#endif // defined(OS_POSIX)
#endif // !defined(OS_IOS)
DISALLOW_COPY_AND_ASSIGN(ProcessMetrics);
};
// Returns the memory committed by the system in KBytes.
// Returns 0 if it can't compute the commit charge.
BASE_EXPORT size_t GetSystemCommitCharge();
#if defined(OS_POSIX)
// Returns the maximum number of file descriptors that can be open by a process
// at once. If the number is unavailable, a conservative best guess is returned.
size_t GetMaxFds();
#endif // defined(OS_POSIX)
#if defined(OS_LINUX) || defined(OS_ANDROID)
// Parse the data found in /proc/<pid>/stat and return the sum of the
// CPU-related ticks. Returns -1 on parse error.
// Exposed for testing.
BASE_EXPORT int ParseProcStatCPU(const std::string& input);
// Get the number of threads of |process| as available in /proc/<pid>/stat.
// This should be used with care as no synchronization with running threads is
// done. This is mostly useful to guarantee being single-threaded.
// Returns 0 on failure.
BASE_EXPORT int GetNumberOfThreads(ProcessHandle process);
// /proc/self/exe refers to the current executable.
BASE_EXPORT extern const char kProcSelfExe[];
// Data from /proc/meminfo about system-wide memory consumption.
// Values are in KB.
struct BASE_EXPORT SystemMemoryInfoKB {
SystemMemoryInfoKB();
// Serializes the platform specific fields to value.
scoped_ptr<Value> ToValue() const;
int total;
int free;
int buffers;
int cached;
int active_anon;
int inactive_anon;
int active_file;
int inactive_file;
int swap_total;
int swap_free;
int dirty;
// vmstats data.
int pswpin;
int pswpout;
int pgmajfault;
#ifdef OS_CHROMEOS
int shmem;
int slab;
// Gem data will be -1 if not supported.
int gem_objects;
long long gem_size;
#endif
};
// Parses a string containing the contents of /proc/meminfo
// returns true on success or false for a parsing error
BASE_EXPORT bool ParseProcMeminfo(const std::string& input,
SystemMemoryInfoKB* meminfo);
// Parses a string containing the contents of /proc/vmstat
// returns true on success or false for a parsing error
BASE_EXPORT bool ParseProcVmstat(const std::string& input,
SystemMemoryInfoKB* meminfo);
// Retrieves data from /proc/meminfo and /proc/vmstat
// about system-wide memory consumption.
// Fills in the provided |meminfo| structure. Returns true on success.
// Exposed for memory debugging widget.
BASE_EXPORT bool GetSystemMemoryInfo(SystemMemoryInfoKB* meminfo);
// Data from /proc/diskstats about system-wide disk I/O.
struct BASE_EXPORT SystemDiskInfo {
SystemDiskInfo();
// Serializes the platform specific fields to value.
scoped_ptr<Value> ToValue() const;
uint64 reads;
uint64 reads_merged;
uint64 sectors_read;
uint64 read_time;
uint64 writes;
uint64 writes_merged;
uint64 sectors_written;
uint64 write_time;
uint64 io;
uint64 io_time;
uint64 weighted_io_time;
};
// Checks whether the candidate string is a valid disk name, [sh]d[a-z]+
// for a generic disk or mmcblk[0-9]+ for the MMC case.
// Names of disk partitions (e.g. sda1) are not valid.
BASE_EXPORT bool IsValidDiskName(const std::string& candidate);
// Retrieves data from /proc/diskstats about system-wide disk I/O.
// Fills in the provided |diskinfo| structure. Returns true on success.
BASE_EXPORT bool GetSystemDiskInfo(SystemDiskInfo* diskinfo);
#endif // defined(OS_LINUX) || defined(OS_ANDROID)
#if defined(OS_CHROMEOS)
// Data from files in directory /sys/block/zram0 about ZRAM usage.
struct BASE_EXPORT SwapInfo {
SwapInfo()
: num_reads(0),
num_writes(0),
compr_data_size(0),
orig_data_size(0),
mem_used_total(0) {
}
// Serializes the platform specific fields to value.
scoped_ptr<Value> ToValue() const;
uint64 num_reads;
uint64 num_writes;
uint64 compr_data_size;
uint64 orig_data_size;
uint64 mem_used_total;
};
// In ChromeOS, reads files from /sys/block/zram0 that contain ZRAM usage data.
// Fills in the provided |swap_data| structure.
BASE_EXPORT void GetSwapInfo(SwapInfo* swap_info);
#endif // defined(OS_CHROMEOS)
// Collects and holds performance metrics for system memory and disk.
// Provides functionality to retrieve the data on various platforms and
// to serialize the stored data.
class SystemMetrics {
public:
SystemMetrics();
static SystemMetrics Sample();
// Serializes the system metrics to value.
scoped_ptr<Value> ToValue() const;
private:
FRIEND_TEST_ALL_PREFIXES(SystemMetricsTest, SystemMetrics);
size_t committed_memory_;
#if defined(OS_LINUX) || defined(OS_ANDROID)
SystemMemoryInfoKB memory_info_;
SystemDiskInfo disk_info_;
#endif
#if defined(OS_CHROMEOS)
SwapInfo swap_info_;
#endif
};
} // namespace base
#endif // BASE_PROCESS_PROCESS_METRICS_H_