SF_AllocInfo.h

Go to the documentation of this file.

/*
* Copyright 2015 Autodesk, Inc. All rights reserved.
* Use of this software is subject to the terms of the Autodesk license agreement and any attachments or Appendices thereto provided at the time of installation or download,
* or which otherwise accompanies this software in either electronic or hard copy form, or which is signed by you and accepted by Autodesk.
*/

/**************************************************************************

PublicHeader:   Kernel
Filename    :   KY_AllocInfo.h
Content     :   Allocator Debugging Support
Created     :   October 1, 2008
Authors     :   Michael Antonov, Maxim Shemanarev

**************************************************************************/

#ifndef INC_KY_Kernel_AllocInfo_H
#define INC_KY_Kernel_AllocInfo_H

#include "gwnavruntime/kernel/SF_Stats.h"

namespace Kaim {


// ***** Allocator Debugging Support
//
// Debugging support is optionally stored with every allocation.
// This consists of the following pieces of info:
//  - StatId, used to identify and group allocation for statistic reporting.
//  - Line + FileName, used to report the memory leaks when heap
//    is released as a whole.
//------------------------------------------------------------------------
struct AllocInfo
{
    // User-specified identifier for allocation.
    unsigned    StatId;

#if defined(KY_BUILD_DEBUG)
    // Track location in code where allocation took place
    // so that it can be reported to debug leaks.
    unsigned    Line;
    const char* pFileName;

    AllocInfo()
        : StatId(Stat_Default_Mem), Line(0), pFileName("")
    { }
    AllocInfo(unsigned statId, const char* pfile, unsigned line)
        : StatId(statId), Line(line), pFileName(pfile)
    { }
    AllocInfo(const AllocInfo& src)
        : StatId(src.StatId), Line(src.Line), pFileName(src.pFileName)
    { }

#else

    AllocInfo() : StatId(Stat_Default_Mem)
    { }
    AllocInfo(unsigned statId, const char*, unsigned) : StatId(statId)
    { }
    AllocInfo(const AllocInfo& src) : StatId(src.StatId)
    { }

#endif

    // Note that we don't store the original Size here, since it is 
    // passed as a separate argument and we want to avoid such overhead.
};

} // Scaleform

#endif