Allocator.h

Go to the documentation of this file.

/*
 * Copyright (C) 2015 Niek Linnenbank
 *
 * This program 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/>.
 */
 
#ifndef __LIBALLOC_ALLOCATOR_H
#define __LIBALLOC_ALLOCATOR_H
#ifndef __ASSEMBLER__
 
#include <Macros.h>
#include <Types.h>
 
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wnew-returns-null"
 
class Allocator
{
  public:
 
    enum Result
    {
        Success = 0,
        InvalidAddress,
        InvalidSize,
        InvalidAlignment,
        OutOfMemory
    };
 
    typedef struct Range
    {
        Address address; 
        Size size;       
        Size alignment;  
    } Range;
 
  public:
 
    Allocator();
 
    Allocator(const Range range);
 
    virtual ~Allocator();
 
    static void setDefault(Allocator *alloc);
 
    static Allocator *getDefault();
 
    void setParent(Allocator *parent);
 
    Allocator * parent();
 
    Address base() const;
 
    Size alignment() const;
 
    virtual Size size() const;
 
    virtual Size available() const;
 
    virtual Result allocate(Range & range);
 
    virtual Result release(const Address addr);
 
  protected:
 
    Address aligned(const Address addr, const Size boundary) const;
 
  private:
 
    static Allocator *m_default;
 
    Allocator *m_parent;
 
    Range m_range;
};
 
#ifndef __HOST__
 
inline void * operator new(__SIZE_TYPE__ sz)
{
    Allocator::Range alloc_args;
 
    alloc_args.size = sz;
    alloc_args.alignment = 0;
 
    if (Allocator::getDefault()->allocate(alloc_args) == Allocator::Success)
        return (void *) alloc_args.address;
    else
        return (void *) NULL;
}
 
inline void * operator new[](__SIZE_TYPE__ sz)
{
    Allocator::Range alloc_args;
 
    alloc_args.size = sz;
    alloc_args.alignment = 0;
 
    if (Allocator::getDefault()->allocate(alloc_args) == Allocator::Success)
        return (void *) alloc_args.address;
    else
        return (void *) NULL;
}
 
inline void operator delete (void *mem)
{
    Allocator::getDefault()->release((Address)mem);
}
 
inline void operator delete[] (void *mem)
{
    Allocator::getDefault()->release((Address)mem);
}
 
#endif /* __HOST__ */
 
inline void * operator new(__SIZE_TYPE__ sz, Address addr)
{
    return (void *) addr;
}
 
#endif /* __ASSEMBLER__ */
#endif /* __LIBALLOC_ALLOCATOR_H */