FreeNOS
BitAllocator.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2015 Niek Linnenbank
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 3 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program. If not, see <http://www.gnu.org/licenses/>.
16  */
17 
18 #ifndef __LIBALLOC_BITALLOCATOR_H
19 #define __LIBALLOC_BITALLOCATOR_H
20 
21 #include <BitArray.h>
22 #include <Types.h>
23 #include "Allocator.h"
24 
40 class BitAllocator : public Allocator
41 {
42  public:
43 
52  BitAllocator(const Range range,
53  const Size chunkSize,
54  u8 *bitmap = ZERO);
55 
61  Size chunkSize() const;
62 
68  virtual Size available() const;
69 
79  virtual Result allocate(Range & args);
80 
91  Result allocateFrom(Range & args, const Size startBit);
92 
100  Result allocateAt(const Address addr);
101 
107  bool isAllocated(const Address page) const;
108 
115  virtual Result release(const Address chunk);
116 
117  private:
118 
121 
124 
127 };
128 
134 #endif /* __LIBALLOC_BITALLOCATOR_H */
BitAllocator::allocateFrom
Result allocateFrom(Range &args, const Size startBit)
Allocate memory from defined starting address.
Definition: BitAllocator.cpp:52
Types.h
BitAllocator::chunkSize
Size chunkSize() const
Get chunk size.
Definition: BitAllocator.cpp:31
Allocator.h
Allocator
Memory Allocator.
Definition: Allocator.h:46
BitAllocator::isAllocated
bool isAllocated(const Address page) const
Check if a chunk is allocated.
Definition: BitAllocator.cpp:88
BitAllocator::allocateAt
Result allocateAt(const Address addr)
Allocate a specific address.
Definition: BitAllocator.cpp:80
Address
unsigned long Address
A memory address.
Definition: Types.h:131
BitAllocator::available
virtual Size available() const
Get available memory.
Definition: BitAllocator.cpp:36
BitAllocator::m_array
BitArray m_array
Marks which chunks are (un)used.
Definition: BitAllocator.h:120
BitAllocator::release
virtual Result release(const Address chunk)
Release memory chunk.
Definition: BitAllocator.cpp:97
BitAllocator::m_lastBit
Size m_lastBit
Last bit that was set.
Definition: BitAllocator.h:126
Size
unsigned int Size
Any sane size indicator cannot go negative.
Definition: Types.h:128
Allocator::Range
Describes a range of memory.
Definition: Allocator.h:65
BitAllocator::BitAllocator
BitAllocator(const Range range, const Size chunkSize, u8 *bitmap=ZERO)
Constructor function.
Definition: BitAllocator.cpp:21
u8
unsigned char u8
Unsigned 8-bit number.
Definition: Types.h:59
BitAllocator
Bit memory allocator.
Definition: BitAllocator.h:40
ZERO
#define ZERO
Zero value.
Definition: Macros.h:43
BitAllocator::allocate
virtual Result allocate(Range &args)
Allocate memory.
Definition: BitAllocator.cpp:41
BitArray.h
BitAllocator::m_chunkSize
const Size m_chunkSize
Size of each chunk.
Definition: BitAllocator.h:123
BitArray
Represents an array of bits.
Definition: BitArray.h:36
Allocator::Result
Result
Allocation results.
Definition: Allocator.h:53