Issue #303: framework for reference_dense added

Author: Albert-Jan Yzelman

cmake/AddGRBInstall.cmake

@@ -112,14 +112,21 @@ endif()
 # paths may have spaces, hence wrap them inside single quotes ''
 
 # shared memory backends
-if ( WITH_REFERENCE_BACKEND )
+if( WITH_REFERENCE_BACKEND )
 	addBackendWrapperGenOptions( "reference"
 		COMPILE_DEFINITIONS "${REFERENCE_SELECTION_DEFS}"
 		LINK_FLAGS "'${SHMEM_BACKEND_INSTALL_DIR}/lib${BACKEND_LIBRARY_OUTPUT_NAME}.a'"
 			"'${ALP_UTILS_INSTALL_DIR}/lib${ALP_UTILS_LIBRARY_OUTPUT_NAME}.a'" "${NUMA_LFLAG}"
 	)
 endif()
 
+if( WITH_DENSE_BACKEND )
+	addBackendWrapperGenOptions( "reference_dense"
+		COMPILE_DEFINITIONS "${DENSE_SELECTION_DEFS}"
+		LINK_FLAGS "${SHMEM_BACKEND_INSTALL_DIR}/lib${BACKEND_LIBRARY_OUTPUT_NAME}.a"
+	)
+endif()
+
 if( WITH_OMP_BACKEND )
 	addBackendWrapperGenOptions( "reference_omp"
 		COMPILE_DEFINITIONS "${REFERENCE_OMP_SELECTION_DEFS}"

cmake/AddGRBVars.cmake

@@ -31,6 +31,7 @@ set( REFERENCE_BACKEND_DEFAULT_NAME "backend_reference" )
 set( REFERENCE_OMP_BACKEND_DEFAULT_NAME "backend_reference_omp" )
 set( BSP1D_BACKEND_DEFAULT_NAME "backend_bsp1d" )
 set( HYBRID_BACKEND_DEFAULT_NAME "backend_hybrid" )
+set( DENSE_BACKEND_DEFAULT_NAME "backend_reference_dense" )
 
 
 ### COMPILER DEFINITIONS FOR HEADERS INCLUSION AND FOR BACKEND SELECTION
@@ -39,6 +40,7 @@ set( HYBRID_BACKEND_DEFAULT_NAME "backend_hybrid" )
 set( REFERENCE_INCLUDE_DEFS "_GRB_WITH_REFERENCE" )
 set( REFERENCE_OMP_INCLUDE_DEFS "_GRB_WITH_OMP" )
 set( LPF_INCLUDE_DEFS "_GRB_WITH_LPF" )
+set( DENSE_INCLUDE_DEFS "_GRB_WITH_DENSEREF" )
 
 # compiler definitions to select a backend
 set( REFERENCE_SELECTION_DEFS "_GRB_BACKEND=reference" )
@@ -52,12 +54,13 @@ set( HYBRID_SELECTION_DEFS
 		"_GRB_BSP1D_BACKEND=reference_omp"
 		"_GRB_COORDINATES_BACKEND=reference_omp"
 )
+set( DENSE_SELECTION_DEFS "_GRB_BACKEND=reference_dense" )
 
 # definition to set if not depending on libnuma
 set( NO_NUMA_DEF "_GRB_NO_LIBNUMA" )
 
 ### **ALL** BACKENDS, EVEN IF NOT ENABLED BY USER
-set( ALL_BACKENDS "reference" "reference_omp" "bsp1d" "hybrid" )
+set( ALL_BACKENDS "reference" "reference_omp" "bsp1d" "hybrid" "reference_dense" )
 
 
 # list of user-enabled backends, for tests and wrapper scripts (do not change!)
@@ -67,14 +70,18 @@ set( AVAILABLE_BACKENDS "" )
 # backends that are enabled by the user: append as in the following
 
 # shared memory backends
-if ( WITH_REFERENCE_BACKEND )
+if( WITH_REFERENCE_BACKEND )
 	list( APPEND AVAILABLE_BACKENDS "reference" )
 endif()
 
 if( WITH_OMP_BACKEND )
 	list( APPEND AVAILABLE_BACKENDS "reference_omp" )
 endif()
 
+if( WITH_DENSE_BACKEND )
+	list( APPEND AVAILABLE_BACKENDS "reference_dense" )
+endif()
+
 # distributed memory backends
 if( WITH_BSP1D_BACKEND )
 	list( APPEND AVAILABLE_BACKENDS "bsp1d" )
@@ -85,3 +92,4 @@ if( WITH_HYBRID_BACKEND )
 endif()
 
 # add your own here!
+

configure

@@ -71,6 +71,7 @@ print_help() {
 the location where LPF is installed"
 	echo "  --with-banshee=<path/>              - path to the the tools to compile the banshee backend"
 	echo "  --with-snitch=<path/>               - path to the tools for Snitch support within the banshee backend"
+	echo "  --without-dense                     - to compile without support for dense algebraic programming"
 	echo "  --no-reference                      - disables the reference and reference_omp backends"
 	echo "  --debug-build                       - build the project with debug options (tests will run much slower!)"
 	echo "  --generator=<value>                 - set the generator for CMake (otherwise use CMake's default)"
@@ -88,6 +89,7 @@ the location where LPF is installed"
 reference=yes
 banshee=no
 lpf=no
+dense=yes
 show=no
 FLAGS=$''
 LPF_INSTALL_PATH=
@@ -138,6 +140,9 @@ or assume default paths (--with-lpf)"
 			SNITCH_PATH="${arg#--with-snitch=}"
 			banshee=yes
 			;;
+	--without-dense)
+			dense=no
+			;;
 	--no-reference)
 			reference=no
 			;;
