Skip to content

Add C-API method to fetch cuVS version from Java. #935

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rapids-bot merged 4 commits into from
Jun 7, 2025
Merged

Add C-API method to fetch cuVS version from Java. #935

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0ffd8b7
Add C-API method to fetch cuVS version from Java.
mythrocks Jun 3, 2025
303684e
Merge branch 'branch-25.08' into get-version-jni-c-api
mythrocks Jun 4, 2025
d423dfa
Merge branch 'branch-25.08' into get-version-jni-c-api
cjnolet Jun 5, 2025
2d9866f
Merge branch 'branch-25.08' into get-version-jni-c-api
mythrocks Jun 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions ci/release/update-version.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,3 +108,8 @@ done
sed_runner "s| CuVS [[:digit:]]\{2\}\.[[:digit:]]\{2\} | CuVS ${NEXT_SHORT_TAG} |g" java/README.md
sed_runner "s|-[[:digit:]]\{2\}\.[[:digit:]]\{2\}\.[[:digit:]]\{1,2\}\.jar|-${NEXT_FULL_JAVA_TAG}\.jar|g" java/examples/README.md
sed_runner "s|/[[:digit:]]\{2\}\.[[:digit:]]\{2\}\.[[:digit:]]\{1,2\}/|/${NEXT_FULL_JAVA_TAG}/|g" java/examples/README.md

# Update C API version.
sed_runner "s|CUVS_VERSION_MAJOR = [0-9][0-9]|CUVS_VERSION_MAJOR = ${NEXT_MAJOR}|g" cpp/include/cuvs/core/c_api.h
sed_runner "s|CUVS_VERSION_MINOR = [0-9][0-9]|CUVS_VERSION_MINOR = ${NEXT_MINOR}|g" cpp/include/cuvs/core/c_api.h
sed_runner "s|CUVS_VERSION_PATCH = [0-9][0-9]|CUVS_VERSION_PATCH = ${NEXT_PATCH}|g" cpp/include/cuvs/core/c_api.h
15 changes: 14 additions & 1 deletion cpp/include/cuvs/core/c_api.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@
#include <stdbool.h>
#include <stdint.h>

static const uint16_t CUVS_VERSION_MAJOR = 25;
static const uint16_t CUVS_VERSION_MINOR = 06;
static const uint16_t CUVS_VERSION_PATCH = 00;

#ifdef __cplusplus
extern "C" {
#endif
Expand All @@ -29,7 +33,7 @@ extern "C" {
* @{
*/
/**
* @brief An enum denoting return values for function calls
* @brief An enum denoting error statuses for function calls
*
*/
typedef enum { CUVS_ERROR, CUVS_SUCCESS } cuvsError_t;
Expand Down Expand Up @@ -167,6 +171,15 @@ cuvsError_t cuvsRMMHostAlloc(void** ptr, size_t bytes);
*/
cuvsError_t cuvsRMMHostFree(void* ptr, size_t bytes);

/**
* @brief Get the version of the cuVS library
* @param[out] major Major version
* @param[out] minor Minor version
* @param[out] patch Patch version
* @return cuvsError_t
*/
cuvsError_t cuvsVersionGet(uint16_t* major, uint16_t* minor, uint16_t* patch);

/** @} */

#ifdef __cplusplus
Expand Down
8 changes: 8 additions & 0 deletions cpp/src/core/c_api.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,3 +154,11 @@ extern "C" const char* cuvsGetLastErrorText()
}

extern "C" void cuvsSetLastErrorText(const char* error) { last_error_text = error ? error : ""; }

extern "C" cuvsError_t cuvsVersionGet(uint16_t* major, uint16_t* minor, uint16_t* patch)
{
*major = CUVS_VERSION_MAJOR;
*minor = CUVS_VERSION_MINOR;
*patch = CUVS_VERSION_PATCH;
return CUVS_SUCCESS;
}
8 changes: 8 additions & 0 deletions cpp/tests/core/c_api.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,5 +86,13 @@ int main()
error = cuvsResourcesDestroy(res);
if (error == CUVS_ERROR) { exit(EXIT_FAILURE); }

// Check version
uint16_t major, minor, patch;
error = cuvsVersionGet(&major, &minor, &patch);
if (error == CUVS_ERROR || major != CUVS_VERSION_MAJOR || minor != CUVS_VERSION_MINOR ||
patch != CUVS_VERSION_PATCH) {
exit(EXIT_FAILURE);
}

return 0;
}