toolkit/NvBlastTkGroup.h

File members: toolkit/NvBlastTkGroup.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) 2016-2024 NVIDIA Corporation. All rights reserved.

#ifndef NVBLASTTKGROUP_H
#define NVBLASTTKGROUP_H

#include "NvBlastTkIdentifiable.h"

namespace Nv
{
namespace Blast
{

// Forward declarations
class TkActor;

struct TkGroupDesc
{
    uint32_t        workerCount;
};

struct TkGroupStats
{
    NvBlastTimers   timers;
    uint32_t        processedActorsCount;
    int64_t         workerTime;
};

class TkGroupWorker
{
public:
    virtual void    process(uint32_t jobId) = 0;
};

class TkGroup : public TkIdentifiable
{
public:
    virtual bool            addActor(TkActor& actor) = 0;

    virtual uint32_t        getActorCount() const = 0;

    virtual uint32_t        getActors(TkActor** buffer, uint32_t bufferSize, uint32_t indexStart = 0) const = 0;

    virtual uint32_t        startProcess() = 0;

    virtual bool            endProcess() = 0;

    virtual void            setWorkerCount(uint32_t workerCount) = 0;

    virtual uint32_t        getWorkerCount() const = 0;

    virtual TkGroupWorker*  acquireWorker() = 0;

    virtual void            returnWorker(TkGroupWorker*) = 0;

            void            process();

    virtual void            getStats(TkGroupStats& stats) const = 0;
};

} // namespace Blast
} // namespace Nv

NV_INLINE void Nv::Blast::TkGroup::process()
{
    uint32_t jobCount = startProcess();
    if (jobCount > 0)
    {
        TkGroupWorker* worker = acquireWorker();
        for (uint32_t i = 0; i < jobCount; i++)
        {
            worker->process(i);
        }
        returnWorker(worker);
    }
    endProcess();
}

#endif // ifndef NVBLASTTKGROUP_H