diff --git a/README.md b/README.md index 403f897bb4..02d59538af 100644 --- 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 index 97e664d97f..8796234280 100644 --- a/docs/config/api.rst +++ b/docs/config/api.rst @@ -136,9 +136,12 @@ 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 @@ -146,9 +149,12 @@ 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 @@ -156,9 +162,12 @@ 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 index 4eeea6aa95..b5287d148a 100644 --- 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 index 9f3f8d17e9..c86efa4d23 100644 --- 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 -#include +#include +#include #include #include diff --git a/examples/memspace_numa/memspace_numa.c b/examples/memspace_numa/memspace_numa.c index b0e399fb23..729e74ca28 100644 --- a/examples/memspace_numa/memspace_numa.c +++ b/examples/memspace_numa/memspace_numa.c @@ -12,8 +12,8 @@ #include #include -#include -#include +#include +#include #include "examples_utils.h" diff --git a/include/umf.h b/include/umf.h index 6c23bb16e9..5fe18b8d9a 100644 --- a/include/umf.h +++ b/include/umf.h @@ -13,8 +13,6 @@ #include #include #include -#include -#include #ifdef __cplusplus extern "C" { diff --git a/include/umf/mempolicy.h b/include/umf/experimental/mempolicy.h similarity index 98% rename from include/umf/mempolicy.h rename to include/umf/experimental/mempolicy.h index 59ca5bdd77..350baad5cc 100644 --- a/include/umf/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/memspace.h b/include/umf/experimental/memspace.h similarity index 98% rename from include/umf/memspace.h rename to include/umf/experimental/memspace.h index 6f3abebfaa..8447c50266 100644 --- a/include/umf/memspace.h +++ b/include/umf/experimental/memspace.h @@ -11,10 +11,10 @@ #define UMF_MEMSPACE_H 1 #include +#include +#include #include #include -#include -#include #ifdef __cplusplus extern "C" { diff --git a/include/umf/memtarget.h b/include/umf/experimental/memtarget.h similarity index 100% rename from include/umf/memtarget.h rename to include/umf/experimental/memtarget.h diff --git a/src/mempolicy.c b/src/mempolicy.c index 1b78053b25..240f767b05 100644 --- 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 +#include #include "base_alloc_global.h" #include "mempolicy_internal.h" diff --git a/src/mempolicy_internal.h b/src/mempolicy_internal.h index 57acaf02d0..58c0fbc79b 100644 --- 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 +#include #ifdef __cplusplus extern "C" { diff --git a/src/memspace.c b/src/memspace.c index 716dc01919..d473dda9c6 100644 --- a/src/memspace.c +++ b/src/memspace.c @@ -10,7 +10,7 @@ #include #include -#include +#include #include "base_alloc_global.h" #include "memspace_internal.h" diff --git a/src/memspace_internal.h b/src/memspace_internal.h index e31898e84e..4721470c83 100644 --- 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 +#include #include "base_alloc.h" #include "memtarget_internal.h" diff --git a/src/memspaces/memspace_highest_bandwidth.c b/src/memspaces/memspace_highest_bandwidth.c index d0beb2bb62..0790c406d2 100644 --- a/src/memspaces/memspace_highest_bandwidth.c +++ b/src/memspaces/memspace_highest_bandwidth.c @@ -12,7 +12,7 @@ #include #include -#include +#include // 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 index 4a195316af..36ef01b1c2 100644 --- 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 #include -#include +#include // 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 index 4b7db69d4b..efcfa7ef4b 100644 --- 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 #include -#include +#include // 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 index a463dd41ad..8fc33ae41e 100644 --- a/src/memspaces/memspace_lowest_latency.c +++ b/src/memspaces/memspace_lowest_latency.c @@ -12,7 +12,7 @@ #include #include -#include +#include // 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 index 83e65fc291..4ac420ff75 100644 --- a/src/memspaces/memspace_numa.c +++ b/src/memspaces/memspace_numa.c @@ -10,7 +10,7 @@ #include #include -#include +#include // umfMemspaceCreateFromNumaArray requires HWLOC // Additionally, it is currently unsupported on Win diff --git a/src/memtarget_internal.h b/src/memtarget_internal.h index 85ec99b8e6..f2eef4f3d0 100644 --- a/src/memtarget_internal.h +++ b/src/memtarget_internal.h @@ -11,7 +11,7 @@ #define UMF_MEMTARGET_INTERNAL_H 1 #include -#include +#include #ifdef __cplusplus extern "C" { #endif diff --git a/src/memtarget_ops.h b/src/memtarget_ops.h index 4bd9bb8997..1abb473894 100644 --- a/src/memtarget_ops.h +++ b/src/memtarget_ops.h @@ -11,8 +11,8 @@ #define UMF_MEMTARGET_OPS_H 1 #include -#include -#include +#include +#include #ifdef __cplusplus extern "C" { diff --git a/src/memtargets/memtarget_numa.h b/src/memtargets/memtarget_numa.h index 6659d045ef..188ac4ce73 100644 --- a/src/memtargets/memtarget_numa.h +++ b/src/memtargets/memtarget_numa.h @@ -11,7 +11,7 @@ #define UMF_MEMTARGET_NUMA_H 1 #include -#include +#include #include "../memtarget_internal.h" #include "../memtarget_ops.h" diff --git a/test/memspaces/memspace_fixtures.hpp b/test/memspaces/memspace_fixtures.hpp index da174c4f1a..4bbb5d65a3 100644 --- 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 #include -#include +#include #include "base.hpp" #include "memspace_helpers.hpp" diff --git a/test/memspaces/memspace_highest_bandwidth.cpp b/test/memspaces/memspace_highest_bandwidth.cpp index d4d3cd8a99..5bedac0eae 100644 --- 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 +#include #include "memspace_fixtures.hpp" #include "memspace_helpers.hpp" diff --git a/test/memspaces/memspace_highest_capacity.cpp b/test/memspaces/memspace_highest_capacity.cpp index 8452e74a79..5da14fe4a5 100644 --- 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 #include -#include +#include #include using umf_test::test; diff --git a/test/memspaces/memspace_host_all.cpp b/test/memspaces/memspace_host_all.cpp index 3462b87dc0..4fd0f5bff5 100644 --- 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 #include -#include +#include #include "memspace_fixtures.hpp" #include "memspace_helpers.hpp" diff --git a/test/memspaces/memspace_lowest_latency.cpp b/test/memspaces/memspace_lowest_latency.cpp index fc35f465a0..02fdd481ef 100644 --- 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 +#include #include "memspace_fixtures.hpp" #include "memspace_helpers.hpp" diff --git a/test/memspaces/memspace_numa.cpp b/test/memspaces/memspace_numa.cpp index be961fb890..c2cc0e4d9b 100644 --- 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 +#include #include struct memspaceNumaTest : ::numaNodesTest { diff --git a/test/memspaces/memtarget.cpp b/test/memspaces/memtarget.cpp index bd80ec14fd..9b029c9d25 100644 --- a/test/memspaces/memtarget.cpp +++ b/test/memspaces/memtarget.cpp @@ -6,8 +6,8 @@ #include "memspace_helpers.hpp" #include -#include -#include +#include +#include using umf_test::test;