SF_StackRegistry.h

Go to the documentation of this file.

/*
* Copyright 2016 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.
*/

#pragma once

#include "gwnavruntime/base/types.h"

#if defined(KY_ENABLE_STACK_REGISTRY)

#include "gwnavruntime/kernel/SF_Alg.h"
#include "gwnavruntime/kernel/SF_Atomic.h"

namespace Kaim
{

#define MAX_STACK_DEPTH 32
#define MAX_NAME_LENGTH 256

class StackRef
{
public:
    StackRef(void* stack, KyUInt32 frameCount, UPInt size) : m_frameCount(frameCount), m_size(size)
    {
        Alg::MemUtil::Copy(m_stack, stack, sizeof(void*) * frameCount);
    }

    ~StackRef() { }

    KyUInt32 GetFrameCount() const { return m_frameCount; }
    void* GetFrame(KyUInt32 frameIndex) const { return m_stack[frameIndex]; }
    UPInt GetSize() const { return m_size; }

private:
    void*    m_stack[MAX_STACK_DEPTH];
    KyUInt32 m_frameCount;
    UPInt    m_size;
};

class StackRegistryImpl;

class StackRegistry
{
    KY_CLASS_WITHOUT_COPY(StackRegistry)
public: // internal - you shouldn't need to access any of these functions by hand.
    static void Initialize(bool initSymbolTable);
    static void Clear();

    static void MapCurrentStackToUid(UPInt uid, UPInt size); // uid is typically a void*
    static void UnMapStackFromUid(UPInt uid);

    static KyUInt32 GetCount();
    static void Report(); // Outputs all the stack that have not been removed.

private:
    StackRegistry() : m_initialized(false), m_impl(nullptr) { }
    ~StackRegistry() { m_impl = nullptr; }

    static StackRegistry& Instance() { static StackRegistry s_instance; return s_instance; }

    bool                m_initialized;
    StackRegistryImpl*  m_impl;
    Lock                m_lock;
};

}

#endif // KY_ENABLE_STACK_REGISTRY