base/sys_info.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef BASE_SYS_INFO_H_
   6 #define BASE_SYS_INFO_H_
   7
   8 #include <map>
   9 #include <string>
  10
  11 #include "base/base_export.h"
  12 #include "base/basictypes.h"
  13 #include "base/files/file_path.h"
  14 #include "base/time/time.h"
  15 #include "build/build_config.h"
  16
  17 namespace base {
  18
  19 class BASE_EXPORT SysInfo {
  20  public:
  21   // Return the number of logical processors/cores on the current machine.
  22   static int NumberOfProcessors();
  23
  24   // Return the number of bytes of physical memory on the current machine.
  25   static int64 AmountOfPhysicalMemory();
  26
  27   // Return the number of bytes of current available physical memory on the
  28   // machine.
  29   static int64 AmountOfAvailablePhysicalMemory();
  30
  31   // Return the number of bytes of virtual memory of this process. A return
  32   // value of zero means that there is no limit on the available virtual
  33   // memory.
  34   static int64 AmountOfVirtualMemory();
  35
  36   // Return the number of megabytes of physical memory on the current machine.
  37   static int AmountOfPhysicalMemoryMB() {
  38     return static_cast<int>(AmountOfPhysicalMemory() / 1024 / 1024);
  39   }
  40
  41   // Return the number of megabytes of available virtual memory, or zero if it
  42   // is unlimited.
  43   static int AmountOfVirtualMemoryMB() {
  44     return static_cast<int>(AmountOfVirtualMemory() / 1024 / 1024);
  45   }
  46
  47   // Return the available disk space in bytes on the volume containing |path|,
  48   // or -1 on failure.
  49   static int64 AmountOfFreeDiskSpace(const FilePath& path);
  50
  51   // Returns system uptime in milliseconds.
  52   static int64 Uptime();
  53
  54   // Returns a descriptive string for the current machine model or an empty
  55   // string if the machine model is unknown or an error occured.
  56   // e.g. "MacPro1,1" on Mac, or "Nexus 5" on Android. Only implemented on OS X,
  57   // Android, and Chrome OS. This returns an empty string on other platforms.
  58   static std::string HardwareModelName();
  59
  60   // Returns the name of the host operating system.
  61   static std::string OperatingSystemName();
  62
  63   // Returns the version of the host operating system.
  64   static std::string OperatingSystemVersion();
  65
  66   // Retrieves detailed numeric values for the OS version.
  67   // TODO(port): Implement a Linux version of this method and enable the
  68   // corresponding unit test.
  69   // DON'T USE THIS ON THE MAC OR WINDOWS to determine the current OS release
  70   // for OS version-specific feature checks and workarounds. If you must use
  71   // an OS version check instead of a feature check, use the base::mac::IsOS*
  72   // family from base/mac/mac_util.h, or base::win::GetVersion from
  73   // base/win/windows_version.h.
  74   static void OperatingSystemVersionNumbers(int32* major_version,
  75                                             int32* minor_version,
  76                                             int32* bugfix_version);
  77
  78   // Returns the architecture of the running operating system.
  79   // Exact return value may differ across platforms.
  80   // e.g. a 32-bit x86 kernel on a 64-bit capable CPU will return "x86",
  81   //      whereas a x86-64 kernel on the same CPU will return "x86_64"
  82   static std::string OperatingSystemArchitecture();
  83
  84   // Avoid using this. Use base/cpu.h to get information about the CPU instead.
  85   // http://crbug.com/148884
  86   // Returns the CPU model name of the system. If it can not be figured out,
  87   // an empty string is returned.
  88   static std::string CPUModelName();
  89
  90   // Return the smallest amount of memory (in bytes) which the VM system will
  91   // allocate.
  92   static size_t VMAllocationGranularity();
  93
  94 #if defined(OS_POSIX) && !defined(OS_MACOSX)
  95   // Returns the maximum SysV shared memory segment size, or zero if there is no
  96   // limit.
  97   static uint64 MaxSharedMemorySize();
  98 #endif  // defined(OS_POSIX) && !defined(OS_MACOSX)
  99
 100 #if defined(OS_CHROMEOS)
 101   typedef std::map<std::string, std::string> LsbReleaseMap;
 102
 103   // Returns the contents of /etc/lsb-release as a map.
 104   static const LsbReleaseMap& GetLsbReleaseMap();
 105
 106   // If |key| is present in the LsbReleaseMap, sets |value| and returns true.
 107   static bool GetLsbReleaseValue(const std::string& key, std::string* value);
 108
 109   // Convenience function for GetLsbReleaseValue("CHROMEOS_RELEASE_BOARD",...).
 110   // Returns "unknown" if CHROMEOS_RELEASE_BOARD is not set.
 111   static std::string GetLsbReleaseBoard();
 112
 113   // Returns the creation time of /etc/lsb-release. (Used to get the date and
 114   // time of the Chrome OS build).
 115   static Time GetLsbReleaseTime();
 116
 117   // Returns true when actually running in a Chrome OS environment.
 118   static bool IsRunningOnChromeOS();
 119
 120   // Test method to force re-parsing of lsb-release.
 121   static void SetChromeOSVersionInfoForTest(const std::string& lsb_release,
 122                                             const Time& lsb_release_time);
 123 #endif  // defined(OS_CHROMEOS)
 124
 125 #if defined(OS_ANDROID)
 126   // Returns the Android build's codename.
 127   static std::string GetAndroidBuildCodename();
 128
 129   // Returns the Android build ID.
 130   static std::string GetAndroidBuildID();
 131
 132   static int DalvikHeapSizeMB();
 133   static int DalvikHeapGrowthLimitMB();
 134 #endif  // defined(OS_ANDROID)
 135
 136   // Returns true if this is a low-end device.
 137   // Low-end device refers to devices having less than 512M memory in the
 138   // current implementation.
 139   static bool IsLowEndDevice();
 140 };
 141
 142 }  // namespace base
 143
 144 #endif  // BASE_SYS_INFO_H_