1/*
2 * Copyright (C) 2014 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef ART_RUNTIME_BASE_ARENA_OBJECT_H_
18#define ART_RUNTIME_BASE_ARENA_OBJECT_H_
19
20#include "base/arena_allocator.h"
21#include "base/logging.h"
22#include "scoped_arena_allocator.h"
23
24namespace art {
25
26// Parent for arena allocated objects giving appropriate new and delete operators.
27template<enum ArenaAllocKind kAllocKind>
28class ArenaObject {
29 public:
30  // Allocate a new ArenaObject of 'size' bytes in the Arena.
31  void* operator new(size_t size, ArenaAllocator* allocator) {
32    return allocator->Alloc(size, kAllocKind);
33  }
34
35  static void* operator new(size_t size, ScopedArenaAllocator* arena) {
36    return arena->Alloc(size, kAllocKind);
37  }
38
39  void operator delete(void*, size_t) {
40    LOG(FATAL) << "UNREACHABLE";
41    UNREACHABLE();
42  }
43
44  // NOTE: Providing placement new (and matching delete) for constructing container elements.
45  ALWAYS_INLINE void* operator new(size_t, void* ptr) noexcept { return ptr; }
46  ALWAYS_INLINE void operator delete(void*, void*) noexcept { }
47};
48
49
50// Parent for arena allocated objects that get deleted, gives appropriate new and delete operators.
51template<enum ArenaAllocKind kAllocKind>
52class DeletableArenaObject {
53 public:
54  // Allocate a new ArenaObject of 'size' bytes in the Arena.
55  void* operator new(size_t size, ArenaAllocator* allocator) {
56    return allocator->Alloc(size, kAllocKind);
57  }
58
59  static void* operator new(size_t size, ScopedArenaAllocator* arena) {
60    return arena->Alloc(size, kAllocKind);
61  }
62
63  void operator delete(void*, size_t) {
64    // Nop.
65  }
66};
67
68}  // namespace art
69
70#endif  // ART_RUNTIME_BASE_ARENA_OBJECT_H_
71