blob: 06884c23d4d3323315eee7a149c06ddbb6dfb715 [file] [log] [blame]
Nicolas Geoffray818f2102014-02-18 16:43:35 +00001/*
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
Mathieu Chartierb666f482015-02-18 14:33:14 -080017#ifndef ART_RUNTIME_BASE_ARENA_OBJECT_H_
18#define ART_RUNTIME_BASE_ARENA_OBJECT_H_
Nicolas Geoffray818f2102014-02-18 16:43:35 +000019
Andreas Gampe57943812017-12-06 21:39:13 -080020#include <android-base/logging.h>
21
22#include "arena_allocator.h"
23#include "macros.h"
Ian Rogers6a3c1fc2014-10-31 00:33:20 -070024#include "scoped_arena_allocator.h"
Nicolas Geoffray818f2102014-02-18 16:43:35 +000025
26namespace art {
27
Ian Rogers6a3c1fc2014-10-31 00:33:20 -070028// Parent for arena allocated objects giving appropriate new and delete operators.
29template<enum ArenaAllocKind kAllocKind>
Nicolas Geoffray818f2102014-02-18 16:43:35 +000030class ArenaObject {
31 public:
32 // Allocate a new ArenaObject of 'size' bytes in the Arena.
33 void* operator new(size_t size, ArenaAllocator* allocator) {
Ian Rogers6a3c1fc2014-10-31 00:33:20 -070034 return allocator->Alloc(size, kAllocKind);
35 }
36
Vladimir Markoe764d2e2017-10-05 14:35:55 +010037 static void* operator new(size_t size, ScopedArenaAllocator* allocator) {
38 return allocator->Alloc(size, kAllocKind);
Nicolas Geoffray818f2102014-02-18 16:43:35 +000039 }
40
41 void operator delete(void*, size_t) {
42 LOG(FATAL) << "UNREACHABLE";
Ian Rogers2c4257b2014-10-24 14:20:06 -070043 UNREACHABLE();
Nicolas Geoffray818f2102014-02-18 16:43:35 +000044 }
Vladimir Marko225b6462015-09-28 12:17:40 +010045
46 // NOTE: Providing placement new (and matching delete) for constructing container elements.
47 ALWAYS_INLINE void* operator new(size_t, void* ptr) noexcept { return ptr; }
48 ALWAYS_INLINE void operator delete(void*, void*) noexcept { }
Nicolas Geoffray818f2102014-02-18 16:43:35 +000049};
50
Ian Rogers6a3c1fc2014-10-31 00:33:20 -070051
52// Parent for arena allocated objects that get deleted, gives appropriate new and delete operators.
Ian Rogers6a3c1fc2014-10-31 00:33:20 -070053template<enum ArenaAllocKind kAllocKind>
54class DeletableArenaObject {
55 public:
56 // Allocate a new ArenaObject of 'size' bytes in the Arena.
57 void* operator new(size_t size, ArenaAllocator* allocator) {
58 return allocator->Alloc(size, kAllocKind);
59 }
60
Vladimir Markoe764d2e2017-10-05 14:35:55 +010061 static void* operator new(size_t size, ScopedArenaAllocator* allocator) {
62 return allocator->Alloc(size, kAllocKind);
Ian Rogers6a3c1fc2014-10-31 00:33:20 -070063 }
64
65 void operator delete(void*, size_t) {
66 // Nop.
67 }
68};
69
Nicolas Geoffray818f2102014-02-18 16:43:35 +000070} // namespace art
71
Mathieu Chartierb666f482015-02-18 14:33:14 -080072#endif // ART_RUNTIME_BASE_ARENA_OBJECT_H_