MemoryContext.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 __LIBARCH_MEMORYCONTEXT_H
#define __LIBARCH_MEMORYCONTEXT_H
 
#include <Types.h>
#include <Macros.h>
#include <BitOperations.h>
#include <Callback.h>
#include "Memory.h"
#include "MemoryMap.h"
 
class SplitAllocator;
 
class MemoryContext
{
  public:
 
    typedef enum Result
    {
        Success,
        InvalidAddress,
        InvalidSize,
        AlreadyExists,
        OutOfMemory,
        InvalidArgs,
    }
    Result;
 
    MemoryContext(MemoryMap *map, SplitAllocator *alloc);
 
    virtual ~MemoryContext();
 
    static MemoryContext * getCurrent();
 
    virtual Result initialize() = 0;
 
    virtual Result activate(bool initializeMMU = false) = 0;
 
    virtual Result map(Address virt, Address phys, Memory::Access access) = 0;
 
    virtual Result unmap(Address virt) = 0;
 
    virtual Result lookup(Address virt, Address *phys) const = 0;
 
    virtual Result access(Address virt, Memory::Access *access) const = 0;
 
    virtual Result mapRangeContiguous(Memory::Range *range);
 
    virtual Result mapRangeSparse(Memory::Range *range);
 
    virtual Result unmapRange(Memory::Range *range);
 
    virtual Result release(Address virt);
 
    virtual Result releaseRange(Memory::Range *range) = 0;
 
    virtual Result releaseSection(const Memory::Range & range,
                                  const bool tablesOnly = false) = 0;
 
    virtual Result findFree(Size size, MemoryMap::Region region, Address *virt) const;
 
    virtual void mapRangeSparseCallback(Address *phys);
 
  protected:
 
    SplitAllocator *m_alloc;
 
    MemoryMap *m_map;
 
    static MemoryContext *m_current;
 
    Callback<MemoryContext, Address> m_mapRangeSparseCallback;
 
    Memory::Range *m_savedRange;
 
    Size m_numSparsePages;
};
 
#endif /* __LIBARCH_MEMORYCONTEXT_H */