1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
|
// 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 "components/nacl/browser/nacl_browser.h"
#include "base/command_line.h"
#include "base/files/file_proxy.h"
#include "base/files/file_util.h"
#include "base/location.h"
#include "base/metrics/histogram_macros.h"
#include "base/path_service.h"
#include "base/pickle.h"
#include "base/rand_util.h"
#include "base/single_thread_task_runner.h"
#include "base/thread_task_runner_handle.h"
#include "base/time/time.h"
#include "base/win/windows_version.h"
#include "build/build_config.h"
#include "content/public/browser/browser_thread.h"
#include "url/gurl.h"
namespace {
// An arbitrary delay to coalesce multiple writes to the cache.
const int kValidationCacheCoalescingTimeMS = 6000;
const char kValidationCacheSequenceName[] = "NaClValidationCache";
const base::FilePath::CharType kValidationCacheFileName[] =
FILE_PATH_LITERAL("nacl_validation_cache.bin");
const bool kValidationCacheEnabledByDefault = true;
// Keep the cache bounded to an arbitrary size. If it's too small, useful
// entries could be evicted when multiple .nexes are loaded at once. On the
// other hand, entries are not always claimed (and hence removed), so the size
// of the cache will likely saturate at its maximum size.
// Entries may not be claimed for two main reasons. 1) the NaCl process could
// be killed while it is loading. 2) the trusted NaCl plugin opens files using
// the code path but doesn't resolve them.
// TODO(ncbray) don't cache files that the plugin will not resolve.
const int kFilePathCacheSize = 100;
const base::FilePath::StringType NaClIrtName() {
base::FilePath::StringType irt_name(FILE_PATH_LITERAL("nacl_irt_"));
#if defined(ARCH_CPU_X86_FAMILY)
#if defined(ARCH_CPU_X86_64)
bool is64 = true;
#elif defined(OS_WIN)
bool is64 = (base::win::OSInfo::GetInstance()->wow64_status() ==
base::win::OSInfo::WOW64_ENABLED);
#else
bool is64 = false;
#endif
if (is64)
irt_name.append(FILE_PATH_LITERAL("x86_64"));
else
irt_name.append(FILE_PATH_LITERAL("x86_32"));
#elif defined(ARCH_CPU_ARMEL)
irt_name.append(FILE_PATH_LITERAL("arm"));
#elif defined(ARCH_CPU_MIPSEL)
irt_name.append(FILE_PATH_LITERAL("mips32"));
#else
#error Add support for your architecture to NaCl IRT file selection
#endif
irt_name.append(FILE_PATH_LITERAL(".nexe"));
return irt_name;
}
#if !defined(OS_ANDROID)
bool CheckEnvVar(const char* name, bool default_value) {
bool result = default_value;
const char* var = getenv(name);
if (var && strlen(var) > 0) {
result = var[0] != '0';
}
return result;
}
#endif
void ReadCache(const base::FilePath& filename, std::string* data) {
if (!base::ReadFileToString(filename, data)) {
// Zero-size data used as an in-band error code.
data->clear();
}
}
void WriteCache(const base::FilePath& filename, const base::Pickle* pickle) {
base::WriteFile(filename, static_cast<const char*>(pickle->data()),
pickle->size());
}
void RemoveCache(const base::FilePath& filename,
const base::Closure& callback) {
base::DeleteFile(filename, false);
content::BrowserThread::PostTask(content::BrowserThread::IO, FROM_HERE,
callback);
}
void LogCacheQuery(nacl::NaClBrowser::ValidationCacheStatus status) {
UMA_HISTOGRAM_ENUMERATION("NaCl.ValidationCache.Query", status,
nacl::NaClBrowser::CACHE_MAX);
}
void LogCacheSet(nacl::NaClBrowser::ValidationCacheStatus status) {
// Bucket zero is reserved for future use.
UMA_HISTOGRAM_ENUMERATION("NaCl.ValidationCache.Set", status,
nacl::NaClBrowser::CACHE_MAX);
}
// Crash throttling parameters.
const size_t kMaxCrashesPerInterval = 3;
const int64 kCrashesIntervalInSeconds = 120;
} // namespace
namespace nacl {
base::File OpenNaClReadExecImpl(const base::FilePath& file_path,
bool is_executable) {
// Get a file descriptor. On Windows, we need 'GENERIC_EXECUTE' in order to
// memory map the executable.
// IMPORTANT: This file descriptor must not have write access - that could
// allow a NaCl inner sandbox escape.
uint32 flags = base::File::FLAG_OPEN | base::File::FLAG_READ;
if (is_executable)
flags |= base::File::FLAG_EXECUTE; // Windows only flag.
base::File file(file_path, flags);
if (!file.IsValid())
return file.Pass();
// Check that the file does not reference a directory. Returning a descriptor
// to an extension directory could allow an outer sandbox escape. openat(...)
// could be used to traverse into the file system.
base::File::Info file_info;
if (!file.GetInfo(&file_info) || file_info.is_directory)
return base::File();
return file.Pass();
}
NaClBrowser::NaClBrowser()
: irt_filepath_(),
irt_state_(NaClResourceUninitialized),
validation_cache_file_path_(),
validation_cache_is_enabled_(false),
validation_cache_is_modified_(false),
validation_cache_state_(NaClResourceUninitialized),
path_cache_(kFilePathCacheSize),
ok_(true),
weak_factory_(this) {
#if !defined(OS_ANDROID)
validation_cache_is_enabled_ =
CheckEnvVar("NACL_VALIDATION_CACHE",
kValidationCacheEnabledByDefault);
#endif
}
void NaClBrowser::SetDelegate(NaClBrowserDelegate* delegate) {
NaClBrowser* nacl_browser = NaClBrowser::GetInstance();
nacl_browser->browser_delegate_.reset(delegate);
}
NaClBrowserDelegate* NaClBrowser::GetDelegate() {
// The delegate is not owned by the IO thread. This accessor method can be
// called from other threads.
DCHECK(GetInstance()->browser_delegate_.get() != NULL);
return GetInstance()->browser_delegate_.get();
}
void NaClBrowser::EarlyStartup() {
DCHECK_CURRENTLY_ON(content::BrowserThread::IO);
InitIrtFilePath();
InitValidationCacheFilePath();
}
NaClBrowser::~NaClBrowser() {
}
void NaClBrowser::InitIrtFilePath() {
// Allow the IRT library to be overridden via an environment
// variable. This allows the NaCl/Chromium integration bot to
// specify a newly-built IRT rather than using a prebuilt one
// downloaded via Chromium's DEPS file. We use the same environment
// variable that the standalone NaCl PPAPI plugin accepts.
const char* irt_path_var = getenv("NACL_IRT_LIBRARY");
if (irt_path_var != NULL) {
base::FilePath::StringType path_string(
irt_path_var, const_cast<const char*>(strchr(irt_path_var, '\0')));
irt_filepath_ = base::FilePath(path_string);
} else {
base::FilePath plugin_dir;
if (!browser_delegate_->GetPluginDirectory(&plugin_dir)) {
DLOG(ERROR) << "Failed to locate the plugins directory, NaCl disabled.";
MarkAsFailed();
return;
}
irt_filepath_ = plugin_dir.Append(NaClIrtName());
}
}
#if defined(OS_WIN)
bool NaClBrowser::GetNaCl64ExePath(base::FilePath* exe_path) {
base::FilePath module_path;
if (!PathService::Get(base::FILE_MODULE, &module_path)) {
LOG(ERROR) << "NaCl process launch failed: could not resolve module";
return false;
}
*exe_path = module_path.DirName().Append(L"nacl64");
return true;
}
#endif
NaClBrowser* NaClBrowser::GetInstance() {
return Singleton<NaClBrowser>::get();
}
bool NaClBrowser::IsReady() const {
return (IsOk() &&
irt_state_ == NaClResourceReady &&
validation_cache_state_ == NaClResourceReady);
}
bool NaClBrowser::IsOk() const {
return ok_;
}
const base::File& NaClBrowser::IrtFile() const {
DCHECK_CURRENTLY_ON(content::BrowserThread::IO);
CHECK_EQ(irt_state_, NaClResourceReady);
CHECK(irt_file_.IsValid());
return irt_file_;
}
void NaClBrowser::EnsureAllResourcesAvailable() {
DCHECK_CURRENTLY_ON(content::BrowserThread::IO);
EnsureIrtAvailable();
EnsureValidationCacheAvailable();
}
// Load the IRT async.
void NaClBrowser::EnsureIrtAvailable() {
DCHECK_CURRENTLY_ON(content::BrowserThread::IO);
if (IsOk() && irt_state_ == NaClResourceUninitialized) {
irt_state_ = NaClResourceRequested;
// TODO(ncbray) use blocking pool.
scoped_ptr<base::FileProxy> file_proxy(new base::FileProxy(
content::BrowserThread::GetMessageLoopProxyForThread(
content::BrowserThread::FILE).get()));
base::FileProxy* proxy = file_proxy.get();
if (!proxy->CreateOrOpen(irt_filepath_,
base::File::FLAG_OPEN | base::File::FLAG_READ,
base::Bind(&NaClBrowser::OnIrtOpened,
weak_factory_.GetWeakPtr(),
Passed(&file_proxy)))) {
LOG(ERROR) << "Internal error, NaCl disabled.";
MarkAsFailed();
}
}
}
void NaClBrowser::OnIrtOpened(scoped_ptr<base::FileProxy> file_proxy,
base::File::Error error_code) {
DCHECK_CURRENTLY_ON(content::BrowserThread::IO);
DCHECK_EQ(irt_state_, NaClResourceRequested);
if (file_proxy->IsValid()) {
irt_file_ = file_proxy->TakeFile();
} else {
LOG(ERROR) << "Failed to open NaCl IRT file \""
<< irt_filepath_.LossyDisplayName()
<< "\": " << error_code;
MarkAsFailed();
}
irt_state_ = NaClResourceReady;
CheckWaiting();
}
void NaClBrowser::SetProcessGdbDebugStubPort(int process_id, int port) {
gdb_debug_stub_port_map_[process_id] = port;
if (port != kGdbDebugStubPortUnknown &&
!debug_stub_port_listener_.is_null()) {
content::BrowserThread::PostTask(
content::BrowserThread::IO,
FROM_HERE,
base::Bind(debug_stub_port_listener_, port));
}
}
void NaClBrowser::SetGdbDebugStubPortListener(
base::Callback<void(int)> listener) {
debug_stub_port_listener_ = listener;
}
void NaClBrowser::ClearGdbDebugStubPortListener() {
debug_stub_port_listener_.Reset();
}
int NaClBrowser::GetProcessGdbDebugStubPort(int process_id) {
GdbDebugStubPortMap::iterator i = gdb_debug_stub_port_map_.find(process_id);
if (i != gdb_debug_stub_port_map_.end()) {
return i->second;
}
return kGdbDebugStubPortUnused;
}
void NaClBrowser::InitValidationCacheFilePath() {
// Determine where the validation cache resides in the file system. It
// exists in Chrome's cache directory and is not tied to any specific
// profile.
// Start by finding the user data directory.
base::FilePath user_data_dir;
if (!browser_delegate_->GetUserDirectory(&user_data_dir)) {
RunWithoutValidationCache();
return;
}
// The cache directory may or may not be the user data directory.
base::FilePath cache_file_path;
browser_delegate_->GetCacheDirectory(&cache_file_path);
// Append the base file name to the cache directory.
validation_cache_file_path_ =
cache_file_path.Append(kValidationCacheFileName);
}
void NaClBrowser::EnsureValidationCacheAvailable() {
DCHECK_CURRENTLY_ON(content::BrowserThread::IO);
if (IsOk() && validation_cache_state_ == NaClResourceUninitialized) {
if (ValidationCacheIsEnabled()) {
validation_cache_state_ = NaClResourceRequested;
// Structure for carrying data between the callbacks.
std::string* data = new std::string();
// We can get away not giving this a sequence ID because this is the first
// task and further file access will not occur until after we get a
// response.
if (!content::BrowserThread::PostBlockingPoolTaskAndReply(
FROM_HERE,
base::Bind(ReadCache, validation_cache_file_path_, data),
base::Bind(&NaClBrowser::OnValidationCacheLoaded,
weak_factory_.GetWeakPtr(),
base::Owned(data)))) {
RunWithoutValidationCache();
}
} else {
RunWithoutValidationCache();
}
}
}
void NaClBrowser::OnValidationCacheLoaded(const std::string *data) {
DCHECK_CURRENTLY_ON(content::BrowserThread::IO);
// Did the cache get cleared before the load completed? If so, ignore the
// incoming data.
if (validation_cache_state_ == NaClResourceReady)
return;
if (data->size() == 0) {
// No file found.
validation_cache_.Reset();
} else {
base::Pickle pickle(data->data(), data->size());
validation_cache_.Deserialize(&pickle);
}
validation_cache_state_ = NaClResourceReady;
CheckWaiting();
}
void NaClBrowser::RunWithoutValidationCache() {
// Be paranoid.
validation_cache_.Reset();
validation_cache_is_enabled_ = false;
validation_cache_state_ = NaClResourceReady;
CheckWaiting();
}
void NaClBrowser::CheckWaiting() {
DCHECK_CURRENTLY_ON(content::BrowserThread::IO);
if (!IsOk() || IsReady()) {
// Queue the waiting tasks into the message loop. This helps avoid
// re-entrancy problems that could occur if the closure was invoked
// directly. For example, this could result in use-after-free of the
// process host.
for (std::vector<base::Closure>::iterator iter = waiting_.begin();
iter != waiting_.end(); ++iter) {
base::ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE, *iter);
}
waiting_.clear();
}
}
void NaClBrowser::MarkAsFailed() {
ok_ = false;
CheckWaiting();
}
void NaClBrowser::WaitForResources(const base::Closure& reply) {
waiting_.push_back(reply);
EnsureAllResourcesAvailable();
CheckWaiting();
}
const base::FilePath& NaClBrowser::GetIrtFilePath() {
return irt_filepath_;
}
void NaClBrowser::PutFilePath(const base::FilePath& path, uint64* file_token_lo,
uint64* file_token_hi) {
DCHECK_CURRENTLY_ON(content::BrowserThread::IO);
while (true) {
uint64 file_token[2] = {base::RandUint64(), base::RandUint64()};
// A zero file_token indicates there is no file_token, if we get zero, ask
// for another number.
if (file_token[0] != 0 || file_token[1] != 0) {
// If the file_token is in use, ask for another number.
std::string key(reinterpret_cast<char*>(file_token), sizeof(file_token));
PathCacheType::iterator iter = path_cache_.Peek(key);
if (iter == path_cache_.end()) {
path_cache_.Put(key, path);
*file_token_lo = file_token[0];
*file_token_hi = file_token[1];
break;
}
}
}
}
bool NaClBrowser::GetFilePath(uint64 file_token_lo, uint64 file_token_hi,
base::FilePath* path) {
DCHECK_CURRENTLY_ON(content::BrowserThread::IO);
uint64 file_token[2] = {file_token_lo, file_token_hi};
std::string key(reinterpret_cast<char*>(file_token), sizeof(file_token));
PathCacheType::iterator iter = path_cache_.Peek(key);
if (iter == path_cache_.end()) {
*path = base::FilePath(FILE_PATH_LITERAL(""));
return false;
}
*path = iter->second;
path_cache_.Erase(iter);
return true;
}
bool NaClBrowser::QueryKnownToValidate(const std::string& signature,
bool off_the_record) {
DCHECK_CURRENTLY_ON(content::BrowserThread::IO);
if (off_the_record) {
// If we're off the record, don't reorder the main cache.
return validation_cache_.QueryKnownToValidate(signature, false) ||
off_the_record_validation_cache_.QueryKnownToValidate(signature, true);
} else {
bool result = validation_cache_.QueryKnownToValidate(signature, true);
LogCacheQuery(result ? CACHE_HIT : CACHE_MISS);
// Queries can modify the MRU order of the cache.
MarkValidationCacheAsModified();
return result;
}
}
void NaClBrowser::SetKnownToValidate(const std::string& signature,
bool off_the_record) {
DCHECK_CURRENTLY_ON(content::BrowserThread::IO);
if (off_the_record) {
off_the_record_validation_cache_.SetKnownToValidate(signature);
} else {
validation_cache_.SetKnownToValidate(signature);
// The number of sets should be equal to the number of cache misses, minus
// validation failures and successful validations where stubout occurs.
LogCacheSet(CACHE_HIT);
MarkValidationCacheAsModified();
}
}
void NaClBrowser::ClearValidationCache(const base::Closure& callback) {
DCHECK_CURRENTLY_ON(content::BrowserThread::IO);
// Note: this method may be called before EnsureValidationCacheAvailable has
// been invoked. In other words, this method may be called before any NaCl
// processes have been created. This method must succeed and invoke the
// callback in such a case. If it does not invoke the callback, Chrome's UI
// will hang in that case.
validation_cache_.Reset();
off_the_record_validation_cache_.Reset();
if (validation_cache_file_path_.empty()) {
// Can't figure out what file to remove, but don't drop the callback.
content::BrowserThread::PostTask(content::BrowserThread::IO, FROM_HERE,
callback);
} else {
// Delegate the removal of the cache from the filesystem to another thread
// to avoid blocking the IO thread.
// This task is dispatched immediately, not delayed and coalesced, because
// the user interface for cache clearing is likely waiting for the callback.
// In addition, we need to make sure the cache is actually cleared before
// invoking the callback to meet the implicit guarantees of the UI.
content::BrowserThread::PostBlockingPoolSequencedTask(
kValidationCacheSequenceName,
FROM_HERE,
base::Bind(RemoveCache, validation_cache_file_path_, callback));
}
// Make sure any delayed tasks to persist the cache to the filesystem are
// squelched.
validation_cache_is_modified_ = false;
// If the cache is cleared before it is loaded from the filesystem, act as if
// we just loaded an empty cache.
if (validation_cache_state_ != NaClResourceReady) {
validation_cache_state_ = NaClResourceReady;
CheckWaiting();
}
}
void NaClBrowser::MarkValidationCacheAsModified() {
if (!validation_cache_is_modified_) {
// Wait before persisting to disk. This can coalesce multiple cache
// modifications info a single disk write.
base::ThreadTaskRunnerHandle::Get()->PostDelayedTask(
FROM_HERE, base::Bind(&NaClBrowser::PersistValidationCache,
weak_factory_.GetWeakPtr()),
base::TimeDelta::FromMilliseconds(kValidationCacheCoalescingTimeMS));
validation_cache_is_modified_ = true;
}
}
void NaClBrowser::PersistValidationCache() {
DCHECK_CURRENTLY_ON(content::BrowserThread::IO);
// validation_cache_is_modified_ may be false if the cache was cleared while
// this delayed task was pending.
// validation_cache_file_path_ may be empty if something went wrong during
// initialization.
if (validation_cache_is_modified_ && !validation_cache_file_path_.empty()) {
base::Pickle* pickle = new base::Pickle();
validation_cache_.Serialize(pickle);
// Pass the serialized data to another thread to write to disk. File IO is
// not allowed on the IO thread (which is the thread this method runs on)
// because it can degrade the responsiveness of the browser.
// The task is sequenced so that multiple writes happen in order.
content::BrowserThread::PostBlockingPoolSequencedTask(
kValidationCacheSequenceName,
FROM_HERE,
base::Bind(WriteCache, validation_cache_file_path_,
base::Owned(pickle)));
}
validation_cache_is_modified_ = false;
}
void NaClBrowser::OnProcessEnd(int process_id) {
gdb_debug_stub_port_map_.erase(process_id);
}
void NaClBrowser::OnProcessCrashed() {
DCHECK_CURRENTLY_ON(content::BrowserThread::IO);
if (crash_times_.size() == kMaxCrashesPerInterval) {
crash_times_.pop_front();
}
base::Time time = base::Time::Now();
crash_times_.push_back(time);
}
bool NaClBrowser::IsThrottled() {
DCHECK_CURRENTLY_ON(content::BrowserThread::IO);
if (crash_times_.size() != kMaxCrashesPerInterval) {
return false;
}
base::TimeDelta delta = base::Time::Now() - crash_times_.front();
return delta.InSeconds() <= kCrashesIntervalInSeconds;
}
} // namespace nacl
|