Merge pull request #733 from CEED/jeremy/more-registration

Extra error message for uncompiled backends

Author: jeremylt

backends/ceed-backend-list.h

@@ -5,24 +5,24 @@
 // listed, and also to define weak symbol aliases for backends that are not
 // configured.
 
-MACRO(CeedRegister_Avx_Blocked)
-MACRO(CeedRegister_Avx_Serial)
-MACRO(CeedRegister_Cuda)
-MACRO(CeedRegister_Cuda_Gen)
-MACRO(CeedRegister_Cuda_Shared)
-MACRO(CeedRegister_Hip)
-MACRO(CeedRegister_Hip_Gen)
-MACRO(CeedRegister_Hip_Shared)
-MACRO(CeedRegister_Magma)
-MACRO(CeedRegister_Magma_Det)
-MACRO(CeedRegister_Memcheck_Blocked)
-MACRO(CeedRegister_Memcheck_Serial)
-MACRO(CeedRegister_Occa)
-MACRO(CeedRegister_Opt_Blocked)
-MACRO(CeedRegister_Opt_Serial)
-MACRO(CeedRegister_Ref)
-MACRO(CeedRegister_Ref_Blocked)
-MACRO(CeedRegister_Tmpl)
-MACRO(CeedRegister_Tmpl_Sub)
-MACRO(CeedRegister_Xsmm_Blocked)
-MACRO(CeedRegister_Xsmm_Serial)
+MACRO(CeedRegister_Avx_Blocked, 1, "/cpu/self/avx/blocked")
+MACRO(CeedRegister_Avx_Serial, 1, "/cpu/self/avx/serial")
+MACRO(CeedRegister_Cuda, 1, "/gpu/cuda/ref")
+MACRO(CeedRegister_Cuda_Gen, 1, "/gpu/cuda/gen")
+MACRO(CeedRegister_Cuda_Shared, 1, "/gpu/cuda/shared")
+MACRO(CeedRegister_Hip, 1, "/gpu/hip/ref")
+MACRO(CeedRegister_Hip_Gen, 1, "/gpu/hip/gen")
+MACRO(CeedRegister_Hip_Shared, 1, "/gpu/hip/shared")
+MACRO(CeedRegister_Magma, 2, "/gpu/cuda/magma", "/gpu/hip/magma")
+MACRO(CeedRegister_Magma_Det, 2, "/gpu/cuda/magma/det", "/gpu/hip/magma/det")
+MACRO(CeedRegister_Memcheck_Blocked, 1, "/cpu/self/memcheck/blocked")
+MACRO(CeedRegister_Memcheck_Serial, 1, "/cpu/self/memcheck/serial")
+MACRO(CeedRegister_Occa, 4, "/cpu/self/occa", "/cpu/openmp/occa", "/gpu/hip/occa", "/gpu/cuda/occa")
+MACRO(CeedRegister_Opt_Blocked, 1, "/cpu/self/opt/blocked")
+MACRO(CeedRegister_Opt_Serial, 1, "/cpu/self/opt/serial")
+MACRO(CeedRegister_Ref, 1, "/cpu/self/ref/serial")
+MACRO(CeedRegister_Ref_Blocked, 1, "/cpu/self/ref/blocked")
+MACRO(CeedRegister_Tmpl, 1, "/cpu/self/tmpl")
+MACRO(CeedRegister_Tmpl_Sub, 1, "/cpu/self/tmpl/sub")
+MACRO(CeedRegister_Xsmm_Blocked, 1, "/cpu/self/xsmm/blocked")
+MACRO(CeedRegister_Xsmm_Serial, 1, "/cpu/self/xsmm/serial")

backends/ceed-backend-weak.c

@@ -2,16 +2,33 @@
 #include <stdlib.h>
 #include <stdio.h>
 
-// This function provides a debug target for weak symbols
 // LCOV_EXCL_START
-static int CeedRegister_Weak(const char *name) {
+// This function provides improved error messages for uncompiled backends
+static int CeedInit_Weak(const char *resource, Ceed ceed) {
+  return CeedError(ceed, CEED_ERROR_UNSUPPORTED,
+                   "Backend not currently compiled: %s\n"
+                   "Consult the installation instructions to compile this backend",
+                   resource);
+}
+
+// This function provides a debug target for weak symbols
+static int CeedRegister_Weak(const char *name, int num_prefixes, ...) {
   if (getenv("CEED_DEBUG")) fprintf(stderr, "Weak %s\n", name);
+
+  va_list prefixes;
+  va_start(prefixes, num_prefixes);
+  int ierr;
+  for (int i=0; i<num_prefixes; i++) {
+    ierr = CeedRegister(va_arg(prefixes, const char*), CeedInit_Weak, CEED_MAX_BACKEND_PRIORITY);
+    CeedChk(ierr);
+  }
+  va_end(prefixes);
   return CEED_ERROR_SUCCESS;
 }
 // LCOV_EXCL_STOP
 
-#define MACRO(name)                                                     \
+#define MACRO(name,num_prefixes, ...)                                                     \
   CEED_INTERN int name(void) __attribute__((weak));                     \
-  int name(void) { return CeedRegister_Weak(__func__); }
+  int name(void) { return CeedRegister_Weak(__func__,num_prefixes, ## __VA_ARGS__); }
 #include "ceed-backend-list.h"
 #undef MACRO

include/ceed/backend.h

@@ -20,12 +20,14 @@
 #define _ceed_backend_h
 
 #include <ceed/ceed.h>
+#include <limits.h>
 #include <stdbool.h>
 
 #define CEED_INTERN CEED_EXTERN __attribute__((visibility ("hidden")))
 #define CEED_UNUSED __attribute__((unused))
 
 #define CEED_MAX_RESOURCE_LEN 1024
+#define CEED_MAX_BACKEND_PRIORITY UINT_MAX
 #define CEED_ALIGN 64
 #define CEED_COMPOSITE_MAX 16
 #define CEED_EPSILON 1E-16

interface/ceed-register.c

@@ -6,7 +6,7 @@
 
 static bool register_all_called;
 
-#define MACRO(name) CEED_INTERN int name(void);
+#define MACRO(name,...) CEED_INTERN int name(void);
 #include "../backends/ceed-backend-list.h"
 #undef MACRO
 
@@ -26,7 +26,7 @@ int CeedRegisterAll() {
   if (register_all_called) return 0;
   register_all_called = true;
 
-#define MACRO(name) CeedChk(name());
+#define MACRO(name,...) CeedChk(name());
 #include "../backends/ceed-backend-list.h"
 #undef MACRO
   return CEED_ERROR_SUCCESS;

interface/ceed.c

@@ -595,12 +595,12 @@ int CeedSetData(Ceed ceed, void *data) {
 /// @{
 
 /**
-  @brief Get the list of avaliable resource names for Ceed contexts
+  @brief Get the list of available resource names for Ceed contexts
   Note: The caller is responsible for `free()`ing the resources and priorities arrays,
           but should not `free()` the contents of the resources array.
 
-  @param[out] n           Number of avaliable resources
-  @param[out] resources   List of avaliable resource names
+  @param[out] n           Number of available resources
+  @param[out] resources   List of available resource names
   @param[out] priorities  Resource name prioritization values, lower is better
 
   @return An error code: 0 - success, otherwise - failure
@@ -610,7 +610,7 @@ int CeedSetData(Ceed ceed, void *data) {
 // LCOV_EXCL_START
 int CeedRegistryGetList(size_t *n, char ***const resources,
                         CeedInt **priorities) {
-  *n = num_backends;
+  *n = 0;
   *resources = malloc(num_backends * sizeof(**resources));
   if (!resources)
     return CeedError(NULL, CEED_ERROR_MAJOR, "malloc() failure");
@@ -620,8 +620,20 @@ int CeedRegistryGetList(size_t *n, char ***const resources,
       return CeedError(NULL, CEED_ERROR_MAJOR, "malloc() failure");
   }
   for (size_t i=0; i<num_backends; i++) {
-    *resources[i] = backends[i].prefix;
-    if (priorities) *priorities[i] = backends[i].priority;
+    // Only report compiled backends
+    if (backends[i].priority < CEED_MAX_BACKEND_PRIORITY) {
+      *resources[i] = backends[i].prefix;
+      if (priorities) *priorities[i] = backends[i].priority;
+      *n += 1;
+    }
+  }
+  *resources = realloc(*resources, *n * sizeof(**resources));
+  if (!resources)
+    return CeedError(NULL, CEED_ERROR_MAJOR, "realloc() failure");
+  if (priorities) {
+    *priorities = realloc(*priorities, *n * sizeof(**priorities));
+    if (!priorities)
+      return CeedError(NULL, CEED_ERROR_MAJOR, "realloc() failure");
   }
   return CEED_ERROR_SUCCESS;
 };
@@ -631,7 +643,7 @@ int CeedRegistryGetList(size_t *n, char ***const resources,
   @brief Initialize a \ref Ceed context to use the specified resource.
   Note: Prefixing the resource with "help:" (e.g. "help:/cpu/self")
     will result in CeedInt printing the current libCEED version number
-    and a list of current avaliable backend resources to stderr.
+    and a list of current available backend resources to stderr.
 
   @param resource  Resource to use, e.g., "/cpu/self"
   @param ceed      The library context
@@ -643,7 +655,8 @@ int CeedRegistryGetList(size_t *n, char ***const resources,
 **/
 int CeedInit(const char *resource, Ceed *ceed) {
   int ierr;
-  size_t match_len = 0, match_idx = UINT_MAX, match_priority = UINT_MAX, priority;
+  size_t match_len = 0, match_idx = UINT_MAX,
+         match_priority = CEED_MAX_BACKEND_PRIORITY, priority;
 
   // Find matching backend
   if (!resource)
@@ -661,9 +674,11 @@ int CeedInit(const char *resource, Ceed *ceed) {
     fprintf(stderr, "libCEED version: %d.%d%d%s\n", CEED_VERSION_MAJOR,
             CEED_VERSION_MINOR, CEED_VERSION_PATCH,
             CEED_VERSION_RELEASE ? "" : "+development");
-    fprintf(stderr, "Avaliable backend resources:\n");
+    fprintf(stderr, "Available backend resources:\n");
     for (size_t i=0; i<num_backends; i++) {
-      fprintf(stderr, "  %s\n", backends[i].prefix);
+      // Only report compiled backends
+      if (backends[i].priority < CEED_MAX_BACKEND_PRIORITY)
+        fprintf(stderr, "  %s\n", backends[i].prefix);
     }
     fflush(stderr);
     match_help = 5; // Delineating character expected
@@ -694,7 +709,7 @@ int CeedInit(const char *resource, Ceed *ceed) {
     // LCOV_EXCL_STOP
   } else if (match_len != stem_length) {
     // LCOV_EXCL_START
-    return CeedError(NULL, CEED_ERROR_MAJOR, "No suitable backend: %s "
+    return CeedError(NULL, CEED_ERROR_MAJOR, "No suitable backend: %s\n"
                      "Closest match: %s", resource, backends[match_idx].prefix);
     // LCOV_EXCL_STOP
   }

tests/junit.py

@@ -101,7 +101,7 @@ def run(test, backends):
                 if test[:4] in 't006 t007'.split():
                     check_required_failure(case, proc.stderr, 'No suitable backend:')
                 if test[:4] in 't008'.split():
-                    check_required_failure(case, proc.stderr, 'Avaliable backend resources:')
+                    check_required_failure(case, proc.stderr, 'Available backend resources:')
                 if test[:4] in 't110 t111 t112 t113 t114'.split():
                     check_required_failure(case, proc.stderr, 'Cannot grant CeedVector array access')
                 if test[:4] in 't115'.split():

tests/tap.sh

@@ -134,7 +134,7 @@ for ((i=0;i<${#backends[@]};++i)); do
     fi
 
     # grep to pass test t008 on output in stderr
-    if grep -F -q -e 'Avaliable backend resources:' ${output}.err \
+    if grep -F -q -e 'Available backend resources:' ${output}.err \
             && [[ "$1" = "t008"* ]] ; then
         printf "ok $i0 PASS - expected failure $1 $backend\n"
         printf "ok $i1 PASS - expected failure $1 $backend stdout\n"