-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
MemoryAllocator.java
58 lines (52 loc) · 2 KB
/
MemoryAllocator.java
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
/*
* Copyright (c) 2002-2018 "Neo Technology,"
* Network Engine for Objects in Lund AB [http://neotechnology.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.neo4j.io.mem;
import org.neo4j.io.ByteUnit;
import org.neo4j.memory.MemoryAllocationTracker;
/**
* A MemoryAllocator is simple: it only allocates memory, until it itself is finalizable and frees it all in one go.
*/
public interface MemoryAllocator
{
static MemoryAllocator createAllocator( String expectedMemory, MemoryAllocationTracker memoryTracker )
{
return new GrabAllocator( ByteUnit.parse( expectedMemory ), memoryTracker );
}
/**
* @return The sum, in bytes, of all the memory currently allocating through this allocator.
*/
long usedMemory();
/**
* @return The amount of available memory, in bytes.
*/
long availableMemory();
/**
* Allocate a contiguous, aligned region of memory of the given size in bytes.
* @param bytes the number of bytes to allocate.
* @param alignment The byte multiple that the allocated pointers have to be aligned at.
* @return A pointer to the allocated memory.
* @throws OutOfMemoryError if the requested memory could not be allocated.
*/
long allocateAligned( long bytes, long alignment );
/**
* Close all allocated resources and free all allocated memory.
*/
void close();
}