blob: fbfdd0f587ca9f9db263f9747e4a7876b647026b [file] [log] [blame]
// Copyright 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.
#include "chromeos/system/statistics_provider.h"
#include <memory>
#include <vector>
#include "base/bind.h"
#include "base/command_line.h"
#include "base/containers/flat_map.h"
#include "base/files/file_path.h"
#include "base/files/file_util.h"
#include "base/json/json_file_value_serializer.h"
#include "base/location.h"
#include "base/logging.h"
#include "base/memory/singleton.h"
#include "base/path_service.h"
#include "base/sequenced_task_runner.h"
#include "base/stl_util.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/string_util.h"
#include "base/synchronization/cancellation_flag.h"
#include "base/synchronization/lock.h"
#include "base/synchronization/waitable_event.h"
#include "base/system/sys_info.h"
#include "base/task/post_task.h"
#include "base/task/task_traits.h"
#include "base/task_runner.h"
#include "base/threading/sequenced_task_runner_handle.h"
#include "base/threading/thread_restrictions.h"
#include "base/time/time.h"
#include "base/values.h"
#include "chromeos/constants/chromeos_constants.h"
#include "chromeos/constants/chromeos_paths.h"
#include "chromeos/constants/chromeos_switches.h"
#include "chromeos/system/kiosk_oem_manifest_parser.h"
#include "chromeos/system/name_value_pairs_parser.h"
namespace chromeos {
namespace system {
namespace {
// Path to the tool used to get system info, and delimiters for the output
// format of the tool.
const char* kCrosSystemTool[] = { "/usr/bin/crossystem" };
const char kCrosSystemEq[] = "=";
const char kCrosSystemDelim[] = "\n";
const char kCrosSystemCommentDelim[] = "#";
const char kCrosSystemValueError[] = "(error)";
const char kHardwareClassCrosSystemKey[] = "hwid";
const char kHardwareClassValueUnknown[] = "unknown";
const char kIsVmCrosSystemKey[] = "inside_vm";
// Key/value delimiters of machine hardware info file. machine-info is generated
// only for OOBE and enterprise enrollment and may not be present. See
// login-manager/init/machine-info.conf.
const char kMachineHardwareInfoEq[] = "=";
const char kMachineHardwareInfoDelim[] = " \n";
// File to get ECHO coupon info from, and key/value delimiters of
// the file.
const char kEchoCouponFile[] =
const char kEchoCouponEq[] = "=";
const char kEchoCouponDelim[] = "\n";
// Key/value delimiters for VPD file.
const char kVpdEq[] = "=";
const char kVpdDelim[] = "\n";
// File to get regional data from.
const char kCrosRegions[] = "/usr/share/misc/cros-regions.json";
// Timeout that we should wait for statistics to get loaded
const int kTimeoutSecs = 3;
// The location of OEM manifest file used to trigger OOBE flow for kiosk mode.
const base::CommandLine::CharType kOemManifestFilePath[] =
// Items in region dictionary.
const char kKeyboardsPath[] = "keyboards";
const char kLocalesPath[] = "locales";
const char kTimeZonesPath[] = "time_zones";
// These are the machine serial number keys that we check in order until we find
// a non-empty serial number.
// On older Samsung devices the VPD contains two serial numbers: "Product_S/N"
// and "serial_number" which are based on the same value except that the latter
// has a letter appended that serves as a check digit. Unfortunately, the
// sticker on the device packaging didn't include that check digit (the sticker
// on the device did though!). The former sticker was the source of the serial
// number used by device management service, so we preferred "Product_S/N" over
// "serial_number" to match the server. As an unintended consequence, older
// Samsung devices display and report a serial number that doesn't match the
// sticker on the device (the check digit is missing).
// "Product_S/N" is known to be used on celes, lumpy, pi, pit, snow, winky and
// some kevin devices and thus needs to be supported until AUE of these
// devices. It's known *not* to be present on caroline.
// TODO(tnagel): Remove "Product_S/N" after all devices that have it are AUE.
const char* const kMachineInfoSerialNumberKeys[] = {
"Product_S/N", // Samsung legacy
"serial_number", // VPD v2+ devices (Samsung: caroline and later)
// Gets ListValue from given |dictionary| by given |key| and (unless |result| is
// nullptr) sets |result| to a string with all list values joined by ','.
// Returns true on success.
bool JoinListValuesToString(const base::DictionaryValue* dictionary,
const std::string key,
std::string* result) {
const base::ListValue* list = nullptr;
if (!dictionary->GetListWithoutPathExpansion(key, &list))
return false;
std::string buffer;
bool first = true;
for (const auto& v : *list) {
std::string value;
if (!v.GetAsString(&value))
return false;
if (first)
first = false;
buffer += ',';
buffer += value;
if (result != nullptr)
*result = buffer;
return true;
// Gets ListValue from given |dictionary| by given |key| and (unless |result| is
// nullptr) sets |result| to the first value as string. Returns true on
// success.
bool GetFirstListValueAsString(const base::DictionaryValue* dictionary,
const std::string key,
std::string* result) {
const base::ListValue* list = nullptr;
if (!dictionary->GetListWithoutPathExpansion(key, &list))
return false;
std::string value;
if (!list->GetString(0, &value))
return false;
if (result != nullptr)
*result = value;
return true;
bool GetKeyboardLayoutFromRegionalData(const base::DictionaryValue* region_dict,
std::string* result) {
return JoinListValuesToString(region_dict, kKeyboardsPath, result);
bool GetInitialTimezoneFromRegionalData(
const base::DictionaryValue* region_dict,
std::string* result) {
return GetFirstListValueAsString(region_dict, kTimeZonesPath, result);
bool GetInitialLocaleFromRegionalData(const base::DictionaryValue* region_dict,
std::string* result) {
return JoinListValuesToString(region_dict, kLocalesPath, result);
} // namespace
// Key values for GetMachineStatistic()/GetMachineFlag() calls.
const char kActivateDateKey[] = "ActivateDate";
const char kBlockDevModeKey[] = "block_devmode";
const char kCheckEnrollmentKey[] = "check_enrollment";
const char kShouldSendRlzPingKey[] = "should_send_rlz_ping";
const char kShouldSendRlzPingValueFalse[] = "0";
const char kShouldSendRlzPingValueTrue[] = "1";
const char kRlzEmbargoEndDateKey[] = "rlz_embargo_end_date";
const char kCustomizationIdKey[] = "customization_id";
const char kDevSwitchBootKey[] = "devsw_boot";
const char kDevSwitchBootValueDev[] = "1";
const char kDevSwitchBootValueVerified[] = "0";
const char kFirmwareWriteProtectBootKey[] = "wpsw_boot";
const char kFirmwareWriteProtectBootValueOn[] = "1";
const char kFirmwareWriteProtectBootValueOff[] = "0";
const char kFirmwareTypeKey[] = "mainfw_type";
const char kFirmwareTypeValueDeveloper[] = "developer";
const char kFirmwareTypeValueNonchrome[] = "nonchrome";
const char kFirmwareTypeValueNormal[] = "normal";
const char kHardwareClassKey[] = "hardware_class";
const char kIsVmKey[] = "is_vm";
const char kIsVmValueFalse[] = "0";
const char kIsVmValueTrue[] = "1";
const char kOffersCouponCodeKey[] = "ubind_attribute";
const char kOffersGroupCodeKey[] = "gbind_attribute";
const char kRlzBrandCodeKey[] = "rlz_brand_code";
const char kRegionKey[] = "region";
const char kSerialNumberKeyForTest[] = "serial_number";
const char kInitialLocaleKey[] = "initial_locale";
const char kInitialTimezoneKey[] = "initial_timezone";
const char kKeyboardLayoutKey[] = "keyboard_layout";
// OEM specific statistics. Must be prefixed with "oem_".
const char kOemCanExitEnterpriseEnrollmentKey[] = "oem_can_exit_enrollment";
const char kOemDeviceRequisitionKey[] = "oem_device_requisition";
const char kOemIsEnterpriseManagedKey[] = "oem_enterprise_managed";
const char kOemKeyboardDrivenOobeKey[] = "oem_keyboard_driven_oobe";
bool HasOemPrefix(const std::string& name) {
return name.substr(0, 4) == "oem_";
// The StatisticsProvider implementation used in production.
class StatisticsProviderImpl : public StatisticsProvider {
// StatisticsProvider implementation:
void StartLoadingMachineStatistics(bool load_oem_manifest) override;
void ScheduleOnMachineStatisticsLoaded(base::OnceClosure callback) override;
bool GetMachineStatistic(const std::string& name,
std::string* result) override;
bool GetMachineFlag(const std::string& name, bool* result) override;
void Shutdown() override;
// Returns true when Chrome OS is running in a VM. NOTE: if crossystem is not
// installed it will return false even if Chrome OS is running in a VM.
bool IsRunningOnVm() override;
static StatisticsProviderImpl* GetInstance();
typedef std::map<std::string, bool> MachineFlags;
typedef bool (*RegionDataExtractor)(const base::DictionaryValue*,
friend struct base::DefaultSingletonTraits<StatisticsProviderImpl>;
~StatisticsProviderImpl() override;
// Called when statistics have finished loading. Unblocks pending calls to
// WaitForStatisticsLoaded() and schedules callbacks passed to
// ScheduleOnMachineStatisticsLoaded().
void SignalStatisticsLoaded();
// Waits up to |kTimeoutSecs| for statistics to be loaded. Returns true if
// they were loaded successfully.
bool WaitForStatisticsLoaded();
// Loads the machine statistics off of disk. Runs on the file thread.
void LoadMachineStatistics(bool load_oem_manifest);
// Loads the OEM statistics off of disk. Runs on the file thread.
void LoadOemManifestFromFile(const base::FilePath& file);
// Loads regional data off of disk. Runs on the file thread.
void LoadRegionsFile(const base::FilePath& filename);
// Extracts known data from regional_data_;
// Returns true on success;
bool GetRegionalInformation(const std::string& name,
std::string* result) const;
// Returns current region dictionary or NULL if not found.
const base::DictionaryValue* GetRegionDictionary() const;
// Returns extractor from regional_data_extractors_ or nullptr.
RegionDataExtractor GetRegionalDataExtractor(const std::string& name) const;
bool load_statistics_started_;
NameValuePairsParser::NameValueMap machine_info_;
MachineFlags machine_flags_;
base::CancellationFlag cancellation_flag_;
bool oem_manifest_loaded_;
std::string region_;
std::unique_ptr<base::Value> regional_data_;
base::flat_map<std::string, RegionDataExtractor> regional_data_extractors_;
// Lock held when |statistics_loaded_| is signaled and when
// |statistics_loaded_callbacks_| is accessed.
base::Lock statistics_loaded_lock_;
// Signaled once machine statistics are loaded. It is guaranteed that
// |machine_info_| and |machine_flags_| don't change once this is signaled.
base::WaitableEvent statistics_loaded_;
// Callbacks to schedule once machine statistics are loaded.
std::pair<base::OnceClosure, scoped_refptr<base::SequencedTaskRunner>>>
void StatisticsProviderImpl::SignalStatisticsLoaded() {
decltype(statistics_loaded_callbacks_) local_statistics_loaded_callbacks;
base::AutoLock auto_lock(statistics_loaded_lock_);
// Move all callbacks to a local variable.
local_statistics_loaded_callbacks = std::move(statistics_loaded_callbacks_);
// Prevent new callbacks from being added to |statistics_loaded_callbacks_|
// and unblock pending WaitForStatisticsLoaded() calls.
VLOG(1) << "Finished loading statistics.";
// Schedule callbacks that were in |statistics_loaded_callbacks_|.
for (auto& callback : local_statistics_loaded_callbacks)
callback.second->PostTask(FROM_HERE, std::move(callback.first));
bool StatisticsProviderImpl::WaitForStatisticsLoaded() {
if (statistics_loaded_.IsSignaled())
return true;
// Block if the statistics are not loaded yet. Normally this shouldn't
// happen except during OOBE.
base::Time start_time = base::Time::Now();
base::ScopedAllowBaseSyncPrimitives allow_wait;
base::TimeDelta dtime = base::Time::Now() - start_time;
if (statistics_loaded_.IsSignaled()) {
VLOG(1) << "Statistics loaded after waiting " << dtime.InMilliseconds()
<< "ms.";
return true;
LOG(ERROR) << "Statistics not loaded after waiting "
<< dtime.InMilliseconds() << "ms.";
return false;
const base::DictionaryValue* StatisticsProviderImpl::GetRegionDictionary()
const {
const base::DictionaryValue* full_dict = nullptr;
if (!regional_data_->GetAsDictionary(&full_dict))
return nullptr;
const base::DictionaryValue* region_dict = nullptr;
if (!full_dict->GetDictionaryWithoutPathExpansion(region_, &region_dict))
return nullptr;
return region_dict;
const std::string& name) const {
const auto it = regional_data_extractors_.find(name);
if (it == regional_data_extractors_.end())
return nullptr;
return it->second;
bool StatisticsProviderImpl::GetRegionalInformation(const std::string& name,
std::string* result) const {
if (region_.empty() || !regional_data_.get())
return false;
const RegionDataExtractor extractor = GetRegionalDataExtractor(name);
if (!extractor)
return false;
const base::DictionaryValue* region_dict = GetRegionDictionary();
if (!region_dict)
return false;
return extractor(region_dict, result);
bool StatisticsProviderImpl::GetMachineStatistic(const std::string& name,
std::string* result) {
VLOG(1) << "Machine Statistic requested: " << name;
if (!WaitForStatisticsLoaded()) {
LOG(ERROR) << "GetMachineStatistic called before load started: " << name;
return false;
base::CommandLine* command_line = base::CommandLine::ForCurrentProcess();
std::string cros_regions_mode;
if (command_line->HasSwitch(chromeos::switches::kCrosRegionsMode)) {
cros_regions_mode =
// These two modes override existing machine statistics keys.
// By default (cros_regions_mode is empty), the same keys are emulated if
// they do not exist in machine statistics.
if (cros_regions_mode == chromeos::switches::kCrosRegionsModeOverride ||
cros_regions_mode == chromeos::switches::kCrosRegionsModeHide) {
if (GetRegionalInformation(name, result))
return true;
if (cros_regions_mode == chromeos::switches::kCrosRegionsModeHide &&
GetRegionalDataExtractor(name)) {
return false;
NameValuePairsParser::NameValueMap::iterator iter = machine_info_.find(name);
if (iter == machine_info_.end()) {
if (GetRegionalInformation(name, result))
return true;
if (result != nullptr &&
base::SysInfo::IsRunningOnChromeOS() &&
(oem_manifest_loaded_ || !HasOemPrefix(name))) {
VLOG(1) << "Requested statistic not found: " << name;
return false;
if (result != nullptr)
*result = iter->second;
return true;
bool StatisticsProviderImpl::GetMachineFlag(const std::string& name,
bool* result) {
VLOG(1) << "Machine Flag requested: " << name;
if (!WaitForStatisticsLoaded()) {
LOG(ERROR) << "GetMachineFlag called before load started: " << name;
return false;
MachineFlags::const_iterator iter = machine_flags_.find(name);
if (iter == machine_flags_.end()) {
if (result != nullptr &&
base::SysInfo::IsRunningOnChromeOS() &&
(oem_manifest_loaded_ || !HasOemPrefix(name))) {
VLOG(1) << "Requested machine flag not found: " << name;
return false;
if (result != nullptr)
*result = iter->second;
return true;
void StatisticsProviderImpl::Shutdown() {
cancellation_flag_.Set(); // Cancel any pending loads
bool StatisticsProviderImpl::IsRunningOnVm() {
if (!base::SysInfo::IsRunningOnChromeOS())
return false;
std::string is_vm;
return GetMachineStatistic(kIsVmKey, &is_vm) && is_vm == kIsVmValueTrue;
: load_statistics_started_(false),
base::WaitableEvent::InitialState::NOT_SIGNALED) {
regional_data_extractors_[kInitialLocaleKey] =
regional_data_extractors_[kKeyboardLayoutKey] =
regional_data_extractors_[kInitialTimezoneKey] =
StatisticsProviderImpl::~StatisticsProviderImpl() = default;
void StatisticsProviderImpl::StartLoadingMachineStatistics(
bool load_oem_manifest) {
load_statistics_started_ = true;
VLOG(1) << "Started loading statistics. Load OEM Manifest: "
<< load_oem_manifest;
// TaskPriority::USER_BLOCKING because this is on the critical path of
// rendering the NTP on startup.
{base::MayBlock(), base::TaskPriority::USER_BLOCKING,
base::Unretained(this), load_oem_manifest));
void StatisticsProviderImpl::ScheduleOnMachineStatisticsLoaded(
base::OnceClosure callback) {
// It is important to hold |statistics_loaded_lock_| when checking the
// |statistics_loaded_| event to make sure that its state doesn't change
// before |callback| is added to |statistics_loaded_callbacks_|.
base::AutoLock auto_lock(statistics_loaded_lock_);
// Machine statistics are not loaded yet. Add |callback| to a list to be
// scheduled once machine statistics are loaded.
if (!statistics_loaded_.IsSignaled()) {
std::move(callback), base::SequencedTaskRunnerHandle::Get());
// Machine statistics are loaded. Schedule |callback| immediately.
void StatisticsProviderImpl::LoadMachineStatistics(bool load_oem_manifest) {
// Run from the file task runner. StatisticsProviderImpl is a Singleton<> and
// will not be destroyed until after threads have been stopped, so this test
// is always safe.
if (cancellation_flag_.IsSet())
NameValuePairsParser parser(&machine_info_);
if (base::SysInfo::IsRunningOnChromeOS()) {
// Parse all of the key/value pairs from the crossystem tool.
if (!parser.ParseNameValuePairsFromTool(
base::size(kCrosSystemTool), kCrosSystemTool, kCrosSystemEq,
kCrosSystemDelim, kCrosSystemCommentDelim)) {
LOG(ERROR) << "Errors parsing output from: " << kCrosSystemTool;
// Drop useless "(error)" values so they don't displace valid values
// supplied later by other tools:
base::FilePath machine_info_path;
base::PathService::Get(chromeos::FILE_MACHINE_INFO, &machine_info_path);
if (!base::SysInfo::IsRunningOnChromeOS() &&
!base::PathExists(machine_info_path)) {
// Use time value to create an unique stub serial because clashes of the
// same serial for the same domain invalidate earlier enrollments. Persist
// to disk to keep it constant across restarts (required for re-enrollment
// testing).
std::string stub_contents =
"\"serial_number\"=\"stub_" +
base::NumberToString(base::Time::Now().ToJavaTime()) + "\"\n";
int bytes_written = base::WriteFile(
machine_info_path, stub_contents.c_str(), stub_contents.size());
if (bytes_written < static_cast<int>(stub_contents.size())) {
PLOG(ERROR) << "Error writing machine info stub "
<< machine_info_path.value();
base::FilePath vpd_path;
base::PathService::Get(chromeos::FILE_VPD, &vpd_path);
if (!base::SysInfo::IsRunningOnChromeOS() && !base::PathExists(vpd_path)) {
std::string stub_contents = "\"ActivateDate\"=\"2000-01\"\n";
int bytes_written =
base::WriteFile(vpd_path, stub_contents.c_str(), stub_contents.size());
if (bytes_written < static_cast<int>(stub_contents.size())) {
PLOG(ERROR) << "Error writing vpd stub " << vpd_path.value();
// Ensure that the hardware class key is present with the expected
// key name, and if it couldn't be retrieved, that the value is "unknown".
std::string hardware_class = machine_info_[kHardwareClassCrosSystemKey];
machine_info_[kHardwareClassKey] =
!hardware_class.empty() ? hardware_class : kHardwareClassValueUnknown;
if (base::SysInfo::IsRunningOnChromeOS()) {
// By default, assume that this is *not* a VM. If crossystem is not present,
// report that we are not in a VM.
machine_info_[kIsVmKey] = kIsVmValueFalse;
const auto is_vm_iter = machine_info_.find(kIsVmCrosSystemKey);
if (is_vm_iter != machine_info_.end() &&
is_vm_iter->second == kIsVmValueTrue) {
machine_info_[kIsVmKey] = kIsVmValueTrue;
if (load_oem_manifest) {
// If kAppOemManifestFile switch is specified, load OEM Manifest file.
base::CommandLine* command_line = base::CommandLine::ForCurrentProcess();
if (command_line->HasSwitch(switches::kAppOemManifestFile)) {
} else if (base::SysInfo::IsRunningOnChromeOS()) {
// Set region
const auto region_iter = machine_info_.find(kRegionKey);
if (region_iter != machine_info_.end())
region_ = region_iter->second;
region_ = std::string();
base::CommandLine* command_line = base::CommandLine::ForCurrentProcess();
if (command_line->HasSwitch(chromeos::switches::kCrosRegion)) {
region_ =
machine_info_[kRegionKey] = region_;
VLOG(1) << "CrOS region set to '" << region_ << "'";
if (regional_data_.get() && !region_.empty() && !GetRegionDictionary())
LOG(ERROR) << "Bad regional data: '" << region_ << "' << not found.";
void StatisticsProviderImpl::LoadRegionsFile(const base::FilePath& filename) {
JSONFileValueDeserializer regions_file(filename);
int regions_error_code = 0;
std::string regions_error_message;
regional_data_ =
regions_file.Deserialize(&regions_error_code, &regions_error_message);
if (!regional_data_.get()) {
if (base::SysInfo::IsRunningOnChromeOS())
LOG(ERROR) << "Failed to load regions file '" << filename.value()
<< "': error='" << regions_error_message << "'";
const base::DictionaryValue* full_dict = nullptr;
if (!regional_data_->GetAsDictionary(&full_dict)) {
LOG(ERROR) << "Bad regions file '" << filename.value()
<< "': not a dictionary.";
void StatisticsProviderImpl::LoadOemManifestFromFile(
const base::FilePath& file) {
// Called from LoadMachineStatistics. Check cancellation_flag_ again here.
if (cancellation_flag_.IsSet())
KioskOemManifestParser::Manifest oem_manifest;
if (!KioskOemManifestParser::Load(file, &oem_manifest)) {
LOG(WARNING) << "Unable to load OEM Manifest file: " << file.value();
machine_info_[kOemDeviceRequisitionKey] =
machine_flags_[kOemIsEnterpriseManagedKey] =
machine_flags_[kOemCanExitEnterpriseEnrollmentKey] =
machine_flags_[kOemKeyboardDrivenOobeKey] =
oem_manifest_loaded_ = true;
VLOG(1) << "Loaded OEM Manifest statistics from " << file.value();
StatisticsProviderImpl* StatisticsProviderImpl::GetInstance() {
return base::Singleton<
std::string StatisticsProvider::GetEnterpriseMachineID() {
std::string machine_id;
for (const char* key : kMachineInfoSerialNumberKeys) {
if (GetMachineStatistic(key, &machine_id) && !machine_id.empty()) {
return machine_id;
static StatisticsProvider* g_test_statistics_provider = NULL;
// static
StatisticsProvider* StatisticsProvider::GetInstance() {
if (g_test_statistics_provider)
return g_test_statistics_provider;
return StatisticsProviderImpl::GetInstance();
// static
void StatisticsProvider::SetTestProvider(StatisticsProvider* test_provider) {
g_test_statistics_provider = test_provider;
} // namespace system
} // namespace chromeos