@@ -251,6 +256,9 @@ if [[ "${reference}" == "yes" || "${lpf}" == "yes" ]];then
 	if [[ "${reference}" == "no" ]]; then
 		CMAKE_OPTS+=" -DWITH_REFERENCE_BACKEND=OFF -DWITH_OMP_BACKEND=OFF"
 	fi
+	if [[ "${dense}" == "no" ]]; then
+		CMAKE_OPTS+=" -DWITH_DENSE_BACKEND=OFF"
+	fi
 	if [[ "${lpf}" == "yes" ]]; then
 		CMAKE_OPTS+=" -DLPF_INSTALL_PATH='${ABSOLUTE_LPF_INSTALL_PATH}'"
 	fi

include/CMakeLists.txt

@@ -116,6 +116,17 @@ if( WITH_REFERENCE_BACKEND_HEADERS )
 	install( TARGETS backend_reference_headers EXPORT GraphBLASTargets )
 endif()
 
+if( WITH_DENSE_BACKEND )
+	add_library( backend_reference_dense_headers INTERFACE )
+	target_link_libraries( backend_reference_dense_headers INTERFACE backend_headers_nodefs )
+	install( DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/graphblas/denseref"
+		DESTINATION "${GRB_INCLUDE_INSTALL_DIR}"
+		FILES_MATCHING REGEX "${HEADERS_REGEX}"
+	)
+	install( TARGETS backend_reference_dense_headers EXPORT GraphBLASTargets )
+	target_link_libraries( all_headers INTERFACE backend_reference_dense_headers )
+endif()
+
 if( WITH_REFERENCE_BACKEND OR WITH_OMP_BACKEND )
 	install( DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/graphblas/reference/"
 		DESTINATION "${GRB_INCLUDE_INSTALL_DIR}/reference"
@@ -186,4 +197,6 @@ install( DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/graphblas/algorithms/"
 	FILES_MATCHING REGEX "${HEADERS_REGEX}"
 )
 
+target_link_libraries( all_headers INTERFACE algorithms )
+
 install( TARGETS algorithms EXPORT GraphBLASTargets )

include/graphblas/backends.hpp

@@ -151,10 +151,17 @@ namespace grb {
 		 *
 		 * Collaboration with ETH Zurich (ongoing).
 		 */
-		banshee_ssr
+		banshee_ssr,
+
+		/**
+		 * The ALP/Dense backend. This is no longer a proper GraphBLAS implementation, as it assumes
+		 * all containers are dense. No ``missing'' entries in containers are allowed.
+		 */
+		reference_dense
 
 	};
 
 } // namespace grb
 
 #endif
