File: sandboxed_vfs_file.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (66 lines) | stat: -rw-r--r-- 2,477 bytes parent folder | download | duplicates (5)
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
// Copyright 2019 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef SQL_SANDBOXED_VFS_FILE_H_
#define SQL_SANDBOXED_VFS_FILE_H_

#include "base/component_export.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/raw_ptr_exclusion.h"
#include "third_party/sqlite/sqlite3.h"

namespace sql {

// SQLite VFS file interface of an vfs file that works in a sandboxed process.
class COMPONENT_EXPORT(SQL) SandboxedVfsFile {
 public:
  SandboxedVfsFile();
  virtual ~SandboxedVfsFile();

  // Bind the `vfs_file` to an instance in the given sqlite3_file buffer.
  static void BindSandboxedFile(SandboxedVfsFile* vfs_file,
                                sqlite3_file& buffer);

  // Extracts the instance bridged to the given SQLite VFS file.
  static SandboxedVfsFile& FromSqliteFile(sqlite3_file& sqlite_file);

  // sqlite3_file implementation.
  virtual int Close() = 0;
  virtual int Read(void* buffer, int size, sqlite3_int64 offset) = 0;
  virtual int Write(const void* buffer, int size, sqlite3_int64 offset) = 0;
  virtual int Truncate(sqlite3_int64 size) = 0;
  virtual int Sync(int flags) = 0;
  virtual int FileSize(sqlite3_int64* result_size) = 0;
  virtual int Lock(int mode) = 0;
  virtual int Unlock(int mode) = 0;
  virtual int CheckReservedLock(int* has_reserved_lock) = 0;
  virtual int FileControl(int opcode, void* data) = 0;
  virtual int SectorSize() = 0;
  virtual int DeviceCharacteristics() = 0;
  virtual int ShmMap(int page_index,
                     int page_size,
                     int extend_file_if_needed,
                     void volatile** result) = 0;
  virtual int ShmLock(int offset, int size, int flags) = 0;
  virtual void ShmBarrier() = 0;
  virtual int ShmUnmap(int also_delete_file) = 0;
  virtual int Fetch(sqlite3_int64 offset, int size, void** result) = 0;
  virtual int Unfetch(sqlite3_int64 offset, void* fetch_result) = 0;
};

// sqlite3_file "subclass" that bridges to a SandboxedVfsFile instance.
struct SandboxedVfsFileSqliteBridge {
  sqlite3_file sqlite_file;
  // `sandboxed_vfs_file` is not a raw_ptr<SandboxedVfsFile>, because
  // reinterpret_cast of uninitialized memory to raw_ptr can cause ref-counting
  // mismatch.
  RAW_PTR_EXCLUSION SandboxedVfsFile* sandboxed_vfs_file;

  static SandboxedVfsFileSqliteBridge& FromSqliteFile(
      sqlite3_file& sqlite_file);
};

}  // namespace sql

#endif  // SQL_SANDBOXED_VFS_FILE_H_