PxcNpThreadContext.h

// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of NVIDIA CORPORATION nor the names of its
//    contributors may be used to endorse or promote products derived
//    from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Copyright (c) 2008-2022 NVIDIA Corporation. All rights reserved.
// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.  
 
#ifndef PXC_NP_THREAD_CONTEXT_H
#define PXC_NP_THREAD_CONTEXT_H
 
#include "geometry/PxGeometry.h"
#include "geomutils/PxContactBuffer.h"
#include "common/PxRenderOutput.h"
 
#include "CmRenderBuffer.h"
 
#include "PxvConfig.h"
#include "CmScaling.h"
#include "PxcNpCacheStreamPair.h"
#include "PxcConstraintBlockStream.h"
#include "PxcThreadCoherentCache.h"
#include "PxcScratchAllocator.h"
#include "foundation/PxBitMap.h"
#include "../pcm/GuPersistentContactManifold.h"
#include "../contact/GuContactMethodImpl.h"
 
namespace physx
{
 
class PxsTransformCache;
class PxsMaterialManager;
 
namespace Sc
{
    class BodySim;
}
   
struct PxcDataStreamPool
{
    PxU8* mDataStream;
    PxI32 mSharedDataIndex;
    PxU32 mDataStreamSize;
    PxU32 mSharedDataIndexGPU;
 
    bool isOverflown()  const
    {
        //FD: my expectaton is that reading those variables is atomic, shared indices are non-decreasing, 
        //so we can only get a false overflow alert because of concurrency issues, which is not a big deal as it means 
        //it did overflow a bit later  
        return (mSharedDataIndex + mSharedDataIndexGPU) > mDataStreamSize;
    }
};
 
struct PxcNpContext
{
    private:
                                                PX_NOCOPY(PxcNpContext)
    public:
 
                                                PxcNpContext() :
                                                    mNpMemBlockPool         (mScratchAllocator),
                                                    mMeshContactMargin      (0.0f),
                                                    mToleranceLength        (0.0f),
                                                    mContactStreamPool      (NULL),
                                                    mPatchStreamPool        (NULL),
                                                    mForceAndIndiceStreamPool(NULL),
                                                    mMaterialManager        (NULL)
                                                {
                                                }
 
                    PxcScratchAllocator         mScratchAllocator;
                    PxcNpMemBlockPool           mNpMemBlockPool;
                    PxReal                      mMeshContactMargin;
                    PxReal                      mToleranceLength;
                    Cm::RenderBuffer            mRenderBuffer;
                    PxcDataStreamPool*          mContactStreamPool;
                    PxcDataStreamPool*          mPatchStreamPool;
                    PxcDataStreamPool*          mForceAndIndiceStreamPool;
                    PxcDataStreamPool*          mConstraintWriteBackStreamPool;
                    PxsMaterialManager*         mMaterialManager;
 
    PX_FORCE_INLINE PxReal                      getToleranceLength()        const   { return mToleranceLength;                  }
    PX_FORCE_INLINE void                        setToleranceLength(PxReal x)        { mToleranceLength = x;                     }
    PX_FORCE_INLINE PxReal                      getMeshContactMargin()      const   { return mMeshContactMargin;                }
    PX_FORCE_INLINE void                        setMeshContactMargin(PxReal x)      { mMeshContactMargin = x;                   }
 
    PX_FORCE_INLINE PxcNpMemBlockPool&          getNpMemBlockPool()                 { return mNpMemBlockPool;                   }
    PX_FORCE_INLINE const PxcNpMemBlockPool&    getNpMemBlockPool()         const   { return mNpMemBlockPool;                   }
    PX_FORCE_INLINE void                        setMaterialManager(PxsMaterialManager* m){ mMaterialManager = m;                }
    PX_FORCE_INLINE PxsMaterialManager*         getMaterialManager() const          { return mMaterialManager;                  }
};
 
class PxcNpThreadContext : public PxcThreadCoherentCache<PxcNpThreadContext, PxcNpContext>::EntryBase
{
                                                PX_NOCOPY(PxcNpThreadContext)
public:
                                                PxcNpThreadContext(PxcNpContext* params);
                                                ~PxcNpThreadContext();
 
#if PX_ENABLE_SIM_STATS
                    void                        clearStats();
#else
                    PX_CATCH_UNDEFINED_ENABLE_SIM_STATS
#endif
 
