File: shared_memory_mapper.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 (45 lines) | stat: -rw-r--r-- 1,568 bytes parent folder | download | duplicates (9)
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
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef BASE_MEMORY_SHARED_MEMORY_MAPPER_H_
#define BASE_MEMORY_SHARED_MEMORY_MAPPER_H_

#include <stdint.h>

#include <optional>

#include "base/base_export.h"
#include "base/containers/span.h"
#include "base/memory/platform_shared_memory_handle.h"

namespace base {

// Interface to implement mapping and unmapping of shared memory regions into
// the virtual address space. The default implementation,
// |PlatformSharedMemoryMapper| uses the platform-specific APIs to map the
// region anywhere in the address space. Other implementations can be used for
// example to always map the regions into an existing address space reservation.
// Implementations of this interface should generally be statically allocated
// as SharedMemoryMappings keep a reference to their mapper.
class BASE_EXPORT SharedMemoryMapper {
 public:
  // Returns the default shared memory mapper.
  static SharedMemoryMapper* GetDefaultInstance();

  // Maps the shared memory region identified through the provided platform
  // handle into the caller's address space.
  virtual std::optional<span<uint8_t>> Map(
      subtle::PlatformSharedMemoryHandle handle,
      bool write_allowed,
      uint64_t offset,
      size_t size) = 0;

  // Unmaps the specified region of shared memory from the caller's address
  // space.
  virtual void Unmap(span<uint8_t> mapping) = 0;
};

}  // namespace base

#endif  // BASE_MEMORY_SHARED_MEMORY_MAPPER_H_