RDF 1.1

Author: Matthäus G. Chajdas

CMakeLists.txt

@@ -1,4 +1,4 @@
-### Copyright (c) 2021 Advanced Micro Devices, Inc. All rights reserved. ###
+### Copyright (c) 2021-2022 Advanced Micro Devices, Inc. All rights reserved. ###
 cmake_minimum_required(VERSION 3.13..3.21)
 project(rdf LANGUAGES CXX)
 

README.md

@@ -28,4 +28,12 @@ The `amdrdf` library provides the following forwards/backwards compatibility gua
 * New major versions *may* add, remove or change entry points. Files created by a newer major version *may* not be compatible with older *major* versions. Files created by an older major version will be supported for *at least* the next higher major version.
 * A minor version can deprecate a function, but that function can be only removed in the next major release.
 
-Use `RDF_INTERFACE_VERSION` and `RDF_MAKE_VERSION` to check for the library version.
+Use `RDF_INTERFACE_VERSION` and `RDF_MAKE_VERSION` to check for the library version.
+
+## Changelog
+
+Interface-level changes only:
+
+* **1.0**: Initial release
+* **1.1**: Improve naming consistency: Add `rdfStreamFromUserStream`, mark `rdfStreamCreateFromUserStream` as deprecated
+  

imported/CMakeLists.txt

@@ -1,4 +1,4 @@
-### Copyright (c) 2021 Advanced Micro Devices, Inc. All rights reserved. ###
+### Copyright (c) 2021-2022 Advanced Micro Devices, Inc. All rights reserved. ###
 add_subdirectory(zstd)
 
 # This allows clients of RDF to have their own copy of catch2/cli11/json, and

imported/catch2/CMakeLists.txt

@@ -1,4 +1,4 @@
-### Copyright (c) 2021 Advanced Micro Devices, Inc. All rights reserved. ###
+### Copyright (c) 2021-2022 Advanced Micro Devices, Inc. All rights reserved. ###
 project(Catch2)
 add_library(catch2 INTERFACE)
 target_include_directories(catch2 INTERFACE ${CMAKE_CURRENT_LIST_DIR})

imported/cli11/CMakeLists.txt

@@ -1,4 +1,4 @@
-### Copyright (c) 2021 Advanced Micro Devices, Inc. All rights reserved. ###
+### Copyright (c) 2021-2022 Advanced Micro Devices, Inc. All rights reserved. ###
 project(CLI11 VERSION 1.9.1)
 add_library(cli11 INTERFACE)
 target_include_directories(cli11 INTERFACE ${CMAKE_CURRENT_LIST_DIR})

imported/json/CMakeLists.txt

@@ -1,4 +1,4 @@
-### Copyright (c) 2021 Advanced Micro Devices, Inc. All rights reserved. ###
+### Copyright (c) 2021-2022 Advanced Micro Devices, Inc. All rights reserved. ###
 project(json VERSION 3.9.1)
 add_library(json INTERFACE)
 target_include_directories(json INTERFACE ${CMAKE_CURRENT_LIST_DIR})

imported/zstd/CMakeLists.txt

@@ -1,4 +1,4 @@
-### Copyright (c) 2021 Advanced Micro Devices, Inc. All rights reserved. ###
+### Copyright (c) 2021-2022 Advanced Micro Devices, Inc. All rights reserved. ###
 project(zstd VERSION 1.4.5)
 add_library(zstd STATIC src/zstd.c)
 target_include_directories(zstd PUBLIC ${CMAKE_CURRENT_LIST_DIR}/inc)

rdf/CMakeLists.txt

@@ -1,4 +1,4 @@
-### Copyright (c) 2021 Advanced Micro Devices, Inc. All rights reserved. ###
+### Copyright (c) 2021-2022 Advanced Micro Devices, Inc. All rights reserved. ###
 if (RDF_STATIC)
     add_library(amdrdf STATIC)
 else()

rdf/inc/amdrdf.h

@@ -1,4 +1,4 @@
-/* Copyright (c) 2021 Advanced Micro Devices, Inc. All rights reserved. */
+/* Copyright (c) 2021-2022 Advanced Micro Devices, Inc. All rights reserved. */
 #pragma once
 
 #include <cstddef>
@@ -24,7 +24,7 @@
     ((static_cast<std::uint32_t>(major) << 22) | \
      (static_cast<std::uint32_t>(minor) << 12))
 
-#define RDF_INTERFACE_VERSION RDF_MAKE_VERSION(1, 0)
+#define RDF_INTERFACE_VERSION RDF_MAKE_VERSION(1, 1)
 
 extern "C" {
 struct rdfChunkFile;
@@ -151,7 +151,18 @@ int RDF_EXPORT rdfStreamFromReadOnlyMemory(const std::int64_t size,
                                            const void* buffer,
                                            rdfStream** stream);
 int RDF_EXPORT rdfStreamCreateMemoryStream(rdfStream** stream);
+
+/**
+ * @deprecated Use `rdfStreamFromUserStream` instead
+ * 
+ * This entry point will be removed in the next major version
+ */
 int RDF_EXPORT rdfStreamCreateFromUserStream(const rdfUserStream* userStream, rdfStream** stream);
+
+/**
+ * @since 1.1
+ */
+int RDF_EXPORT rdfStreamFromUserStream(const rdfUserStream* userStream, rdfStream** stream);
 int RDF_EXPORT rdfStreamClose(rdfStream** stream);
 
 int RDF_EXPORT rdfStreamRead(rdfStream*,
@@ -325,6 +336,13 @@ class Stream final
         return result;
     }
 
+    static Stream FromUserStream(const rdfUserStream* userStream)
+    {
+        Stream result;
+        RDF_CHECK_CALL(rdfStreamFromUserStream(userStream, &result.stream_));
+        return result;
+    }
+
     ~Stream()
     {
         if (stream_) {

rdf/src/amdrdf.cpp

@@ -1,4 +1,4 @@
-/* Copyright (c) 2021 Advanced Micro Devices, Inc. All rights reserved. */
+/* Copyright (c) 2021-2022 Advanced Micro Devices, Inc. All rights reserved. */
 #include "amdrdf.h"
 
 #include <zstd/zstd.h>
@@ -1308,11 +1308,17 @@ int RDF_EXPORT rdfStreamCreateMemoryStream(rdfStream** handle)
     RDF_C_API_END
 }
 
+//////////////////////////////////////////////////////////////////////////////
+int RDF_EXPORT rdfStreamCreateFromUserStream(const rdfUserStream* userStream, rdfStream** handle)
+{
+    return rdfStreamFromUserStream(userStream, handle);
+}
+
 //////////////////////////////////////////////////////////////////////////////
 /**
 Create a memory stream based on user provided callbacks.
 */
-int RDF_EXPORT rdfStreamCreateFromUserStream(const rdfUserStream* userStream, rdfStream** handle)
+int RDF_EXPORT rdfStreamFromUserStream(const rdfUserStream* userStream, rdfStream** handle)
 {
     RDF_C_API_BEGIN