raw_data.h

/*
//@HEADER
// *****************************************************************************
//
//                                  raw_data.h
//                       DARMA/vt => Virtual Transport
//
// Copyright 2019-2021 National Technology & Engineering Solutions of Sandia, LLC
// (NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the U.S.
// Government retains certain rights in this software.
//
// 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 the copyright holder 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 AND CONTRIBUTORS "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.
//
// Questions? Contact darma@sandia.gov
//
// *****************************************************************************
//@HEADER
*/

#if !defined INCLUDED_VT_VRT_COLLECTION_BALANCE_MODEL_RAW_DATA_H
#define INCLUDED_VT_VRT_COLLECTION_BALANCE_MODEL_RAW_DATA_H

#include "vt/vrt/collection/balance/model/load_model.h"
#include "vt/elm/elm_comm.h"
#include <unordered_map>

namespace vt { namespace vrt { namespace collection { namespace balance {

/**
 * \brief A strictly retrospective view of the recorded object timings
 *
 * For use with load balancers, this must typically be stacked beneath
 * a model that predicts future loads, such as NaivePersistence
 */
struct RawData : public LoadModel {
  RawData() = default;
  void updateLoads(PhaseType last_completed_phase) override;
  LoadType getModeledLoad(ElementIDStruct object, PhaseOffset when) const override;
  bool hasRawLoad() const override { return true; }
  LoadType getRawLoad(ElementIDStruct object, PhaseOffset when) const override;
  bool hasUserData() const override { return user_data_ != nullptr; }
  ElmUserDataType getUserData(ElementIDStruct object, PhaseOffset when) const override;
  CommMapType getComm(PhaseOffset when) const override;

  void setLoads(std::unordered_map<PhaseType, LoadMapType> const* proc_load,
                std::unordered_map<PhaseType, CommMapType> const* proc_comm,
                std::unordered_map<PhaseType, DataMapType> const* user_data) override;

  ObjectIterator begin() const override;

  int getNumObjects() const override;
  unsigned int getNumCompletedPhases() const override;
  int getNumSubphases() const override;
  unsigned int getNumPastPhasesNeeded(unsigned int look_back) const override;

  // Observer pointers to the underlying data. In operation, these would be owned by NodeLBData
  std::unordered_map<PhaseType, LoadMapType>         const* proc_load_;
  std::unordered_map<PhaseType, CommMapType>         const* proc_comm_;
  std::unordered_map<PhaseType, DataMapType>         const* user_data_;
  PhaseType last_completed_phase_ = ~0;
}; // class RawData

}}}} // end namespace

#endif