summaryrefslogtreecommitdiff
path: root/base/allocator/dispatcher/notification_data.h
blob: 4d322d8c21a930b80e9a62f3d8ff97077ac6e540 (plain)
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
// Copyright 2023 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_ALLOCATOR_DISPATCHER_NOTIFICATION_DATA_H_
#define BASE_ALLOCATOR_DISPATCHER_NOTIFICATION_DATA_H_

#include <cstdint>

#include "base/allocator/dispatcher/memory_tagging.h"
#include "base/allocator/dispatcher/subsystem.h"
#include "base/base_export.h"
#include "partition_alloc/partition_alloc_buildflags.h"

namespace base::allocator::dispatcher {

// Definitions of the parameter structures passed to the observer hooks. They
// are similar to the structures defined by PartitionAllocator but provide
// further information.

// The notification data for the allocation path.
class BASE_EXPORT AllocationNotificationData {
 public:
  constexpr AllocationNotificationData(void* address,
                                       size_t size,
                                       const char* type_name,
                                       AllocationSubsystem allocation_subsystem)
      : address_(address),
        size_(size),
        type_name_(type_name),
        allocation_subsystem_(allocation_subsystem) {}

  constexpr void* address() const { return address_; }

  constexpr size_t size() const { return size_; }

  constexpr const char* type_name() const { return type_name_; }

  constexpr AllocationSubsystem allocation_subsystem() const {
    return allocation_subsystem_;
  }

  // In the allocation observer path, it's interesting which reporting mode is
  // enabled.
#if BUILDFLAG(HAS_MEMORY_TAGGING)
  constexpr AllocationNotificationData& SetMteReportingMode(MTEMode mode) {
    mte_reporting_mode_ = mode;
    return *this;
  }
#endif  // BUILDFLAG(HAS_MEMORY_TAGGING)

  constexpr MTEMode mte_reporting_mode() const {
#if BUILDFLAG(HAS_MEMORY_TAGGING)
    return mte_reporting_mode_;
#else
    return MTEMode::kUndefined;
#endif  // BUILDFLAG(HAS_MEMORY_TAGGING)
  }

 private:
  void* address_ = nullptr;
  size_t size_ = 0;
  const char* type_name_ = nullptr;
#if BUILDFLAG(HAS_MEMORY_TAGGING)
  MTEMode mte_reporting_mode_ = MTEMode::kUndefined;
#endif  // BUILDFLAG(HAS_MEMORY_TAGGING)
  AllocationSubsystem allocation_subsystem_;
};

// The notification data for the free path.
class BASE_EXPORT FreeNotificationData {
 public:
  constexpr explicit FreeNotificationData(
      void* address,
      AllocationSubsystem allocation_subsystem)
      : address_(address), allocation_subsystem_(allocation_subsystem) {}

  constexpr void* address() const { return address_; }

  constexpr AllocationSubsystem allocation_subsystem() const {
    return allocation_subsystem_;
  }

  // In the free observer path, it's interesting which reporting mode is
  // enabled.
#if BUILDFLAG(HAS_MEMORY_TAGGING)
  constexpr FreeNotificationData& SetMteReportingMode(MTEMode mode) {
    mte_reporting_mode_ = mode;
    return *this;
  }
#endif  // BUILDFLAG(HAS_MEMORY_TAGGING)

  constexpr MTEMode mte_reporting_mode() const {
#if BUILDFLAG(HAS_MEMORY_TAGGING)
    return mte_reporting_mode_;
#else
    return MTEMode::kUndefined;
#endif  // BUILDFLAG(HAS_MEMORY_TAGGING)
  }

 private:
  void* address_ = nullptr;
#if BUILDFLAG(HAS_MEMORY_TAGGING)
  MTEMode mte_reporting_mode_ = MTEMode::kUndefined;
#endif  // BUILDFLAG(HAS_MEMORY_TAGGING)
  AllocationSubsystem allocation_subsystem_;
};

}  // namespace base::allocator::dispatcher
#endif  // BASE_ALLOCATOR_DISPATCHER_NOTIFICATION_DATA_H_