15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2009 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef CHROME_BROWSER_PROCESS_INFO_SNAPSHOT_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define CHROME_BROWSER_PROCESS_INFO_SNAPSHOT_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <sys/types.h> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <map> 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <vector> 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 14bbcdd45c55eb7c4641ab97aef9889b0fc828e7d3Ben Murdoch#include "base/process/process_handle.h" 15bbcdd45c55eb7c4641ab97aef9889b0fc828e7d3Ben Murdoch#include "base/process/process_metrics.h" 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// A class which captures process information at a given point in time when its 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// |Sample()| method is called. This information can then be probed by PID. 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// |Sample()| may take a while to complete, so if calling from the browser 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// process, only do so from the file thread. 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// TODO(viettrungluu): This is currently only implemented and used on Mac, so 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// things are very Mac-specific. If this is ever implemented for other 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// platforms, we should subclass and add opaqueness (probably |ProcInfoEntry| 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// should be considered opaque). 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class ProcessInfoSnapshot { 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ProcessInfoSnapshot(); 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ~ProcessInfoSnapshot(); 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Maximum size of lists of PIDs which this class will accept; used in 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |Sample()| below. 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static const size_t kMaxPidListSize; 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Capture a snapshot of process memory information for the 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // given list of PIDs. Call only from the file thread. 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |pid_list| - list of |ProcessId|s on which to capture information; must 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // have no more than |kMaxPidListSize| (above) entries, 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // returns - |true| if okay, |false| on error. 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool Sample(std::vector<base::ProcessId> pid_list); 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Reset all statistics (deallocating any memory allocated). 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void Reset(); 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Our basic structure for storing information about a process (the names are 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // mostly self-explanatory). Note that |command| may not actually reflect the 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // actual executable name; never trust it absolutely, and only take it 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // half-seriously when it begins with '/'. 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct ProcInfoEntry { 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::ProcessId pid; 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::ProcessId ppid; 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uid_t uid; 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uid_t euid; 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Explicitly use uint64_t instead of size_t in case this code is running 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // in a 32 bit process and the target process is 64 bit. 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint64_t rss; 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint64_t rshrd; 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint64_t rprvt; 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint64_t vsize; 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string command; 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ProcInfoEntry(); 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Get process information for a given PID. 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |pid| - self-explanatory. 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |proc_info| - place to put the process information. 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // returns - |true| if okay, |false| on error (including PID not found). 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool GetProcInfo(int pid, 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ProcInfoEntry* proc_info) const; 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Fills a |CommittedKBytes| with both resident and paged memory usage, as per 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // its definition (or as close as we can manage). In the current (Mac) 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // implementation, we map: 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // vsize --> comm_priv, 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 0 --> comm_mapped, 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 0 --> comm_image; 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // in about:memory: virtual:private = comm_priv, 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // virtual:mapped = comm_mapped. 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // TODO(viettrungluu): Doing such a mapping is kind of ugly. 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |pid| - self-explanatory. 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |usage| - pointer to |CommittedBytes| to fill; zero-ed on error. 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // returns - |true| on success, |false| on error (including PID not found). 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool GetCommittedKBytesOfPID(int pid, 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::CommittedKBytes* usage) const; 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Fills a |WorkingSetKBytes| containing resident private and shared memory, 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // as per its definition (or as close as we can manage). In the current (Mac) 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // implementation, we map: 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // rprvt --> ws_priv, 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // rss --> ws_shareable, 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // rshrd --> ws_shared; 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // in about:memory: res:private = ws_priv + ws_shareable - ws_shared, 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // res:shared = ws_shared / num_procs, 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // res:total = res:private + res:shared. 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // TODO(viettrungluu): Doing such a mapping is kind of ugly. 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |pid| - self-explanatory. 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |ws_usage| - pointer to |WorkingSetKBytes| to fill; zero-ed on error. 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // returns - |true| on success, |false| on error (including PID not found). 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool GetWorkingSetKBytesOfPID(int pid, 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::WorkingSetKBytes* ws_usage) const; 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // TODO(viettrungluu): Maybe we should also have the following (again, for 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // "compatibility"): 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // size_t GetWorkingSetSizeOfPID(int pid) const; 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // size_t GetPeakWorkingSetSizeOfPID(int pid) const; 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // size_t GetPrivateBytesOfPID(int pid) const; 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // map from |int| (PID) to |ProcInfoEntry| 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::map<int,ProcInfoEntry> proc_info_entries_; 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // CHROME_BROWSER_PROCESS_INFO_SNAPSHOT_H_ 114