Execution spaces: support for memory backends and execution policies

CMakeLists.txt

@@ -388,6 +388,7 @@ configure_file(
 include_directories(${CMAKE_BINARY_DIR})
 
 include_directories(src/Interface)
+include_directories(src/ExecBackends)
 include_directories(src/Optimization)
 include_directories(src/LinAlg)
 include_directories(src/Utils)

src/CMakeLists.txt

@@ -1,4 +1,5 @@
 add_subdirectory(Interface)
+add_subdirectory(ExecBackends)
 add_subdirectory(Optimization)
 add_subdirectory(LinAlg)
 add_subdirectory(Utils)

src/Drivers/Dense/NlpDenseConsEx1.hpp

@@ -2,7 +2,7 @@
 #define  HIOP_EXAMPLE_DENSE_EX1
 
 #include "hiopVector.hpp"
-#include "hiopLinAlgFactory.hpp"
+#include "LinAlgFactory.hpp"
 #include "hiopNlpFormulation.hpp"
 #include "hiopInterface.hpp"
 #include "hiopAlgFilterIPM.hpp"

src/Drivers/MDS/NlpMdsEx1.hpp

@@ -6,7 +6,7 @@
 //this include is not needed in general
 //we use hiopMatrixDense in this particular example for convienience
 #include "hiopMatrixDenseRowMajor.hpp" 
-#include "hiopLinAlgFactory.hpp"
+#include "LinAlgFactory.hpp"
 
 #ifdef HIOP_USE_MPI
 #include "mpi.h"

src/Drivers/MDS/NlpMdsEx2.hpp

@@ -6,7 +6,7 @@
 //this include is not needed in general
 //we use hiopMatrixDense in this particular example for convienience
 #include "hiopMatrixDense.hpp" 
-#include "hiopLinAlgFactory.hpp"
+#include "LinAlgFactory.hpp"
 
 #ifdef HIOP_USE_MPI
 #include "mpi.h"

src/Drivers/MDS/NlpMdsRajaEx1.cpp

@@ -65,9 +65,28 @@
 #include <hiopMatrixDenseRowMajor.hpp>
 #include <hiopMatrixRajaDense.hpp>
 
-#include <hiop_raja_defs.hpp>
-using ex1_raja_exec = hiop::hiop_raja_exec;
-using ex1_raja_reduce = hiop::hiop_raja_reduce;
+//TODO: A good idea to not use the internal HiOp Raja policies here and, instead, give self-containing
+// definitions of the policies here so that the user gets a better grasp of the concept and does not
+// rely on the internals of HiOp. For example:
+// #define RAJA_LAMBDA [=] __device__
+// using ex1_raja_exec = RAJA::cuda_exec<128>;
+// more defs here
+
+
+#if defined(HIOP_USE_CUDA)
+#include "ExecPoliciesRajaCudaImpl.hpp"
+using ex1_raja_exec = hiop::ExecRajaPoliciesBackend<hiop::ExecPolicyRajaCuda>::hiop_raja_exec;
+using ex1_raja_reduce = hiop::ExecRajaPoliciesBackend<hiop::ExecPolicyRajaCuda>::hiop_raja_reduce;
+#elif defined(HIOP_USE_HIP)
+#include <ExecPoliciesRajaHipImpl.hpp>
+using ex1_raja_exec = hiop::ExecRajaPoliciesBackend<hiop::ExecPolicyRajaHip>::hiop_raja_exec;
+using ex1_raja_reduce = hiop::ExecRajaPoliciesBackend<hiop::ExecPolicyRajaHip>::hiop_raja_reduce;
+#else
+//#if !defined(HIOP_USE_CUDA) && !defined(HIOP_USE_HIP)
+#include <ExecPoliciesRajaOmpImpl.hpp>
+using ex1_raja_exec = hiop::ExecRajaPoliciesBackend<hiop::ExecPolicyRajaOmp>::hiop_raja_exec;
+using ex1_raja_reduce = hiop::ExecRajaPoliciesBackend<hiop::ExecPolicyRajaOmp>::hiop_raja_reduce;
+#endif
 
 using namespace hiop;
 

src/Drivers/MDS/NlpMdsRajaEx1.hpp

@@ -66,7 +66,7 @@
 //this include is not needed in general
 //we use hiopMatrixDense in this particular example for convienience
 #include <hiopMatrixDense.hpp>
-#include <hiopLinAlgFactory.hpp>
+#include <LinAlgFactory.hpp>
 
 #ifdef HIOP_USE_MPI
 #include "mpi.h"

src/Drivers/PriDec/NlpPriDecEx2SparseRaja.cpp

@@ -4,8 +4,21 @@
 
 #include <RAJA/RAJA.hpp>
 
-using ex9_raja_exec = hiop::hiop_raja_exec;
-using ex9_raja_reduce = hiop::hiop_raja_reduce;
+#if defined(HIOP_USE_CUDA)
+#include <ExecPoliciesRajaCudaImpl.hpp>
+using ex9_raja_exec = hiop::ExecRajaPoliciesBackend<hiop::ExecPolicyRajaCuda>::hiop_raja_exec;
+using ex9_raja_reduce = hiop::ExecRajaPoliciesBackend<hiop::ExecPolicyRajaCuda>::hiop_raja_reduce;
+#elif defined(HIOP_USE_HIP)
+#include <ExecPoliciesRajaHipImpl.hpp>
+using ex9_raja_exec = hiop::ExecRajaPoliciesBackend<hiop::ExecPolicyRajaHip>::hiop_raja_exec;
+using ex9_raja_reduce = hiop::ExecRajaPoliciesBackend<hiop::ExecPolicyRajaHip>::hiop_raja_reduce;
+#else
+//#if !defined(HIOP_USE_CUDA) && !defined(HIOP_USE_HIP)
+#include <ExecPoliciesRajaOmpImpl.hpp>
+using ex9_raja_exec = hiop::ExecRajaPoliciesBackend<hiop::ExecPolicyRajaOmp>::hiop_raja_exec;
+using ex9_raja_reduce = hiop::ExecRajaPoliciesBackend<hiop::ExecPolicyRajaOmp>::hiop_raja_reduce;
+#endif
+
 using namespace hiop;
 
 PriDecMasterProbleEx2Sparse::
@@ -109,12 +122,12 @@ bool PriDecMasterProbleEx2Sparse::eval_f_rterm(size_t idx, const int& n, const d
 {
   assert(nx_==n);
   rval=-1e+20;
-  hiopSolveStatus status;
   double* xi;
 
 #ifdef HIOP_USE_MPI
-  double t3 =  MPI_Wtime(); 
-  double t4 = 0.; 
+  //to monitor contingency compute time
+  //double t3 =  MPI_Wtime(); 
+  //double t4 = 0.; 
 #endif 
 
   // xi can be set below 
@@ -128,13 +141,6 @@ bool PriDecMasterProbleEx2Sparse::eval_f_rterm(size_t idx, const int& n, const d
 
   ex9_recourse = new PriDecRecourseProbleEx2Sparse(nc_, nS_, S_, x, xi, mem_space_);
 
-  // set a few contingencies to have different sparse structures to create unbalanced load
-  /*
-  if(idx%30==0) {  
-    ex9_recourse->set_sparse(0.3);
-  }
-  */
-
   hiopNlpSparse nlp(*ex9_recourse);
   nlp.options->SetStringValue("duals_update_type", "linear");
   //nlp.options->SetStringValue("dualsInitialization", "zero");
@@ -152,25 +158,27 @@ bool PriDecMasterProbleEx2Sparse::eval_f_rterm(size_t idx, const int& n, const d
 
   hiopAlgFilterIPMNewton solver(&nlp);
 
-
-  //assert("for debugging" && false); //for debugging purpose
-  status = solver.run();
+  hiopSolveStatus status = solver.run();
+  assert(status==Solve_Success ||
+         status==Solve_Success_RelTol ||
+         status==Solve_Acceptable_Level);
 
   rval = solver.getObjective();  
   if(y_==nullptr) {
     y_ = new double[ny_];
   }
   solver.getSolution(y_);
 
-  #ifdef HIOP_USE_MPI
+#ifdef HIOP_USE_MPI
   // uncomment if want to monitor contingency computing time
-  /* t4 =  MPI_Wtime(); 
+  /* 
+     t4 =  MPI_Wtime(); 
      if(idx==0||idx==1) {
        printf( "Elapsed time for contingency %d is %f\n",idx, t4 - t3 ); 
        printf(" Objective for idx %d value %18.12e, xi %18.12e\n",idx,rval,xi[0]);
      }
   */
-  #endif
+#endif
 
   delete[] xi;
   delete ex9_recourse;

src/Drivers/PriDec/NlpPriDecEx2UserRecourseSparseRaja.hpp

@@ -10,9 +10,21 @@
 using size_type = hiop::size_type;
 using index_type = hiop::index_type;
 
-#include <hiop_raja_defs.hpp>
-using ex9_raja_exec = hiop::hiop_raja_exec;
-using ex9_raja_reduce = hiop::hiop_raja_reduce;
+#if defined(HIOP_USE_CUDA)
+#include <ExecPoliciesRajaCudaImpl.hpp>
+using ex9_raja_exec = hiop::ExecRajaPoliciesBackend<hiop::ExecPolicyRajaCuda>::hiop_raja_exec;
+using ex9_raja_reduce = hiop::ExecRajaPoliciesBackend<hiop::ExecPolicyRajaCuda>::hiop_raja_reduce;
+#elif defined(HIOP_USE_HIP)
+#include <ExecPoliciesRajaHipImpl.hpp>
+using ex9_raja_exec = hiop::ExecRajaPoliciesBackend<hiop::ExecPolicyRajaHip>::hiop_raja_exec;
+using ex9_raja_reduce = hiop::ExecRajaPoliciesBackend<hiop::ExecPolicyRajaHip>::hiop_raja_reduce;
+#else
+//#if !defined(HIOP_USE_CUDA) && !defined(HIOP_USE_HIP)
+#include <ExecPoliciesRajaOmpImpl.hpp>
+using ex9_raja_exec = hiop::ExecRajaPoliciesBackend<hiop::ExecPolicyRajaOmp>::hiop_raja_exec;
+using ex9_raja_reduce = hiop::ExecRajaPoliciesBackend<hiop::ExecPolicyRajaOmp>::hiop_raja_reduce;
+#endif
+
 using namespace hiop;
 
 /** This class provide an example of what a user of hiop::hiopInterfacePriDecProblem 

src/Drivers/Sparse/CMakeLists.txt

@@ -41,7 +41,10 @@ endif(HIOP_USE_GINKGO)
 add_test(NAME NlpSparse2_1 COMMAND ${RUNCMD} "$<TARGET_FILE:NlpSparseEx2.exe>" "500" "-selfcheck")
 add_test(NAME NlpSparse2_2 COMMAND ${RUNCMD} "$<TARGET_FILE:NlpSparseEx2.exe>" "500" "-inertiafree" "-selfcheck")
 if(HIOP_USE_CUDA)
-  add_test(NAME NlpSparse2_3 COMMAND ${RUNCMD} "$<TARGET_FILE:NlpSparseEx2.exe>" "500" "-cusolver" "-inertiafree" "-selfcheck")
+  #disable cuda condensed linear algebra test when raja is not present (temporary)
+  if(HIOP_USE_RAJA)
+    add_test(NAME NlpSparse2_3 COMMAND ${RUNCMD} "$<TARGET_FILE:NlpSparseEx2.exe>" "500" "-cusolver" "-inertiafree" "-selfcheck")
+  endif(HIOP_USE_RAJA)
 endif(HIOP_USE_CUDA)
 if(HIOP_USE_GINKGO)
   add_test(NAME NlpSparse2_4 COMMAND ${RUNCMD} "$<TARGET_FILE:NlpSparseEx2.exe>" "500" "-ginkgo" "-inertiafree" "-selfcheck")

src/Drivers/Sparse/NlpSparseEx2.hpp

@@ -6,7 +6,7 @@
 //this include is not needed in general
 //we use hiopMatrixSparse in this particular example for convenience
 #include "hiopMatrixSparse.hpp"
-#include "hiopLinAlgFactory.hpp"
+#include "LinAlgFactory.hpp"
 
 #ifdef HIOP_USE_MPI
 #include "mpi.h"

src/ExecBackends/CMakeLists.txt

@@ -0,0 +1,13 @@
+# Set headers to be installed as part of the hiop interface
+set(hiopExecBackends_INTERFACE_HEADERS
+  ExecSpace.hpp
+  ExecPoliciesRajaCudaImpl.hpp
+  ExecPoliciesRajaHipImpl.hpp
+  ExecPoliciesRajaOmpImpl.hpp
+  MemBackendCppImpl.hpp
+  MemBackendCudaImpl.hpp
+  MemBackendHipImpl.hpp
+  MemBackendUmpireImpl.hpp
+)
+
+install(FILES ${hiopExecBackends_INTERFACE_HEADERS} DESTINATION include)

src/ExecBackends/ExecPoliciesRajaCudaImpl.hpp

@@ -0,0 +1,104 @@
+// Copyright (c) 2022, Lawrence Livermore National Security, LLC.
+// Produced at the Lawrence Livermore National Laboratory (LLNL).
+// LLNL-CODE-742473. All rights reserved.
+//
+// This file is part of HiOp. For details, see https://github.com/LLNL/hiop. HiOp 
+// is released under the BSD 3-clause license (https://opensource.org/licenses/BSD-3-Clause). 
+// Please also read "Additional BSD Notice" below.
+//
+// Redistribution and use in source and binary forms, with or without modification, 
+// are permitted provided that the following conditions are met:
+// i. Redistributions of source code must retain the above copyright notice, this list 
+// of conditions and the disclaimer below.
+// ii. Redistributions in binary form must reproduce the above copyright notice, 
+// this list of conditions and the disclaimer (as noted below) in the documentation and/or 
+// other materials provided with the distribution.
+// iii. Neither the name of the LLNS/LLNL 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 LAWRENCE LIVERMORE NATIONAL SECURITY, LLC, THE U.S. DEPARTMENT OF ENERGY 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.
+//
+// Additional BSD Notice
+// 1. This notice is required to be provided under our contract with the U.S. Department 
+// of Energy (DOE). This work was produced at Lawrence Livermore National Laboratory under 
+// Contract No. DE-AC52-07NA27344 with the DOE.
+// 2. Neither the United States Government nor Lawrence Livermore National Security, LLC 
+// nor any of their employees, makes any warranty, express or implied, or assumes any 
+// liability or responsibility for the accuracy, completeness, or usefulness of any 
+// information, apparatus, product, or process disclosed, or represents that its use would
+// not infringe privately-owned rights.
+// 3. Also, reference herein to any specific commercial products, process, or services by 
+// trade name, trademark, manufacturer or otherwise does not necessarily constitute or 
+// imply its endorsement, recommendation, or favoring by the United States Government or 
+// Lawrence Livermore National Security, LLC. The views and opinions of authors expressed 
+// herein do not necessarily state or reflect those of the United States Government or 
+// Lawrence Livermore National Security, LLC, and shall not be used for advertising or 
+// product endorsement purposes.
+
+/**
+ * @file ExecPoliciesRajaCudaImpl.hpp
+ *
+ * @author Cosmin G. Petra <petra1@llnl.gov>, LLNL
+ * @author Slaven Peles <peless@ornl.gov>, ORNL
+ * @author Nai-Yuan Chiang <chiang7@llnl.gov>, LLNL
+ */
+
+/**
+ * This file contains CUDA RAJA policies. Should be generally included only in CUDA 
+ * compilation units.
+ */
+
+#ifndef HIOP_EXEC_POL_RAJA_CUDA
+#define HIOP_EXEC_POL_RAJA_CUDA
+
+#if defined(HIOP_USE_RAJA) && defined(HIOP_USE_CUDA)
+
+#include "ExecSpace.hpp"
+
+#include <cuda.h>
+#include <RAJA/RAJA.hpp>
+
+namespace hiop
+{
+#define RAJA_LAMBDA [=] __device__
+
+template<>
+struct ExecRajaPoliciesBackend<ExecPolicyRajaCuda>
+{
+  static constexpr unsigned short int HIOP_RAJA_GPU_BLOCK_SIZE = 128;
+
+  using hiop_raja_exec   = RAJA::cuda_exec<HIOP_RAJA_GPU_BLOCK_SIZE>;
+  using hiop_raja_reduce = RAJA::cuda_reduce;
+  using hiop_raja_atomic = RAJA::cuda_atomic;
+
+  // The following are primarily for _matrix_exec_
+  using hiop_block_x_loop = RAJA::cuda_block_x_loop;
+  using hiop_thread_x_loop = RAJA::cuda_thread_x_loop;
+  template<typename T>
+  using hiop_kernel = RAJA::statement::CudaKernel<T>;
+
+  using matrix_exec =
+    RAJA::KernelPolicy<
+      hiop_kernel<
+        RAJA::statement::For<1, hiop_block_x_loop,
+          RAJA::statement::For<0, hiop_thread_x_loop,
+            RAJA::statement::Lambda<0>
+          >
+        >
+      >
+    >;
+
+};
+} //end of namespace
+#endif //defined(HIOP_USE_RAJA) && defined(HIOP_USE_CUDA)
+#endif