Skip to content

Commit b02c3c5

Browse files
KFilipekKFilipek
authored
Merge pull request #1397 from lplewa/memspace_experiment
move memspace api to experimental
2 parents 5835cb8 + 6dcd296 commit b02c3c5

28 files changed

+55
-43
lines changed

‎README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -327,6 +327,8 @@ Packages required for using this pool and executing tests/benchmarks (not requir
327327

328328
### Memspaces (Linux-only)
329329

330+
> **Note**: The memspace, memtarget and mempolicy APIs are experimental and may change in future releases.
331+
330332
TODO: Add general information about memspaces.
331333

332334
#### Host all memspace

‎docs/config/api.rst

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -136,29 +136,38 @@ Memspace
136136

137137
TODO: Add general information about memspaces.
138138

139+
.. note::
140+
The memspace APIs are experimental and may change in future releases.
141+
139142
Memspace
140143
------------------------------------------
141-
.. doxygenfile:: memspace.h
144+
.. doxygenfile:: experimental/memspace.h
142145
:sections: define enum typedef func
143146

144147
Mempolicy
145148
==========================================
146149

147150
TODO: Add general information about mempolicies.
148151

152+
.. note::
153+
The mempolicy APIs are experimental and may change in future releases.
154+
149155
Mempolicy
150156
------------------------------------------
151-
.. doxygenfile:: mempolicy.h
157+
.. doxygenfile:: experimental/mempolicy.h
152158
:sections: define enum typedef func
153159

154160
Memtarget
155161
==========================================
156162

157163
TODO: Add general information about memtargets.
158164

165+
.. note::
166+
The memtarget APIs are experimental and may change in future releases.
167+
159168
Memtarget
160169
------------------------------------------
161-
.. doxygenfile:: memtarget.h
170+
.. doxygenfile:: experimental/memtarget.h
162171
:sections: define enum typedef func
163172

164173
Inter-Process Communication

‎docs/config/examples.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,9 @@ TODO
131131
Memspace
132132
==============================================================================
133133

134+
.. note::
135+
Memspace examples rely on experimental APIs that may change in future releases.
136+
134137
You can find the full examples code in the `examples/memspace`_ directory
135138
in the UMF repository.
136139

‎examples/memspace_hmat/memspace_hmat.c

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
/*
22
*
3-
* Copyright (C) 2024 Intel Corporation
3+
* Copyright (C) 2024-2025 Intel Corporation
44
*
55
* Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
66
* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
77
*
88
*/
99

10-
#include <umf/mempolicy.h>
11-
#include <umf/memspace.h>
10+
#include <umf/experimental/mempolicy.h>
11+
#include <umf/experimental/memspace.h>
1212

1313
#include <numa.h>
1414
#include <numaif.h>

‎examples/memspace_numa/memspace_numa.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
#include <stdio.h>
1313
#include <string.h>
1414

15-
#include <umf/mempolicy.h>
16-
#include <umf/memspace.h>
15+
#include <umf/experimental/mempolicy.h>
16+
#include <umf/experimental/memspace.h>
1717

1818
#include "examples_utils.h"
1919

‎include/umf.h

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,6 @@
1313
#include <umf/base.h>
1414
#include <umf/memory_pool.h>
1515
#include <umf/memory_provider.h>
16-
#include <umf/mempolicy.h>
17-
#include <umf/memspace.h>
1816

1917
#ifdef __cplusplus
2018
extern "C" {

‎include/umf/mempolicy.h renamed to ‎include/umf/experimental/mempolicy.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/*
22
*
3-
* Copyright (C) 2024 Intel Corporation
3+
* Copyright (C) 2024-2025 Intel Corporation
44
*
55
* Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
66
* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

‎include/umf/memspace.h renamed to ‎include/umf/experimental/memspace.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@
1111
#define UMF_MEMSPACE_H 1
1212

1313
#include <umf/base.h>
14+
#include <umf/experimental/mempolicy.h>
15+
#include <umf/experimental/memtarget.h>
1416
#include <umf/memory_pool.h>
1517
#include <umf/memory_provider.h>
16-
#include <umf/mempolicy.h>
17-
#include <umf/memtarget.h>
1818

1919
#ifdef __cplusplus
2020
extern "C" {

‎include/umf/memtarget.h renamed to ‎include/umf/experimental/memtarget.h

File renamed without changes.

‎src/mempolicy.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
/*
22
*
3-
* Copyright (C) 2024 Intel Corporation
3+
* Copyright (C) 2024-2025 Intel Corporation
44
*
55
* Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
66
* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
77
*
88
*/
9-
#include <umf/mempolicy.h>
9+
#include <umf/experimental/mempolicy.h>
1010

1111
#include "base_alloc_global.h"
1212
#include "mempolicy_internal.h"

‎src/mempolicy_internal.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/*
22
*
3-
* Copyright (C) 2024 Intel Corporation
3+
* Copyright (C) 2024-2025 Intel Corporation
44
*
55
* Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
66
* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
@@ -10,7 +10,7 @@
1010
#ifndef UMF_MEMPOLICY_INTERNAL_H
1111
#define UMF_MEMPOLICY_INTERNAL_H 1
1212

13-
#include <umf/mempolicy.h>
13+
#include <umf/experimental/mempolicy.h>
1414

1515
#ifdef __cplusplus
1616
extern "C" {

‎src/memspace.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
#include <assert.h>
1111
#include <stdlib.h>
1212

13-
#include <umf/memspace.h>
13+
#include <umf/experimental/memspace.h>
1414

1515
#include "base_alloc_global.h"
1616
#include "memspace_internal.h"

‎src/memspace_internal.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/*
22
*
3-
* Copyright (C) 2023-2024 Intel Corporation
3+
* Copyright (C) 2023-2025 Intel Corporation
44
*
55
* Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
66
* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
@@ -10,7 +10,7 @@
1010
#ifndef UMF_MEMSPACE_INTERNAL_H
1111
#define UMF_MEMSPACE_INTERNAL_H 1
1212

13-
#include <umf/memspace.h>
13+
#include <umf/experimental/memspace.h>
1414

1515
#include "base_alloc.h"
1616
#include "memtarget_internal.h"

‎src/memspaces/memspace_highest_bandwidth.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
#include <stdlib.h>
1313

1414
#include <umf.h>
15-
#include <umf/memspace.h>
15+
#include <umf/experimental/memspace.h>
1616

1717
// UMF_MEMSPACE_HIGHEST_BANDWIDTH requires HWLOC
1818
// Additionally, it is currently unsupported on Win

‎src/memspaces/memspace_highest_capacity.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/*
22
*
3-
* Copyright (C) 2024 Intel Corporation
3+
* Copyright (C) 2024-2025 Intel Corporation
44
*
55
* Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
66
* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
@@ -11,7 +11,7 @@
1111
#include <stdlib.h>
1212

1313
#include <umf.h>
14-
#include <umf/memspace.h>
14+
#include <umf/experimental/memspace.h>
1515

1616
// UMF_MEMSPACE_HIGHEST_CAPACITY requires HWLOC
1717
// Additionally, it is currently unsupported on Win

‎src/memspaces/memspace_host_all.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/*
22
*
3-
* Copyright (C) 2024 Intel Corporation
3+
* Copyright (C) 2024-2025 Intel Corporation
44
*
55
* Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
66
* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
@@ -11,7 +11,7 @@
1111
#include <stdlib.h>
1212

1313
#include <umf.h>
14-
#include <umf/memspace.h>
14+
#include <umf/experimental/memspace.h>
1515

1616
// UMF_MEMSPACE_HOST_ALL requires HWLOC
1717
// Additionally, it is currently unsupported on Win

‎src/memspaces/memspace_lowest_latency.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
#include <stdlib.h>
1313

1414
#include <umf.h>
15-
#include <umf/memspace.h>
15+
#include <umf/experimental/memspace.h>
1616

1717
// UMF_MEMSPACE_LOWEST_LATENCY requires HWLOC
1818
// Additionally, it is currently unsupported on Win

‎src/memspaces/memspace_numa.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
#include <stdlib.h>
1111

1212
#include <umf.h>
13-
#include <umf/memspace.h>
13+
#include <umf/experimental/memspace.h>
1414

1515
// umfMemspaceCreateFromNumaArray requires HWLOC
1616
// Additionally, it is currently unsupported on Win

‎src/memtarget_internal.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
#define UMF_MEMTARGET_INTERNAL_H 1
1212

1313
#include <umf/base.h>
14-
#include <umf/memtarget.h>
14+
#include <umf/experimental/memtarget.h>
1515
#ifdef __cplusplus
1616
extern "C" {
1717
#endif

‎src/memtarget_ops.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@
1111
#define UMF_MEMTARGET_OPS_H 1
1212

1313
#include <umf/base.h>
14-
#include <umf/memspace.h>
15-
#include <umf/memtarget.h>
14+
#include <umf/experimental/memspace.h>
15+
#include <umf/experimental/memtarget.h>
1616

1717
#ifdef __cplusplus
1818
extern "C" {

‎src/memtargets/memtarget_numa.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
#define UMF_MEMTARGET_NUMA_H 1
1212

1313
#include <umf.h>
14-
#include <umf/memspace.h>
14+
#include <umf/experimental/memspace.h>
1515

1616
#include "../memtarget_internal.h"
1717
#include "../memtarget_ops.h"

‎test/memspaces/memspace_fixtures.hpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright (C) 2024 Intel Corporation
1+
// Copyright (C) 2024-2025 Intel Corporation
22
// Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
33
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
44

@@ -10,7 +10,7 @@
1010
#include <numaif.h>
1111
#include <thread>
1212

13-
#include <umf/memspace.h>
13+
#include <umf/experimental/memspace.h>
1414

1515
#include "base.hpp"
1616
#include "memspace_helpers.hpp"

‎test/memspaces/memspace_highest_bandwidth.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
33
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
44

5-
#include <umf/memspace.h>
5+
#include <umf/experimental/memspace.h>
66

77
#include "memspace_fixtures.hpp"
88
#include "memspace_helpers.hpp"

‎test/memspaces/memspace_highest_capacity.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright (C) 2024 Intel Corporation
1+
// Copyright (C) 2024-2025 Intel Corporation
22
// Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
33
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
44

@@ -11,7 +11,7 @@
1111

1212
#include <numa.h>
1313
#include <numaif.h>
14-
#include <umf/memspace.h>
14+
#include <umf/experimental/memspace.h>
1515
#include <unordered_set>
1616

1717
using umf_test::test;

‎test/memspaces/memspace_host_all.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright (C) 2024 Intel Corporation
1+
// Copyright (C) 2024-2025 Intel Corporation
22
// Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
33
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
44

@@ -7,7 +7,7 @@
77
#include <sys/mman.h>
88
#include <unordered_set>
99

10-
#include <umf/memspace.h>
10+
#include <umf/experimental/memspace.h>
1111

1212
#include "memspace_fixtures.hpp"
1313
#include "memspace_helpers.hpp"

‎test/memspaces/memspace_lowest_latency.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
// Copyright (C) 2024 Intel Corporation
1+
// Copyright (C) 2024-2025 Intel Corporation
22
// Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
33
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
44

5-
#include <umf/memspace.h>
5+
#include <umf/experimental/memspace.h>
66

77
#include "memspace_fixtures.hpp"
88
#include "memspace_helpers.hpp"

‎test/memspaces/memspace_numa.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
#include "memspace_internal.h"
99
#include "numa_helpers.hpp"
1010

11-
#include <umf/memspace.h>
11+
#include <umf/experimental/memspace.h>
1212
#include <umf/providers/provider_os_memory.h>
1313

1414
struct memspaceNumaTest : ::numaNodesTest {

‎test/memspaces/memtarget.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
#include "memspace_helpers.hpp"
77

88
#include <umf/base.h>
9-
#include <umf/memspace.h>
10-
#include <umf/memtarget.h>
9+
#include <umf/experimental/memspace.h>
10+
#include <umf/experimental/memtarget.h>
1111

1212
using umf_test::test;
1313

0 commit comments

Comments
 (0)