1c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Copyright (c) 2009 The Chromium Authors. All rights reserved. 2c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Use of this source code is governed by a BSD-style license that can be 3c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// found in the LICENSE file. 4c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 5c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#ifndef CHROME_BROWSER_PROCESS_INFO_SNAPSHOT_H_ 6c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#define CHROME_BROWSER_PROCESS_INFO_SNAPSHOT_H_ 73345a6884c488ff3a535c2c9acdd33d74b37e311Iain Merrick#pragma once 8c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 9c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#include <sys/types.h> 10c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 11c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#include <map> 12c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#include <string> 13c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#include <vector> 14c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 15c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#include "base/process_util.h" 16c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 17c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// A class which captures process information at a given point in time when its 18c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// |Sample()| method is called. This information can then be probed by PID. 19c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// |Sample()| may take a while to complete, so if calling from the browser 2072a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen// process, only do so from the file thread. 21c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// TODO(viettrungluu): This is currently only implemented and used on Mac, so 22c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// things are very Mac-specific. If this is ever implemented for other 23c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// platforms, we should subclass and add opaqueness (probably |ProcInfoEntry| 24c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// should be considered opaque). 25c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdochclass ProcessInfoSnapshot { 26c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch public: 27c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch ProcessInfoSnapshot(); 28c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch ~ProcessInfoSnapshot(); 29c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 30c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Maximum size of lists of PIDs which this class will accept; used in 31c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // |Sample()| below. 32c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch static const size_t kMaxPidListSize; 33c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 3472a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen // Capture a snapshot of process memory information for the 35c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // given list of PIDs. Call only from the file thread. 36c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // |pid_list| - list of |ProcessId|s on which to capture information; must 37c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // have no more than |kMaxPidListSize| (above) entries, 38c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // returns - |true| if okay, |false| on error. 39c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch bool Sample(std::vector<base::ProcessId> pid_list); 40c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 41c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Reset all statistics (deallocating any memory allocated). 42c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch void Reset(); 43c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 44c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Our basic structure for storing information about a process (the names are 45c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // mostly self-explanatory). Note that |command| may not actually reflect the 46c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // actual executable name; never trust it absolutely, and only take it 47c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // half-seriously when it begins with '/'. 48c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch struct ProcInfoEntry { 49c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch base::ProcessId pid; 50c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch base::ProcessId ppid; 51c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch uid_t uid; 52c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch uid_t euid; 5372a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen // Explicitly use uint64_t instead of size_t in case this code is running 5472a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen // in a 32 bit process and the target process is 64 bit. 5572a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen uint64_t rss; 5672a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen uint64_t rshrd; 5772a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen uint64_t rprvt; 5872a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen uint64_t vsize; 59c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch std::string command; 6072a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen 6172a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen ProcInfoEntry() 6272a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen : pid(0), 6372a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen ppid(0), 6472a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen uid(0), 6572a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen euid(0), 6672a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen rss(0), 6772a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen rshrd(0), 6872a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen rprvt(0), 6972a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen vsize(0) { 7072a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen } 71c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch }; 72c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 73c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Get process information for a given PID. 74c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // |pid| - self-explanatory. 75c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // |proc_info| - place to put the process information. 76c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // returns - |true| if okay, |false| on error (including PID not found). 77c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch bool GetProcInfo(int pid, 78c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch ProcInfoEntry* proc_info) const; 79c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 80c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Fills a |CommittedKBytes| with both resident and paged memory usage, as per 81c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // its definition (or as close as we can manage). In the current (Mac) 82c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // implementation, we map: 83c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // vsize --> comm_priv, 84c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // 0 --> comm_mapped, 85c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // 0 --> comm_image; 86c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // in about:memory: virtual:private = comm_priv, 87c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // virtual:mapped = comm_mapped. 88c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // TODO(viettrungluu): Doing such a mapping is kind of ugly. 89c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // |pid| - self-explanatory. 90c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // |usage| - pointer to |CommittedBytes| to fill; zero-ed on error. 91c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // returns - |true| on success, |false| on error (including PID not found). 92c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch bool GetCommittedKBytesOfPID(int pid, 93c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch base::CommittedKBytes* usage) const; 94c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 95c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // Fills a |WorkingSetKBytes| containing resident private and shared memory, 96c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // as per its definition (or as close as we can manage). In the current (Mac) 97c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // implementation, we map: 9872a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen // rprvt --> ws_priv, 99c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // rss --> ws_shareable, 10072a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen // rshrd --> ws_shared; 101c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // in about:memory: res:private = ws_priv + ws_shareable - ws_shared, 102c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // res:shared = ws_shared / num_procs, 103c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // res:total = res:private + res:shared. 104c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // TODO(viettrungluu): Doing such a mapping is kind of ugly. 105c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // |pid| - self-explanatory. 106c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // |ws_usage| - pointer to |WorkingSetKBytes| to fill; zero-ed on error. 107c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // returns - |true| on success, |false| on error (including PID not found). 108c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch bool GetWorkingSetKBytesOfPID(int pid, 109c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch base::WorkingSetKBytes* ws_usage) const; 110c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 111c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // TODO(viettrungluu): Maybe we should also have the following (again, for 112c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // "compatibility"): 113c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // size_t GetWorkingSetSizeOfPID(int pid) const; 114c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // size_t GetPeakWorkingSetSizeOfPID(int pid) const; 115c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // size_t GetPrivateBytesOfPID(int pid) const; 116c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 117c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch private: 118c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch // map from |int| (PID) to |ProcInfoEntry| 119c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch std::map<int,ProcInfoEntry> proc_info_entries_; 120c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch}; 121c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch 122c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch#endif // CHROME_BROWSER_PROCESS_INFO_SNAPSHOT_H_ 123