chrome/browser/component_updater/swiftshader_component_installer.cc

   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 #include "chrome/browser/component_updater/swiftshader_component_installer.h"
   6
   7 #include "base/base_paths.h"
   8 #include "base/bind.h"
   9 #include "base/compiler_specific.h"
  10 #include "base/cpu.h"
  11 #include "base/file_util.h"
  12 #include "base/files/file_enumerator.h"
  13 #include "base/files/file_path.h"
  14 #include "base/logging.h"
  15 #include "base/path_service.h"
  16 #include "base/strings/string_util.h"
  17 #include "base/values.h"
  18 #include "chrome/browser/component_updater/component_updater_service.h"
  19 #include "chrome/common/chrome_paths.h"
  20 #include "content/public/browser/browser_thread.h"
  21 #include "content/public/browser/gpu_data_manager.h"
  22 #include "content/public/browser/gpu_data_manager_observer.h"
  23 #include "gpu/config/gpu_feature_type.h"
  24
  25 using content::BrowserThread;
  26 using content::GpuDataManager;
  27
  28 namespace component_updater {
  29
  30 namespace {
  31
  32 // CRX hash. The extension id is: nhfgdggnnopgbfdlpeoalgcjdgfafocg.
  33 const uint8 kSha2Hash[] = {0xd7, 0x56, 0x36, 0x6d, 0xde, 0xf6, 0x15, 0x3b,
  34                            0xf4, 0xe0, 0xb6, 0x29, 0x36, 0x50, 0x5e, 0x26,
  35                            0xbd, 0x77, 0x8b, 0x8e, 0x35, 0xc2, 0x7e, 0x43,
  36                            0x52, 0x47, 0x62, 0xed, 0x12, 0xca, 0xcc, 0x6a};
  37
  38 // File name of the internal SwiftShader plugin on different platforms.
  39 const base::FilePath::CharType kSwiftShaderEglName[] =
  40     FILE_PATH_LITERAL("libegl.dll");
  41 const base::FilePath::CharType kSwiftShaderGlesName[] =
  42     FILE_PATH_LITERAL("libglesv2.dll");
  43
  44 const char kSwiftShaderManifestName[] = "SwiftShader";
  45
  46 const base::FilePath::CharType kSwiftShaderBaseDirectory[] =
  47     FILE_PATH_LITERAL("SwiftShader");
  48
  49 // If we don't have a SwiftShader component, this is the version we claim.
  50 const char kNullVersion[] = "0.0.0.0";
  51
  52 // The base directory on windows looks like:
  53 // <profile>\AppData\Local\Google\Chrome\User Data\SwiftShader\.
  54 base::FilePath GetSwiftShaderBaseDirectory() {
  55   base::FilePath result;
  56   PathService::Get(chrome::DIR_USER_DATA, &result);
  57   return result.Append(kSwiftShaderBaseDirectory);
  58 }
  59
  60 // SwiftShader has version encoded in the path itself
  61 // so we need to enumerate the directories to find the full path.
  62 // On success it returns something like:
  63 // <profile>\AppData\Local\Google\Chrome\User Data\SwiftShader\10.3.44.555\.
  64 bool GetLatestSwiftShaderDirectory(base::FilePath* result,
  65                                    Version* latest,
  66                                    std::vector<base::FilePath>* older_dirs) {
  67   base::FilePath base_dir = GetSwiftShaderBaseDirectory();
  68   bool found = false;
  69   base::FileEnumerator
  70       file_enumerator(base_dir, false, base::FileEnumerator::DIRECTORIES);
  71   for (base::FilePath path = file_enumerator.Next(); !path.value().empty();
  72        path = file_enumerator.Next()) {
  73     Version version(path.BaseName().MaybeAsASCII());
  74     if (!version.IsValid())
  75       continue;
  76     if (version.CompareTo(*latest) > 0 &&
  77         base::PathExists(path.Append(kSwiftShaderEglName)) &&
  78         base::PathExists(path.Append(kSwiftShaderGlesName))) {
  79       if (found && older_dirs)
  80           older_dirs->push_back(*result);
  81       *latest = version;
  82       *result = path;
  83       found = true;
  84     } else {
  85       if (older_dirs)
  86         older_dirs->push_back(path);
  87     }
  88   }
  89   return found;
  90 }
  91
  92 void RegisterSwiftShaderWithChrome(const base::FilePath& path) {
  93   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
  94   GpuDataManager::GetInstance()->RegisterSwiftShaderPath(path);
  95 }
  96
  97 }  // namespace
  98
  99 class SwiftShaderComponentInstaller : public ComponentInstaller {
 100  public:
 101   explicit SwiftShaderComponentInstaller(const Version& version);
 102
 103   virtual ~SwiftShaderComponentInstaller() {}
 104
 105   virtual void OnUpdateError(int error) OVERRIDE;
 106
 107   virtual bool Install(const base::DictionaryValue& manifest,
 108                        const base::FilePath& unpack_path) OVERRIDE;
 109
 110   virtual bool GetInstalledFile(const std::string& file,
 111                                 base::FilePath* installed_file) OVERRIDE;
 112
 113  private:
 114   Version current_version_;
 115 };
 116
 117 SwiftShaderComponentInstaller::SwiftShaderComponentInstaller(
 118     const Version& version) : current_version_(version) {
 119   DCHECK(version.IsValid());
 120 }
 121
 122 void SwiftShaderComponentInstaller::OnUpdateError(int error) {
 123   NOTREACHED() << "SwiftShader update error: " << error;
 124 }
 125
 126 bool SwiftShaderComponentInstaller::Install(
 127     const base::DictionaryValue& manifest,
 128     const base::FilePath& unpack_path) {
 129   std::string name;
 130   manifest.GetStringASCII("name", &name);
 131   if (name != kSwiftShaderManifestName)
 132     return false;
 133   std::string proposed_version;
 134   manifest.GetStringASCII("version", &proposed_version);
 135   Version version(proposed_version.c_str());
 136   if (!version.IsValid())
 137     return false;
 138   if (current_version_.CompareTo(version) >= 0)
 139     return false;
 140   if (!base::PathExists(unpack_path.Append(kSwiftShaderEglName)) ||
 141       !base::PathExists(unpack_path.Append(kSwiftShaderGlesName)))
 142     return false;
 143   // Passed the basic tests. Time to install it.
 144   base::FilePath path =
 145       GetSwiftShaderBaseDirectory().AppendASCII(version.GetString());
 146   if (base::PathExists(path))
 147     return false;
 148   if (!base::Move(unpack_path, path))
 149     return false;
 150   // Installation is done. Now tell the rest of chrome.
 151   current_version_ = version;
 152   BrowserThread::PostTask(BrowserThread::UI, FROM_HERE,
 153       base::Bind(&RegisterSwiftShaderWithChrome, path));
 154   return true;
 155 }
 156
 157 bool SwiftShaderComponentInstaller::GetInstalledFile(
 158     const std::string& file, base::FilePath* installed_file) {
 159   return false;
 160 }
 161
 162 void FinishSwiftShaderUpdateRegistration(ComponentUpdateService* cus,
 163                                          const Version& version) {
 164   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
 165
 166   CrxComponent swiftshader;
 167   swiftshader.name = "Swift Shader";
 168   swiftshader.installer = new SwiftShaderComponentInstaller(version);
 169   swiftshader.version = version;
 170   swiftshader.pk_hash.assign(kSha2Hash, &kSha2Hash[sizeof(kSha2Hash)]);
 171   if (cus->RegisterComponent(swiftshader) != ComponentUpdateService::kOk) {
 172     NOTREACHED() << "SwiftShader component registration fail";
 173   }
 174 }
 175
 176 class UpdateChecker : public content::GpuDataManagerObserver {
 177  public:
 178   explicit UpdateChecker(ComponentUpdateService* cus);
 179
 180   virtual void OnGpuInfoUpdate() OVERRIDE;
 181
 182  private:
 183   ComponentUpdateService* cus_;
 184 };
 185
 186 UpdateChecker::UpdateChecker(ComponentUpdateService* cus)
 187   : cus_(cus) {
 188 }
 189
 190 void UpdateChecker::OnGpuInfoUpdate() {
 191   GpuDataManager *gpu_data_manager = GpuDataManager::GetInstance();
 192
 193   if (!gpu_data_manager->GpuAccessAllowed(NULL) ||
 194       gpu_data_manager->IsFeatureBlacklisted(gpu::GPU_FEATURE_TYPE_WEBGL) ||
 195       gpu_data_manager->ShouldUseSwiftShader()) {
 196     gpu_data_manager->RemoveObserver(this);
 197     DCHECK(BrowserThread::CurrentlyOn(BrowserThread::FILE));
 198     base::FilePath path = GetSwiftShaderBaseDirectory();
 199
 200     Version version(kNullVersion);
 201     GetLatestSwiftShaderDirectory(&path, &version, NULL);
 202
 203     BrowserThread::PostTask(BrowserThread::UI, FROM_HERE,
 204         base::Bind(&FinishSwiftShaderUpdateRegistration, cus_, version));
 205   }
 206 }
 207
 208 // Check if there already is a version of swiftshader installed,
 209 // and if so register it.
 210 void RegisterSwiftShaderPath(ComponentUpdateService* cus) {
 211   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::FILE));
 212   base::FilePath path = GetSwiftShaderBaseDirectory();
 213   if (!base::PathExists(path)) {
 214     if (!base::CreateDirectory(path)) {
 215       NOTREACHED() << "Could not create SwiftShader directory.";
 216       return;
 217     }
 218   }
 219
 220   Version version(kNullVersion);
 221   std::vector<base::FilePath> older_dirs;
 222   if (GetLatestSwiftShaderDirectory(&path, &version, &older_dirs))
 223     BrowserThread::PostTask(BrowserThread::UI, FROM_HERE,
 224         base::Bind(&RegisterSwiftShaderWithChrome, path));
 225
 226   UpdateChecker *update_checker = new UpdateChecker(cus);
 227   GpuDataManager::GetInstance()->AddObserver(update_checker);
 228   update_checker->OnGpuInfoUpdate();
 229   // We leak update_checker here, because it has to stick around for the life
 230   // of the GpuDataManager.
 231
 232   // Remove older versions of SwiftShader.
 233   for (std::vector<base::FilePath>::iterator iter = older_dirs.begin();
 234        iter != older_dirs.end(); ++iter) {
 235     base::DeleteFile(*iter, true);
 236   }
 237 }
 238
 239 void RegisterSwiftShaderComponent(ComponentUpdateService* cus) {
 240 #if defined(ENABLE_SWIFTSHADER)
 241   base::CPU cpu;
 242
 243   if (!cpu.has_sse2())
 244     return;
 245   BrowserThread::PostTask(BrowserThread::FILE, FROM_HERE,
 246       base::Bind(&RegisterSwiftShaderPath, cus));
 247 #endif
 248 }
 249
 250 }  // namespace component_updater
 251