ECKIT-635 FAM Map data structure

.gitignore

@@ -11,3 +11,4 @@ doc/latex
 .idea
 build/
 *.ccls-cache
+compile_commands.json

CMakeLists.txt

@@ -106,6 +106,13 @@ if( NOT TARGET OpenMP::OpenMP_CXX )
     set( eckit_HAVE_OMP 0 )
 endif()
 
+### OpenFAM Support
+
+ecbuild_add_option( FEATURE OPENFAM
+                    DEFAULT OFF
+                    REQUIRED_PACKAGES "LibUUID REQUIRED" "OpenFAM 3.2.0 REQUIRED"
+                    DESCRIPTION "Enables OpenFAM support" )
+
 ### RADOS
 
 ecbuild_add_option( FEATURE RADOS

cmake/FindLibUUID.cmake

@@ -0,0 +1,108 @@
+# Copyright 2024- European Centre for Medium-Range Weather Forecasts (ECMWF)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# In applying this licence, ECMWF does not waive the privileges and immunities
+# granted to it by virtue of its status as an intergovernmental organisation nor
+# does it submit to any jurisdiction.
+#
+# Requires:
+#  FindPackageHandleStandardArgs (CMake standard module)
+#
+
+#[=======================================================================[.rst:
+FindLibUUID
+--------
+
+This module finds the libuuid (from util-linux) library.
+
+Imported Targets
+^^^^^^^^^^^^^^^^
+
+This module provides the following imported targets, if found:
+
+``LibUUID``
+  The libuuid library
+
+Result variables
+^^^^^^^^^^^^^^^^
+
+This module will set the following variables in your project:
+
+``LIB_UUID_FOUND``
+  True if the libuuid library is found.
+``LIB_UUID_INCLUDE_DIRS``
+  Include directories needed to use libuuid.
+``LIB_UUID_LIBRARIES``
+  Libraries needed to link to libuuid.
+
+Cache variables
+^^^^^^^^^^^^^^^
+
+The following cache variables may also be set to help find libuuid library:
+
+``LIB_UUID_INCLUDE_DIR``
+  where to find the libuuid headers.
+``LIB_UUID_LIBRARY``
+  where to find the libuuid library.
+
+Hints
+^^^^^
+
+The environment variables ``LIB_UUID_ROOT``, ``LIB_UUID_DIR``, and ``LIB_UUID_PATH``
+may also be set to help find libuuid library.
+
+#]=======================================================================]
+
+find_path(LIB_UUID_INCLUDE_DIR uuid.h
+    HINTS
+        ${LIB_UUID_ROOT}
+        ${LIB_UUID_DIR}
+        ${LIB_UUID_PATH}
+        ENV LIB_UUID_ROOT
+        ENV LIB_UUID_DIR
+        ENV LIB_UUID_PATH
+    PATH_SUFFIXES uuid
+)
+
+find_library(LIB_UUID_LIBRARY
+    NAMES uuid
+    HINTS
+        ${LIB_UUID_ROOT}
+        ${LIB_UUID_DIR}
+        ${LIB_UUID_PATH}
+        ENV LIB_UUID_ROOT
+        ENV LIB_UUID_DIR
+        ENV LIB_UUID_PATH
+    PATH_SUFFIXES lib lib64
+)
+
+include(FindPackageHandleStandardArgs)
+
+find_package_handle_standard_args(LibUUID REQUIRED_VARS
+                                    LIB_UUID_LIBRARY
+                                    LIB_UUID_INCLUDE_DIR)
+
+if (LibUUID_FOUND)
+    set(LIB_UUID_LIBRARIES ${LIB_UUID_LIBRARY})
+    set(LIB_UUID_INCLUDE_DIRS ${LIB_UUID_INCLUDE_DIR})
+    if(NOT TARGET LibUUID)
+        add_library(LibUUID UNKNOWN IMPORTED)
+        set_target_properties(LibUUID PROPERTIES
+            IMPORTED_LOCATION "${LIB_UUID_LIBRARY}"
+            INTERFACE_INCLUDE_DIRECTORIES "${LIB_UUID_INCLUDE_DIR}"
+            INTERFACE_LINK_LIBRARIES "${LIB_UUID_LIBRARY}")
+    endif()
+endif()
+
+mark_as_advanced(LIB_UUID_INCLUDE_DIR LIB_UUID_LIBRARY)

src/eckit/CMakeLists.txt

@@ -268,6 +268,41 @@ list(APPEND eckit_message_srcs
     message/Splitter.h
 )
 
+if(HAVE_OPENFAM)
+list(APPEND eckit_io_srcs
+io/fam/detail/FamSessionDetail.cc
+io/fam/FamConfig.h
+io/fam/FamHandle.cc
+io/fam/FamHandle.h
+io/fam/FamList.cc
+io/fam/FamList.h
+io/fam/FamListIterator.cc
+io/fam/FamListIterator.h
+io/fam/FamMap.cc
+io/fam/FamMap.h
+io/fam/FamMapIterator.cc
+io/fam/FamMapIterator.h
+io/fam/FamName.cc
+io/fam/FamName.h
+io/fam/FamObject.cc
+io/fam/FamObject.h
+io/fam/FamObjectName.cc
+io/fam/FamObjectName.h
+io/fam/FamPath.cc
+io/fam/FamPath.h
+io/fam/FamProperty.cc
+io/fam/FamProperty.h
+io/fam/FamRegion.cc
+io/fam/FamRegion.h
+io/fam/FamRegionName.cc
+io/fam/FamRegionName.h
+io/fam/FamSessionManager.cc
+io/fam/FamSessionManager.h
+io/fam/FamURIManager.cc
+io/fam/FamURIManager.h
+)
+endif(HAVE_OPENFAM)
+
 if(HAVE_RADOS)
     list( APPEND eckit_io_srcs
         io/rados/RadosHandle.cc
@@ -951,6 +986,7 @@ ecbuild_add_library(
               "${CURL_LIBRARIES}"
               "${AIO_LIBRARIES}"
               "${RADOS_LIBRARIES}"
+              $<${HAVE_OPENFAM}:OpenFAM::openfam>
 
           PUBLIC_LIBS
               ${CMATH_LIBRARIES}

src/eckit/exception/Exceptions.cc

@@ -8,13 +8,14 @@
  * does it submit to any jurisdiction.
  */
 
+#include "eckit/exception/Exceptions.h"
+
 #include <unistd.h>
 
 #include <csignal>
 #include <cstdlib>
 
 #include "eckit/config/LibEcKit.h"
-#include "eckit/exception/Exceptions.h"
 #include "eckit/log/Log.h"
 #include "eckit/os/BackTrace.h"
 #include "eckit/thread/ThreadSingleton.h"
@@ -152,6 +153,15 @@ Cancel::Cancel(const std::string& w, const CodeLocation& loc) : Exception("Cance
 
 Retry::Retry(const std::string& w, const CodeLocation& loc) : Exception("Retry: " + w, loc) {}
 
+PermissionDenied::PermissionDenied(const std::string& w, const CodeLocation& loc) :
+    Exception("Permission denied: " + w, loc) {}
+
+NotFound::NotFound(const std::string& w, const CodeLocation& loc) : Exception("Not found: " + w, loc) {}
+
+AlreadyExists::AlreadyExists(const std::string& w, const CodeLocation& loc) : Exception("Already exists: " + w, loc) {}
+
+OutOfStorage::OutOfStorage(const std::string& w, const CodeLocation& loc) : Exception("Out of storage: " + w, loc) {}
+
 UserError::UserError(const std::string& w, const CodeLocation& loc) : Exception("UserError: " + w, loc) {}
 
 UserError::UserError(const std::string& user, const std::string& w, const CodeLocation& loc) :

src/eckit/exception/Exceptions.h

@@ -187,6 +187,30 @@ class Retry : public Exception {
     explicit Retry(const std::string&, const CodeLocation& = {});
 };
 
+class PermissionDenied : public Exception {
+public:
+
+    explicit PermissionDenied(const std::string& /* w */, const CodeLocation& = {});
+};
+
+class NotFound : public Exception {
+public:
+
+    explicit NotFound(const std::string& /* w */, const CodeLocation& = {});
+};
+
+class AlreadyExists : public Exception {
+public:
+
+    explicit AlreadyExists(const std::string& /* w */, const CodeLocation& = {});
+};
+
+class OutOfStorage : public Exception {
+public:
+
+    explicit OutOfStorage(const std::string& /* w */, const CodeLocation& = {});
+};
+
 class UserError : public Exception {
 public:
 

src/eckit/filesystem/URI.cc

@@ -67,6 +67,9 @@ URI::URI(const std::string& scheme, const URI& uri, const std::string& hostname,
     fragment_(uri.fragment_),
     queryValues_(uri.queryValues_) {}
 
+URI::URI(std::string scheme, const net::Endpoint& endpoint, std::string name) noexcept :
+    name_(std::move(name)), scheme_(std::move(scheme)), host_(endpoint.host()), port_(endpoint.port()) {}
+
 URI::URI(Stream& s) {
     s >> scheme_;
     s >> user_;

src/eckit/filesystem/URI.h

@@ -24,6 +24,7 @@
 #include "eckit/io/Offset.h"
 #include "eckit/net/Endpoint.h"
 
+#include <string>
 
 namespace eckit {
 
@@ -49,6 +50,7 @@ class URI {
     URI(const std::string& scheme, const URI& uri);
     URI(const std::string& scheme, const std::string& hostname, int port);
     URI(const std::string& scheme, const URI& uri, const std::string& hostname, int port);
+    URI(std::string scheme, const net::Endpoint& endpoint, std::string name) noexcept;
     URI(Stream& s);
 
     // Destructor
@@ -63,7 +65,9 @@ class URI {
     DataHandle* newReadHandle(const OffsetList&, const LengthList&) const;
     DataHandle* newReadHandle() const;
 
-    void endpoint(const eckit::net::Endpoint& endpoint) {
+    net::Endpoint endpoint() const { return {host_, port_}; }
+
+    void endpoint(const net::Endpoint& endpoint) {
         host_ = endpoint.host();
         port_ = endpoint.port();
     }

src/eckit/io/Buffer.h

@@ -50,6 +50,8 @@ class Buffer : private NonCopyable {
 
     ~Buffer();
 
+    std::string_view view() const noexcept { return std::string_view(buffer_, size_); }
+
     operator char*() { return buffer_; }
     operator const char*() const { return buffer_; }
 

src/eckit/io/fam/FamConfig.h

@@ -0,0 +1,47 @@
+/*
+ * (C) Copyright 1996- ECMWF.
+ *
+ * This software is licensed under the terms of the Apache Licence Version 2.0
+ * which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
+ * In applying this licence, ECMWF does not waive the privileges and immunities
+ * granted to it by virtue of its status as an intergovernmental organisation nor
+ * does it submit to any jurisdiction.
+ */
+
+/*
+ * This software was developed as part of the Horizon Europe programme funded project OpenCUBE
+ * (Grant agreement: 101092984) horizon-opencube.eu
+ */
+
+/// @file   FamConfig.h
+/// @author Metin Cakircali
+/// @date   May 2024
+
+#pragma once
+
+#include <ostream>
+#include <string>
+
+#include "eckit/net/Endpoint.h"
+
+namespace eckit {
+
+//----------------------------------------------------------------------------------------------------------------------
+
+struct FamConfig {
+    net::Endpoint endpoint{"127.0.0.1", -1};
+    std::string sessionName{"EckitFamSession"};
+
+    bool operator==(const FamConfig& other) const {
+        return (endpoint == other.endpoint && sessionName == other.sessionName);
+    }
+
+    friend std::ostream& operator<<(std::ostream& out, const FamConfig& config) {
+        out << "endpoint=" << config.endpoint << ", sessionName=" << config.sessionName;
+        return out;
+    }
+};
+
+//----------------------------------------------------------------------------------------------------------------------
+
+}  // namespace eckit