    PX_FORCE_INLINE void                        addLocalNewTouchCount(PxU32 newTouchCMCount)    { mLocalNewTouchCount += newTouchCMCount;   }
    PX_FORCE_INLINE void                        addLocalLostTouchCount(PxU32 lostTouchCMCount)  { mLocalLostTouchCount += lostTouchCMCount; }
    PX_FORCE_INLINE PxU32                       getLocalNewTouchCount()                 const   { return mLocalNewTouchCount;               }
    PX_FORCE_INLINE PxU32                       getLocalLostTouchCount()                const   { return mLocalLostTouchCount;              }
 
 
    PX_FORCE_INLINE PxBitMap&                   getLocalChangeTouch()                           { return mLocalChangeTouch;                 }
 
    void                                        reset(PxU32 cmCount);
    // debugging
                        PxRenderOutput          mRenderOutput;
 
    // dsequeira: Need to think about this block pool allocation a bit more. Ideally we'd be 
    // taking blocks from a single pool, except that we want to be able to selectively reclaim
    // blocks if the user needs to defragment, depending on which artifacts they're willing
    // to tolerate, such that the blocks we don't reclaim are contiguous.
#if PX_ENABLE_SIM_STATS
                    PxU32                       mDiscreteContactPairs   [PxGeometryType::eGEOMETRY_COUNT][PxGeometryType::eGEOMETRY_COUNT];
                    PxU32                       mModifiedContactPairs   [PxGeometryType::eGEOMETRY_COUNT][PxGeometryType::eGEOMETRY_COUNT];
#else
                    PX_CATCH_UNDEFINED_ENABLE_SIM_STATS
#endif
                    PxcContactBlockStream       mContactBlockStream;        // constraint block pool
                    PxcNpCacheStreamPair        mNpCacheStreamPair;         // narrow phase pairwise data cache
 
    // Everything below here is scratch state. Most of it can even overlap.
 
    // temporary contact buffer
                    PxContactBuffer             mContactBuffer;    
 
    PX_ALIGN(16, Gu::MultiplePersistentContactManifold      mTempManifold); 
 
                    Gu::NarrowPhaseParams       mNarrowPhaseParams;
 
    // DS: this stuff got moved here from the PxcNpPairContext. As Pierre says:
                    PxArray<Sc::BodySim*>       mBodySimPool;
                    PxsTransformCache*          mTransformCache;
                    const PxReal*               mContactDistances;
                    bool                        mPCM;
                    bool                        mContactCache;
                    bool                        mCreateAveragePoint;    // flag to enforce whether we create average points
#if PX_ENABLE_SIM_STATS
                    PxU32                       mCompressedCacheSize;
                    PxU32                       mNbDiscreteContactPairsWithCacheHits;
                    PxU32                       mNbDiscreteContactPairsWithContacts;
#else
                    PX_CATCH_UNDEFINED_ENABLE_SIM_STATS
#endif
                    PxReal                      mDt; // AP: still needed for ccd
                    PxU32                       mCCDPass;
                    PxU32                       mCCDFaceIndex;
 
                    PxU32                       mMaxPatches;
                    //PxU32                     mTotalContactCount;
                    PxU32                       mTotalCompressedCacheSize;
                    //PxU32                     mTotalPatchCount;
 
                    PxcDataStreamPool*          mContactStreamPool;
                    PxcDataStreamPool*          mPatchStreamPool;
                    PxcDataStreamPool*          mForceAndIndiceStreamPool; //this stream is used to store the force buffer and triangle index if we are performing mesh/heightfield contact gen
                    PxcDataStreamPool*          mConstraintWriteBackStreamPool;
                    PxsMaterialManager*         mMaterialManager;
private:
        // change touch handling.
                    PxBitMap                    mLocalChangeTouch;
                    PxU32                       mLocalNewTouchCount;
                    PxU32                       mLocalLostTouchCount;
};
 
}
 
#endif