idata_distribution.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright 2023 NVIDIA Corporation. All rights reserved.
 *****************************************************************************/
 
#ifndef NVIDIA_INDEX_IDATA_DISTRIBUTION_H
#define NVIDIA_INDEX_IDATA_DISTRIBUTION_H
 
#include <mi/dice.h>
#include <mi/base/interface_declare.h>
#include <mi/neuraylib/iserializer.h>
 
#include <nv/index/idistributed_data_edit.h>
#include <nv/index/idistributed_data_locality.h>
 
namespace nv
{
namespace index
{
 
class IDistributed_data_job :
    public mi::base::Interface_declare<0x841224fe,0x3c17,0x43b3,0xaa,0xc8,0xbc,0x32,0x72,0xc8,0x44,0xf1,
                                       mi::neuraylib::ISerializable>
{
public:
    virtual IDistributed_data_locality_query_mode* get_scheduling_mode() const = 0;
 
    virtual void receive_data_locality(
        IDistributed_data_locality* determined_locality) = 0;
 
    virtual void execute_subset(
        mi::neuraylib::IDice_transaction*                   dice_transaction,
        const nv::index::IData_distribution*                data_distribution,
        nv::index::IData_subset_compute_task_processing*    data_subset_processing,
        mi::Size                                            data_subset_index,      // not to confuse with subset data ID
        mi::Size                                            data_subset_count) = 0;
 
    virtual void execute_subset_remote(
        mi::neuraylib::ISerializer*                         serializer,
        mi::neuraylib::IDice_transaction*                   dice_transaction,
        const nv::index::IData_distribution*                data_distribution,
        nv::index::IData_subset_compute_task_processing*    data_subset_processing,
        mi::Size                                            data_subset_index,
        mi::Size                                            data_subset_count) = 0;
 
    virtual void receive_subset_result(
        mi::neuraylib::IDeserializer*           deserializer,
        mi::neuraylib::IDice_transaction*       dice_transaction,
        const nv::index::IData_distribution*    data_distribution,
        mi::Size                                data_subset_index,
        mi::Size                                data_subset_count) = 0;
};
 
template <mi::Uint32 id1, mi::Uint16 id2, mi::Uint16 id3,
          mi::Uint8  id4, mi::Uint8  id5, mi::Uint8  id6,  mi::Uint8 id7,
          mi::Uint8  id8, mi::Uint8  id9, mi::Uint8  id10, mi::Uint8 id11,
          class I = IDistributed_data_job>
class Distributed_data_job : public mi::neuraylib::Base<id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11, I>
{
public:
    virtual void receive_data_locality(
        IDistributed_data_locality* determined_locality)
    {
        (void)determined_locality;   // avoid unused warnings
        return; /* do nothing */
    }
};
 
class IDistributed_data_job_scheduler :
    public mi::base::Interface_declare<0x91224ed0,0x6e2a,0x48c9,0xb1,0x79,0x61,0x8e,0x22,0xd2,0x5e,0xf2,
                                       mi::base::IInterface>
{
public:
    virtual mi::Sint32 execute(
        IDistributed_data_job*                  job,
        mi::neuraylib::IDice_transaction*       dice_transaction) const = 0;
};
 
}} // namespace index / nv
 
#endif // NVIDIA_INDEX_IDATA_DISTRIBUTION_H