Merge pull request #1397 from lplewa/memspace_experiment

KFilipek · web-flow · commit b02c3c5b3c2c · 2025-07-02T10:55:35.000+02:00
move memspace api to experimental
diff --git a/README.md b/README.md
@@ -327,6 +327,8 @@ Packages required for using this pool and executing tests/benchmarks (not requir
 
 ### Memspaces (Linux-only)
 
+> **Note**: The memspace, memtarget and mempolicy APIs are experimental and may change in future releases.
+
 TODO: Add general information about memspaces.
 
 #### Host all memspace
diff --git a/docs/config/api.rst b/docs/config/api.rst
@@ -136,29 +136,38 @@ Memspace
 
 TODO: Add general information about memspaces.
 
+.. note::
+   The memspace APIs are experimental and may change in future releases.
+
 Memspace
 ------------------------------------------
-.. doxygenfile:: memspace.h
+.. doxygenfile:: experimental/memspace.h
     :sections: define enum typedef func
 
 Mempolicy             
 ==========================================
 
 TODO: Add general information about mempolicies.
 
+.. note::
+   The mempolicy APIs are experimental and may change in future releases.
+
 Mempolicy
 ------------------------------------------
-.. doxygenfile:: mempolicy.h
+.. doxygenfile:: experimental/mempolicy.h
     :sections: define enum typedef func
 
 Memtarget
 ==========================================
 
 TODO: Add general information about memtargets.
 
+.. note::
+   The memtarget APIs are experimental and may change in future releases.
+
 Memtarget
 ------------------------------------------
-.. doxygenfile:: memtarget.h
+.. doxygenfile:: experimental/memtarget.h
     :sections: define enum typedef func
 
 Inter-Process Communication
diff --git a/docs/config/examples.rst b/docs/config/examples.rst
@@ -131,6 +131,9 @@ TODO
 Memspace
 ==============================================================================
 
+.. note::
+   Memspace examples rely on experimental APIs that may change in future releases.
+
 You can find the full examples code in the `examples/memspace`_ directory
 in the UMF repository.
 
diff --git a/examples/memspace_hmat/memspace_hmat.c b/examples/memspace_hmat/memspace_hmat.c
@@ -1,14 +1,14 @@
 /*
  *
- * Copyright (C) 2024 Intel Corporation
+ * Copyright (C) 2024-2025 Intel Corporation
  *
  * Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
  * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
  *
  */
 
-#include <umf/mempolicy.h>
-#include <umf/memspace.h>
+#include <umf/experimental/mempolicy.h>
+#include <umf/experimental/memspace.h>
 
 #include <numa.h>
 #include <numaif.h>
diff --git a/examples/memspace_numa/memspace_numa.c b/examples/memspace_numa/memspace_numa.c
@@ -12,8 +12,8 @@
 #include <stdio.h>
 #include <string.h>
 
-#include <umf/mempolicy.h>
-#include <umf/memspace.h>
+#include <umf/experimental/mempolicy.h>
+#include <umf/experimental/memspace.h>
 
 #include "examples_utils.h"
 
diff --git a/include/umf.h b/include/umf.h
@@ -13,8 +13,6 @@
 #include <umf/base.h>
 #include <umf/memory_pool.h>
 #include <umf/memory_provider.h>
-#include <umf/mempolicy.h>
-#include <umf/memspace.h>
 
 #ifdef __cplusplus
 extern "C" {
diff --git a/include/umf/experimental/mempolicy.h b/include/umf/experimental/mempolicy.h
@@ -1,6 +1,6 @@
 /*
  *
- * Copyright (C) 2024 Intel Corporation
+ * Copyright (C) 2024-2025 Intel Corporation
  *
  * Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
  * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
diff --git a/include/umf/experimental/memspace.h b/include/umf/experimental/memspace.h
@@ -11,10 +11,10 @@
 #define UMF_MEMSPACE_H 1
 
 #include <umf/base.h>
+#include <umf/experimental/mempolicy.h>
+#include <umf/experimental/memtarget.h>
 #include <umf/memory_pool.h>
 #include <umf/memory_provider.h>
-#include <umf/mempolicy.h>
-#include <umf/memtarget.h>
 
 #ifdef __cplusplus
 extern "C" {
diff --git a/include/umf/experimental/memtarget.h b/include/umf/experimental/memtarget.h
diff --git a/src/mempolicy.c b/src/mempolicy.c
@@ -1,12 +1,12 @@
 /*
  *
- * Copyright (C) 2024 Intel Corporation
+ * Copyright (C) 2024-2025 Intel Corporation
  *
  * Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
  * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
  *
  */
-#include <umf/mempolicy.h>
+#include <umf/experimental/mempolicy.h>
 
 #include "base_alloc_global.h"
 #include "mempolicy_internal.h"
diff --git a/src/mempolicy_internal.h b/src/mempolicy_internal.h
@@ -1,6 +1,6 @@
 /*
  *
- * Copyright (C) 2024 Intel Corporation
+ * Copyright (C) 2024-2025 Intel Corporation
  *
  * Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
  * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
@@ -10,7 +10,7 @@
 #ifndef UMF_MEMPOLICY_INTERNAL_H
 #define UMF_MEMPOLICY_INTERNAL_H 1
 
-#include <umf/mempolicy.h>
+#include <umf/experimental/mempolicy.h>
 
 #ifdef __cplusplus
 extern "C" {
diff --git a/src/memspace.c b/src/memspace.c
@@ -10,7 +10,7 @@
 #include <assert.h>
 #include <stdlib.h>
 
-#include <umf/memspace.h>
+#include <umf/experimental/memspace.h>
 
 #include "base_alloc_global.h"
 #include "memspace_internal.h"
diff --git a/src/memspace_internal.h b/src/memspace_internal.h
@@ -1,6 +1,6 @@
 /*
  *
- * Copyright (C) 2023-2024 Intel Corporation
+ * Copyright (C) 2023-2025 Intel Corporation
  *
  * Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
  * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
@@ -10,7 +10,7 @@
 #ifndef UMF_MEMSPACE_INTERNAL_H
 #define UMF_MEMSPACE_INTERNAL_H 1
 
-#include <umf/memspace.h>
+#include <umf/experimental/memspace.h>
 
 #include "base_alloc.h"
 #include "memtarget_internal.h"
diff --git a/src/memspaces/memspace_highest_bandwidth.c b/src/memspaces/memspace_highest_bandwidth.c
@@ -12,7 +12,7 @@
 #include <stdlib.h>
 
 #include <umf.h>
-#include <umf/memspace.h>
+#include <umf/experimental/memspace.h>
 
 // UMF_MEMSPACE_HIGHEST_BANDWIDTH requires HWLOC
 // Additionally, it is currently unsupported on Win
diff --git a/src/memspaces/memspace_highest_capacity.c b/src/memspaces/memspace_highest_capacity.c
@@ -1,6 +1,6 @@
 /*
  *
- * Copyright (C) 2024 Intel Corporation
+ * Copyright (C) 2024-2025 Intel Corporation
  *
  * Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
  * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
@@ -11,7 +11,7 @@
 #include <stdlib.h>
 
 #include <umf.h>
-#include <umf/memspace.h>
+#include <umf/experimental/memspace.h>
 
 // UMF_MEMSPACE_HIGHEST_CAPACITY requires HWLOC
 // Additionally, it is currently unsupported on Win
diff --git a/src/memspaces/memspace_host_all.c b/src/memspaces/memspace_host_all.c
@@ -1,6 +1,6 @@
 /*
  *
- * Copyright (C) 2024 Intel Corporation
+ * Copyright (C) 2024-2025 Intel Corporation
  *
  * Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
  * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
@@ -11,7 +11,7 @@
 #include <stdlib.h>
 
 #include <umf.h>
-#include <umf/memspace.h>
+#include <umf/experimental/memspace.h>
 
 // UMF_MEMSPACE_HOST_ALL requires HWLOC
 // Additionally, it is currently unsupported on Win
diff --git a/src/memspaces/memspace_lowest_latency.c b/src/memspaces/memspace_lowest_latency.c
@@ -12,7 +12,7 @@
 #include <stdlib.h>
 
 #include <umf.h>
-#include <umf/memspace.h>
+#include <umf/experimental/memspace.h>
 
 // UMF_MEMSPACE_LOWEST_LATENCY requires HWLOC
 // Additionally, it is currently unsupported on Win
diff --git a/src/memspaces/memspace_numa.c b/src/memspaces/memspace_numa.c
@@ -10,7 +10,7 @@
 #include <stdlib.h>
 
 #include <umf.h>
-#include <umf/memspace.h>
+#include <umf/experimental/memspace.h>
 
 // umfMemspaceCreateFromNumaArray requires HWLOC
 // Additionally, it is currently unsupported on Win
diff --git a/src/memtarget_internal.h b/src/memtarget_internal.h
@@ -11,7 +11,7 @@
 #define UMF_MEMTARGET_INTERNAL_H 1
 
 #include <umf/base.h>
-#include <umf/memtarget.h>
+#include <umf/experimental/memtarget.h>
 #ifdef __cplusplus
 extern "C" {
 #endif
diff --git a/src/memtarget_ops.h b/src/memtarget_ops.h
@@ -11,8 +11,8 @@
 #define UMF_MEMTARGET_OPS_H 1
 
 #include <umf/base.h>
-#include <umf/memspace.h>
-#include <umf/memtarget.h>
+#include <umf/experimental/memspace.h>
+#include <umf/experimental/memtarget.h>
 
 #ifdef __cplusplus
 extern "C" {
diff --git a/src/memtargets/memtarget_numa.h b/src/memtargets/memtarget_numa.h
@@ -11,7 +11,7 @@
 #define UMF_MEMTARGET_NUMA_H 1
 
 #include <umf.h>
-#include <umf/memspace.h>
+#include <umf/experimental/memspace.h>
 
 #include "../memtarget_internal.h"
 #include "../memtarget_ops.h"
diff --git a/test/memspaces/memspace_fixtures.hpp b/test/memspaces/memspace_fixtures.hpp
@@ -1,4 +1,4 @@
-// Copyright (C) 2024 Intel Corporation
+// Copyright (C) 2024-2025 Intel Corporation
 // Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 
@@ -10,7 +10,7 @@
 #include <numaif.h>
 #include <thread>
 
-#include <umf/memspace.h>
+#include <umf/experimental/memspace.h>
 
 #include "base.hpp"
 #include "memspace_helpers.hpp"
diff --git a/test/memspaces/memspace_highest_bandwidth.cpp b/test/memspaces/memspace_highest_bandwidth.cpp
@@ -2,7 +2,7 @@
 // Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 
-#include <umf/memspace.h>
+#include <umf/experimental/memspace.h>
 
 #include "memspace_fixtures.hpp"
 #include "memspace_helpers.hpp"
diff --git a/test/memspaces/memspace_highest_capacity.cpp b/test/memspaces/memspace_highest_capacity.cpp
@@ -1,4 +1,4 @@
-// Copyright (C) 2024 Intel Corporation
+// Copyright (C) 2024-2025 Intel Corporation
 // Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 
@@ -11,7 +11,7 @@
 
 #include <numa.h>
 #include <numaif.h>
-#include <umf/memspace.h>
+#include <umf/experimental/memspace.h>
 #include <unordered_set>
 
 using umf_test::test;
diff --git a/test/memspaces/memspace_host_all.cpp b/test/memspaces/memspace_host_all.cpp
@@ -1,4 +1,4 @@
-// Copyright (C) 2024 Intel Corporation
+// Copyright (C) 2024-2025 Intel Corporation
 // Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 
@@ -7,7 +7,7 @@
 #include <sys/mman.h>
 #include <unordered_set>
 
-#include <umf/memspace.h>
+#include <umf/experimental/memspace.h>
 
 #include "memspace_fixtures.hpp"
 #include "memspace_helpers.hpp"
diff --git a/test/memspaces/memspace_lowest_latency.cpp b/test/memspaces/memspace_lowest_latency.cpp
@@ -1,8 +1,8 @@
-// Copyright (C) 2024 Intel Corporation
+// Copyright (C) 2024-2025 Intel Corporation
 // Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 
-#include <umf/memspace.h>
+#include <umf/experimental/memspace.h>
 
 #include "memspace_fixtures.hpp"
 #include "memspace_helpers.hpp"
diff --git a/test/memspaces/memspace_numa.cpp b/test/memspaces/memspace_numa.cpp
@@ -8,7 +8,7 @@
 #include "memspace_internal.h"
 #include "numa_helpers.hpp"
 
-#include <umf/memspace.h>
+#include <umf/experimental/memspace.h>
 #include <umf/providers/provider_os_memory.h>
 
 struct memspaceNumaTest : ::numaNodesTest {
diff --git a/test/memspaces/memtarget.cpp b/test/memspaces/memtarget.cpp
@@ -6,8 +6,8 @@
 #include "memspace_helpers.hpp"
 
 #include <umf/base.h>
-#include <umf/memspace.h>
-#include <umf/memtarget.h>
+#include <umf/experimental/memspace.h>
+#include <umf/experimental/memtarget.h>
 
 using umf_test::test;
 

Original file line number	Diff line number	Diff line change
`@@ -1,14 +1,14 @@`
`1`	`1`	`/*`
`2`	`2`	`*`
`3`		`- * Copyright (C) 2024 Intel Corporation`
	`3`	`+ * Copyright (C) 2024-2025 Intel Corporation`
`4`	`4`	`*`
`5`	`5`	`* Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.`
`6`	`6`	`* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception`
`7`	`7`	`*`
`8`	`8`	`*/`
`9`	`9`
`10`		`-#include <umf/mempolicy.h>`
`11`		`-#include <umf/memspace.h>`
	`10`	`+#include <umf/experimental/mempolicy.h>`
	`11`	`+#include <umf/experimental/memspace.h>`
`12`	`12`
`13`	`13`	`#include <numa.h>`
`14`	`14`	`#include <numaif.h>`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`/*`
`2`	`2`	`*`
`3`		`- * Copyright (C) 2024 Intel Corporation`
	`3`	`+ * Copyright (C) 2024-2025 Intel Corporation`
`4`	`4`	`*`
`5`	`5`	`* Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.`
`6`	`6`	`* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception`
Original file line number	Diff line number	Diff line change
`@@ -1,12 +1,12 @@`
`1`	`1`	`/*`
`2`	`2`	`*`
`3`		`- * Copyright (C) 2024 Intel Corporation`
	`3`	`+ * Copyright (C) 2024-2025 Intel Corporation`
`4`	`4`	`*`
`5`	`5`	`* Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.`
`6`	`6`	`* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception`
`7`	`7`	`*`
`8`	`8`	`*/`
`9`		`-#include <umf/mempolicy.h>`
	`9`	`+#include <umf/experimental/mempolicy.h>`
`10`	`10`
`11`	`11`	`#include "base_alloc_global.h"`
`12`	`12`	`#include "mempolicy_internal.h"`