OgreMemoryStdAlloc.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OGRE
(Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2011 Torus Knot Software Ltd

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/

#ifndef __MemoryStdAlloc_H__
#define __MemoryStdAlloc_H__

#include <memory>
#include <limits>

#include "OgreAlignedAllocator.h"
#include "OgreMemoryTracker.h"

namespace Ogre
{
#if OGRE_MEMORY_ALLOCATOR == OGRE_MEMORY_ALLOCATOR_STD

    class _OgreExport StdAllocPolicy
    {
    public:
        static inline void* allocateBytes(size_t count, 
#if OGRE_MEMORY_TRACKER
            const char* file = 0, int line = 0, const char* func = 0
#else
            const char*  = 0, int  = 0, const char* = 0
#endif
            )
        {
            void* ptr = malloc(count);
#if OGRE_MEMORY_TRACKER
            // this alloc policy doesn't do pools
            MemoryTracker::get()._recordAlloc(ptr, count, 0, file, line, func);
#endif
            return ptr;
        }

        static inline void deallocateBytes(void* ptr)
        {
#if OGRE_MEMORY_TRACKER
            MemoryTracker::get()._recordDealloc(ptr);
#endif
            free(ptr);
        }

        static inline size_t getMaxAllocationSize()
        {
            return std::numeric_limits<size_t>::max();
        }
    private:
        // no instantiation
        StdAllocPolicy()
        { }
    };

    template <size_t Alignment = 0>
    class StdAlignedAllocPolicy
    {
    public:
        // compile-time check alignment is available.
        typedef int IsValidAlignment
            [Alignment <= 128 && ((Alignment & (Alignment-1)) == 0) ? +1 : -1];

        static inline void* allocateBytes(size_t count, 
#if OGRE_MEMORY_TRACKER
            const char* file = 0, int line = 0, const char* func = 0
#else
            const char*  = 0, int  = 0, const char* = 0
#endif
            )
        {
            void* ptr = Alignment ? AlignedMemory::allocate(count, Alignment)
                : AlignedMemory::allocate(count);
#if OGRE_MEMORY_TRACKER
            // this alloc policy doesn't do pools
            MemoryTracker::get()._recordAlloc(ptr, count, 0, file, line, func);
#endif
            return ptr;
        }

        static inline void deallocateBytes(void* ptr)
        {
#if OGRE_MEMORY_TRACKER
            MemoryTracker::get()._recordDealloc(ptr);
#endif
            AlignedMemory::deallocate(ptr);
        }

        static inline size_t getMaxAllocationSize()
        {
            return std::numeric_limits<size_t>::max();
        }
    private:
        // No instantiation
        StdAlignedAllocPolicy()
        { }
    };

#endif

}// namespace Ogre

#endif // __MemoryStdAlloc_H__