+

include/graphblas/base/collectives.hpp

@@ -108,7 +108,7 @@ namespace grb {
 		static RC allreduce( IOType & inout, const Operator op = Operator() ) {
 			(void)inout;
 			(void)op;
-			return PANIC;
+			return UNSUPPORTED;
 		}
 
 		/**
@@ -175,7 +175,7 @@ namespace grb {
 			(void)inout;
 			(void)op;
 			(void)root;
-			return PANIC;
+			return UNSUPPORTED;
 		}
 
 		/**
@@ -233,7 +233,7 @@ namespace grb {
 		static RC broadcast( IOType &inout, const size_t root = 0 ) {
 			(void)inout;
 			(void)root;
-			return PANIC;
+			return UNSUPPORTED;
 		}
 
 		/**
@@ -247,11 +247,12 @@ namespace grb {
 			(void)inout;
 			(void)size;
 			(void)root;
-			return PANIC;
+			return UNSUPPORTED;
 		}
 
 	}; // end class ``collectives''
 
 } // end namespace grb
 
 #endif // end _H_GRB_COLL_BASE
+

include/graphblas/benchmark.hpp

@@ -28,13 +28,14 @@
 
 // include specialisations
 #ifdef _GRB_WITH_REFERENCE
-#include "graphblas/reference/benchmark.hpp"
+ #include "graphblas/reference/benchmark.hpp"
+ #include "graphblas/denseref/benchmark.hpp"
 #endif
 #ifdef _GRB_WITH_BANSHEE
-#include "graphblas/banshee/benchmark.hpp"
+ #include "graphblas/banshee/benchmark.hpp"
 #endif
 #ifdef _GRB_WITH_LPF
-#include "graphblas/bsp1d/benchmark.hpp"
+ #include "graphblas/bsp1d/benchmark.hpp"
 #endif
 
 #ifdef _GRB_BACKEND
@@ -45,3 +46,4 @@ namespace grb {
 #endif
 
 #endif // end ``_H_GRB_BENCH''
+

include/graphblas/blas1.hpp

@@ -32,6 +32,7 @@
 
 #ifdef _GRB_WITH_REFERENCE
  #include <graphblas/reference/blas1.hpp>
+ #include <graphblas/denseref/blas1.hpp>
 #endif
 #ifdef _GRB_WITH_BANSHEE
  #include <graphblas/banshee/blas1.hpp>

include/graphblas/blas2.hpp

@@ -31,13 +31,15 @@
 
 // now include all specialisations contained in the backend directories:
 #ifdef _GRB_WITH_REFERENCE
-#include <graphblas/reference/blas2.hpp>
+ #include <graphblas/reference/blas2.hpp>
+ #include <graphblas/denseref/blas3.hpp>
 #endif
 #ifdef _GRB_WITH_BANSHEE
-#include <graphblas/banshee/blas2.hpp>
+ #include <graphblas/banshee/blas2.hpp>
 #endif
 #ifdef _GRB_WITH_LPF
-#include <graphblas/bsp1d/blas2.hpp>
+ #include <graphblas/bsp1d/blas2.hpp>
 #endif
 
 #endif // end ``_H_GRB_BLAS2''
+

include/graphblas/blas3.hpp

@@ -28,10 +28,12 @@
 
 // now include all specialisations contained in the backend directories:
 #ifdef _GRB_WITH_REFERENCE
-#include <graphblas/reference/blas3.hpp>
+ #include <graphblas/reference/blas3.hpp>
+ #include <graphblas/denseref/blas3.hpp>
 #endif
 #ifdef _GRB_WITH_LPF
-#include <graphblas/bsp1d/blas3.hpp>
+ #include <graphblas/bsp1d/blas3.hpp>
 #endif
 
 #endif // end _H_GRB_BLAS3
+