btThreadSupportInterface.h

Go to the documentation of this file.

/*
Bullet Continuous Collision Detection and Physics Library
Copyright (c) 2003-2018 Erwin Coumans  http://bulletphysics.com

This software is provided 'as-is', without any express or implied warranty.
In no event will the authors be held liable for any damages arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it freely,
subject to the following restrictions:

1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
*/

#ifndef BT_THREAD_SUPPORT_INTERFACE_H
#define BT_THREAD_SUPPORT_INTERFACE_H



class btCriticalSection
{
public:
    btCriticalSection() {}
    virtual ~btCriticalSection() {}

    virtual void lock() = 0;
    virtual void unlock() = 0;
};


class btThreadSupportInterface
{
public:

    virtual ~btThreadSupportInterface() {}

    virtual int getNumWorkerThreads() const = 0;  // number of worker threads (total number of logical processors - 1)
    virtual int getCacheFriendlyNumThreads() const = 0;  // the number of logical processors sharing a single L3 cache
    virtual int getLogicalToPhysicalCoreRatio() const = 0;  // the number of logical processors per physical processor (usually 1 or 2)
    virtual void runTask( int threadIndex, void* userData ) = 0;
    virtual void waitForAllTasks() = 0;

    virtual btCriticalSection* createCriticalSection() = 0;
    virtual void deleteCriticalSection( btCriticalSection* criticalSection ) = 0;

    typedef void( *ThreadFunc )( void* userPtr );

    struct ConstructionInfo
    {
        ConstructionInfo( const char* uniqueName,
            ThreadFunc userThreadFunc,
            int threadStackSize = 65535
        )
            :m_uniqueName( uniqueName ),
            m_userThreadFunc( userThreadFunc ),
            m_threadStackSize( threadStackSize )
        {
        }

        const char*     m_uniqueName;
        ThreadFunc      m_userThreadFunc;
        int             m_threadStackSize;
    };

    static btThreadSupportInterface* create( const ConstructionInfo& info );
};

#endif //BT_THREAD_SUPPORT_INTERFACE_H