Add backward compatibility workflow and tests #1063

bratpiorka · 2025-01-28T14:56:59Z

Add backward compatibility workflow and tests.

Suppose we have umfFunc_0_11 and umfFunc_0_10. With this PR:

"umfFunc" == "umfFunc_0_11" in compile time (using #define)
UMF exports 2 symbols: "umfFunc@@UMF_0.10" and "umfFunc_0_11@@UMF_0.11"
dlsym("umfFunc") == "umfFunc_0_10"
dlsym("umfFunc_0_11") == "umfFunc_0_11"

Major changes:

use UMF_PROVIDER_OPS_VERSION_CURRENT and UMF_POOL_OPS_VERSION_CURRENT for versioning memory provider and pools struct instead of UMF_VERSION_CURRENT that would be used only for versioning the lib
add new implementation for umfDevDaxMemoryProviderOps and umfFileMemoryProviderOps ver 0.11
handle old (0.10) provider ops in umfMemoryProviderCreate
do not assert when the user pass an old provider/pool version of ops to umfMemoryProvider/PoolCreate and print a warning instead
add tests for multiple symbols (file and DevDax providers ops) - assume that calling dlsym without a specified version returns the oldest implementation

fixes #908

.github/workflows/reusable_compatibility.yml

src/memory_provider.c

.github/workflows/reusable_compatibility.yml

src/memory_provider.c

lukaszstolarczuk · 2025-02-03T11:27:04Z

.github/workflows/pr_push.yml

+        tag: ["v0.10.1"]
+    with:
+      tag: ${{matrix.tag}}
+


missing EOF

lukaszstolarczuk · 2025-02-03T11:33:25Z

.github/workflows/reusable_compatibility.yml

+      working-directory: ${{github.workspace}}/tag_version
+      run: |
+        VERSION=$(git describe --tags --abbrev=0 | grep -oP '\d+\.\d+\.\d+')
+        echo "tag version: $VERSION"


why "cut it"? Just running git describe --tags should suffice

lukaszstolarczuk · 2025-02-03T12:00:27Z

.github/workflows/reusable_compatibility.yml

+      run: >
+        cmake
+        -B ${{github.workspace}}/tag_version/build
+        -DCMAKE_INSTALL_PREFIX="${{github.workspace}}/tag_version/build/install"


maybe drop "build" in the path here, so the installation will be sep. from build?

also, do we even use this install_prefix?

lukaszstolarczuk · 2025-02-03T12:02:32Z

.github/workflows/reusable_compatibility.yml

+      working-directory: ${{github.workspace}}/latest_version
+      run: |
+        VERSION=$(git describe --tags --abbrev=0 | grep -oP '\d+\.\d+\.\d+')
+        echo "checked version: $VERSION"


lukaszstolarczuk · 2025-02-03T12:05:08Z

.github/workflows/reusable_compatibility.yml

+      run: >
+        cmake
+        -B ${{github.workspace}}/latest_version/build
+        -DCMAKE_INSTALL_PREFIX="${{github.workspace}}/latest_version/build/install"


lukaszstolarczuk · 2025-02-03T12:10:08Z

.github/workflows/reusable_compatibility.yml

+        -DCMAKE_C_COMPILER=cl
+        -DCMAKE_CXX_COMPILER=cl
+        -DUMF_BUILD_SHARED_LIBRARY=ON
+        -DUMF_BUILD_TESTS=ON


lukaszstolarczuk · 2025-02-03T12:10:46Z

.github/workflows/reusable_compatibility.yml

+
+    # NOTE: exclude umf-provider_coarse, umf-disjointCoarseMallocPool, 
+    # umf-jemalloc_coarse_file, umf-scalable_coarse_file as they use Coarse 
+    # NOTE2: on Windows we simply overwrite the umf.dll


heh, this NOTE2 should be moved a little down, I guess

lukaszstolarczuk · 2025-02-03T12:14:57Z

src/memory_pool.c

@@ -38,7 +38,11 @@ static umf_result_t umfPoolCreateInternal(const umf_memory_pool_ops_t *ops,
        return UMF_RESULT_ERROR_OUT_OF_HOST_MEMORY;
    }

-    assert(ops->version == UMF_VERSION_CURRENT);
+    if (ops->version != UMF_POOL_OPS_VERSION_CURRENT) {
+        LOG_WARN("memory pool ops version \"%d\" is different than current "


...then the current..

lukaszstolarczuk · 2025-02-03T12:15:35Z

src/memory_provider.c

        return UMF_RESULT_ERROR_INVALID_ARGUMENT;
    }

+    umf_memory_provider_ops_t ops_current_ver;
+    if (ops->version != UMF_PROVIDER_OPS_VERSION_CURRENT) {
+        LOG_WARN("Memory Provider ops version \"%d\" is different than current "


. (pls apply in all messages)

lukaszstolarczuk · 2025-02-03T12:18:38Z

include/umf/memory_pool_ops.h

+/// @brief Version of the Memory Pool ops structure.
+/// NOTE: This is equal to the latest UMF version, in which the ops structure
+/// has been modified.
+#define UMF_POOL_OPS_VERSION_CURRENT UMF_MAKE_VERSION(0, 11)


should RELEASE_STEPS include this info..?

lukaszstolarczuk

all that code in 1 commit? ;-) Consider splitting or, at least, describing it a little more in the commit msg, pls.

bratpiorka · 2025-02-04T13:33:42Z

all that code in 1 commit? ;-) Consider splitting or, at least, describing it a little more in the commit msg, pls.

done

PatKamin reviewed Jan 28, 2025

View reviewed changes

.github/workflows/reusable_compatibility.yml Outdated Show resolved Hide resolved

bratpiorka force-pushed the rrudnick_compat_wflow branch 3 times, most recently from b4226c3 to a341c50 Compare January 29, 2025 11:25

lplewa reviewed Jan 29, 2025

View reviewed changes

src/memory_provider.c Outdated Show resolved Hide resolved

bratpiorka force-pushed the rrudnick_compat_wflow branch 4 times, most recently from b4edc5c to 6baaa70 Compare January 29, 2025 17:16

bratpiorka mentioned this pull request Jan 29, 2025

[common] Bump UMF to early 0.11 version, from main oneapi-src/unified-runtime#2596

Merged

PatKamin reviewed Jan 30, 2025

View reviewed changes

.github/workflows/reusable_compatibility.yml Outdated Show resolved Hide resolved

.github/workflows/reusable_compatibility.yml Show resolved Hide resolved

PatKamin reviewed Jan 30, 2025

View reviewed changes

src/memory_provider.c Outdated Show resolved Hide resolved

bratpiorka force-pushed the rrudnick_compat_wflow branch 10 times, most recently from 2a23695 to be7dbb6 Compare January 31, 2025 12:45

bratpiorka changed the title ~~[DRAFT] compat~~ Add backward compatibility workflow and test Jan 31, 2025

bratpiorka changed the title ~~Add backward compatibility workflow and test~~ Add backward compatibility workflow and tests Jan 31, 2025

bratpiorka force-pushed the rrudnick_compat_wflow branch from be7dbb6 to 51391d7 Compare January 31, 2025 17:32

oneapi-src deleted a comment from github-actions bot Jan 31, 2025

bratpiorka force-pushed the rrudnick_compat_wflow branch 3 times, most recently from 143d33a to 965b918 Compare January 31, 2025 17:57

bratpiorka force-pushed the rrudnick_compat_wflow branch 10 times, most recently from 49a57f5 to 3ecbe58 Compare February 2, 2025 15:49

bratpiorka marked this pull request as ready for review February 3, 2025 07:45

bratpiorka requested a review from a team as a code owner February 3, 2025 07:45

bratpiorka requested a review from lukaszstolarczuk February 3, 2025 07:45

lukaszstolarczuk reviewed Feb 3, 2025

View reviewed changes

bratpiorka force-pushed the rrudnick_compat_wflow branch 4 times, most recently from 5aafd9a to 5fa5a8b Compare February 4, 2025 13:33

bratpiorka requested review from PatKamin and lukaszstolarczuk February 4, 2025 13:33

bratpiorka added 5 commits February 4, 2025 14:08

use separate provider/pool versions in ops structure

4b3714a

add backward compatibility for 0.10.1 ops structs

e5d3861

add tests for backward compatility

cce29c1

add backward compatibility workflow

a11848f

update RELEASE_STEPS

5fa5a8b

lplewa mentioned this pull request Feb 5, 2025

Backward Compatibility for OPS Structures #1078

Open

bratpiorka marked this pull request as draft February 6, 2025 12:59

bratpiorka added this to the v0.11.x milestone Feb 10, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add backward compatibility workflow and tests #1063

Add backward compatibility workflow and tests #1063

bratpiorka commented Jan 28, 2025 •

edited

Loading

lukaszstolarczuk Feb 3, 2025

bratpiorka Feb 4, 2025

lukaszstolarczuk Feb 3, 2025

bratpiorka Feb 4, 2025

lukaszstolarczuk Feb 3, 2025

bratpiorka Feb 4, 2025

lukaszstolarczuk Feb 3, 2025

bratpiorka Feb 4, 2025

lukaszstolarczuk Feb 3, 2025

bratpiorka Feb 4, 2025

lukaszstolarczuk Feb 3, 2025

bratpiorka Feb 4, 2025

lukaszstolarczuk Feb 3, 2025

bratpiorka Feb 4, 2025

lukaszstolarczuk Feb 3, 2025

bratpiorka Feb 4, 2025

lukaszstolarczuk Feb 3, 2025

bratpiorka Feb 4, 2025

lukaszstolarczuk Feb 3, 2025

bratpiorka Feb 4, 2025

lukaszstolarczuk left a comment

bratpiorka commented Feb 4, 2025

Add backward compatibility workflow and tests #1063

Are you sure you want to change the base?

Add backward compatibility workflow and tests #1063

Conversation

bratpiorka commented Jan 28, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lukaszstolarczuk left a comment

Choose a reason for hiding this comment

bratpiorka commented Feb 4, 2025

bratpiorka commented Jan 28, 2025 •

edited

Loading