parallelTaskWaitlist.h

Go to the documentation of this file.

//
// Copyright 2025 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_EXEC_VDF_PARALLEL_TASK_WAITLIST_H
#define PXR_EXEC_VDF_PARALLEL_TASK_WAITLIST_H
 
 
#include "pxr/pxr.h"
 
#include "pxr/exec/vdf/api.h"
 
#include "pxr/base/work/taskGraph.h"
 
#include <tbb/concurrent_vector.h>
 
#include <atomic>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class VdfParallelTaskWaitlist
{
public:
    struct Node;
    using HeadPtr = std::atomic<Node*>;
 
    VdfParallelTaskWaitlist(const VdfParallelTaskWaitlist &) = delete;
    VdfParallelTaskWaitlist &operator=(const VdfParallelTaskWaitlist &) =
        delete;
 
    VDF_API
    explicit VdfParallelTaskWaitlist(size_t numReserved = 0);
 
    VDF_API
    ~VdfParallelTaskWaitlist();
 
    VDF_API
    void Rewind();
 
    VDF_API
    bool WaitOn(HeadPtr *headPtr, WorkTaskGraph::BaseTask *successor);
 
    VDF_API
    bool CloseAndNotify(HeadPtr *headPtr, WorkTaskGraph *taskGraph);
 
private:
    // Allocate a new node for a waiting queue.
    //
    VDF_API
    Node *_AllocateNode(WorkTaskGraph::BaseTask *task, Node *next);
 
    // A simple vector that serves as a way of scratch-allocating new
    // waiting nodes.
    //
    tbb::concurrent_vector<Node> _allocator;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif