Merge branch 'develop' of github.com:llnl/Umpire into task/available-allocators-errors

Author: kab163

.github/actions/shroud/entrypoint.sh

@@ -1,5 +1,7 @@
 #!/bin/bash
 
+set -euo pipefail
+
 git config --global --add safe.directory /github/workspace
 git config --global --add safe.directory /github/workspace/.radiuss-ci
 git config --global --add safe.directory /github/workspace/blt
@@ -13,4 +15,3 @@ git submodule update --init --recursive
 mkdir build && cd build 
 cmake -DCMAKE_CXX_COMPILER=clang++ -DSHROUD_EXECUTABLE=/usr/local/bin/shroud ..
 make -j 3 generate_umpire_shroud
-

.github/workflows/generate-shroud.yml

@@ -1,8 +1,10 @@
-on: 
+on:
+  workflow_dispatch:
   pull_request:
     paths:
       - '**umpire_shroud.yaml'
       - '**genfumpiresplicer.f'
+      - '**gencumpiresplicer.inc'
 
 name: Generate C/FORTRAN Interface
 jobs:

CMakeLists.txt

@@ -197,7 +197,7 @@ install(FILES
   "${PROJECT_BINARY_DIR}/umpire-config-version.cmake"
   DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/umpire)
 
-install(EXPORT umpire-targets DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/umpire)
+install(EXPORT umpire-targets NAMESPACE umpire:: DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/umpire)
 
 if (UMPIRE_ENABLE_TESTS)
   add_subdirectory(tests)

cmake/SetupUmpireOptions.cmake

@@ -39,6 +39,7 @@ option(UMPIRE_ENABLE_SANITIZER_TESTS "Enable address sanitizer tests" Off)
 option(UMPIRE_ENABLE_DEVICE_ALLOCATOR "Enable Device Allocator" Off)
 option(UMPIRE_ENABLE_SQLITE_EXPERIMENTAL "Build with sqlite event integration (experimental)" Off)
 option(UMPIRE_DISABLE_ALLOCATIONMAP_DEBUG "Disable verbose output from AllocationMap during debug builds" Off)
+option(UMPIRE_DISABLE_ALIAS_TARGETS "Disable non-namespaced alias targets (e.g., umpire) for exported targets" Off)
 set(UMPIRE_FMT_TARGET fmt::fmt-header-only CACHE STRING "Name of fmt target to use") 
 
 if (UMPIRE_ENABLE_INACCESSIBILITY_TESTS)

docs/sphinx/getting_started.rst

@@ -64,6 +64,18 @@ point to the root of your Umpire installation, you can call
 ``find_package(umpire)`` inside your CMake project and Umpire will be
 automatically detected and available for use.
 
+When using Umpire in your CMake project, link against the namespaced target
+``umpire::umpire``:
+
+.. code-block:: cmake
+
+  find_package(umpire REQUIRED)
+  target_link_libraries(your_target umpire::umpire)
+
+For backwards compatibility, the non-namespaced target ``umpire`` is still
+available but deprecated. Using namespaced targets provides better error
+diagnostics when ``find_package()`` is missing.
+
 -----------
 Basic Usage
 -----------

docs/sphinx/tutorial/fortran/allocators.rst

@@ -3,14 +3,14 @@
 =======================
 FORTRAN API: Allocators
 =======================
-
+    
 The fundamental concept for accessing memory through Umpire is an
 :class:`umpire:Allocator`. In FORTRAN, this means using the type
 ``UmpireAllocator``. This type provides an ``allocate_pointer`` function to
 allocate raw memory, and a generic ``allocate`` procedure that takes an array
 pointer and an array of dimensions and will allocate the correct amount of
 memory.
-
+      
 As with the native C++ interface, all allocators are accessed via the
 :class:`umpire::ResourceManager`. In the FORTRAN API, there is a corresponding
 ``UmpireResourceManager`` type. To get an ``UmpireAllocator``:
@@ -31,3 +31,7 @@ deallocate memory:
 
 In this case, we allocate a one-dimensional array using the generic
 ``allocate`` function.
+
+.. note:: 
+
+   Umpire's FORTRAN interface is generated with the help of `Shroud <https://shroud.readthedocs.io/en/latest/>`_.

src/umpire/CMakeLists.txt

@@ -65,6 +65,9 @@ if (UMPIRE_ENABLE_DEVICE_ALLOCATOR AND (UMPIRE_ENABLE_CUDA OR UMPIRE_ENABLE_HIP)
     SOURCES ${umpire_device_sources}
     DEPENDS_ON ${umpire_device_depends})
 
+  # Create namespaced alias for build tree
+  add_library(umpire::umpire_device ALIAS umpire_device)
+
   target_include_directories(
     umpire_device
     PUBLIC
@@ -139,6 +142,9 @@ blt_add_library(
   DEPENDS_ON ${umpire_depends}
   DEFINES ${umpire_defines})
 
+# Create namespaced alias for build tree
+add_library(umpire::umpire ALIAS umpire)
+
 if (NOT WIN32 AND NOT ${CMAKE_VERSION} VERSION_LESS 3.18)
   target_link_options(
     umpire INTERFACE

src/umpire/event/event.hpp

@@ -47,7 +47,7 @@ inline std::string to_string(const camp::resources::Resource& r)
       return "camp::resource::Undefined";
   }
 
-  return "unkown resource";
+  return "unknown resource";
 }
 
 } // namespace v1

src/umpire/event/json_file_store.cpp

@@ -17,6 +17,7 @@
 #include "fmt/format.h"
 #include "umpire/event/event_json.hpp"
 #include "umpire/json/json.hpp"
+#include "umpire/util/Macros.hpp"
 #include "umpire/util/error.hpp"
 
 namespace umpire {
@@ -25,11 +26,26 @@ namespace event {
 json_file_store::json_file_store(const std::string& filename, bool read_only)
     : m_filename{filename}, m_read_only{read_only}
 {
+  m_fstream = fopen(m_filename.c_str(), m_read_only ? "r" : "w");
+
+  if (m_fstream == NULL) {
+    UMPIRE_ERROR(umpire::runtime_error, fmt::format("Failed to open {}", m_filename));
+  }
+}
+
+json_file_store::~json_file_store()
+{
+  if (m_fstream != nullptr) {
+    if (!m_read_only) {
+      fflush(m_fstream); // Flush buffered writes before close.
+    }
+    fclose(m_fstream); // Close the file
+    m_fstream = nullptr;
+  }
 }
 
 void json_file_store::insert(const event& e)
 {
-  open_store();
   nlohmann::json json_event = e;
   std::stringstream ss;
   ss << json_event;
@@ -112,7 +128,6 @@ std::vector<event> json_file_store::get_events()
   std::vector<event> events;
   std::size_t line_number{1};
 
-  open_store();
   while (getline(&line, &len, m_fstream) != -1) {
     nlohmann::json json_event;
     event e;
@@ -166,17 +181,5 @@ std::vector<event> json_file_store::get_events()
   return events;
 }
 #endif
-
-void json_file_store::open_store()
-{
-  if (m_fstream == NULL) {
-    m_fstream = fopen(m_filename.c_str(), m_read_only ? "r" : "w");
-
-    if (m_fstream == NULL) {
-      UMPIRE_ERROR(umpire::runtime_error, fmt::format("Failed to open {}", m_filename));
-    }
-  }
-}
-
 } // namespace event
 } // namespace umpire

src/umpire/event/json_file_store.hpp

@@ -27,6 +27,7 @@ struct deallocate_resource;
 class json_file_store : public event_store {
  public:
   json_file_store(const std::string& filename, bool read_only = false);
+  ~json_file_store();
 
   virtual void insert(const event& e);
   virtual void insert(const allocate& e);
@@ -38,7 +39,6 @@ class json_file_store : public event_store {
   virtual std::vector<event> get_events();
 
  private:
-  void open_store();
   FILE* m_fstream{nullptr};
   std::string m_filename;
   bool m_read_only;