ggml : add version function to get lib version (#1286)

* ggml : add version function to get lib version

This commit adds a function `ggml_version()` to the ggml library that
returns the version of the library as a string.

The motivation for this is that it can be useful to be able to
programmatically check the version of the ggml library being used.

Usage:
```c
printf("GGML version: %s\n", ggml_version());
```
Output:
```console
GGML version: 0.0.2219
```

* ggml : add ggml_commit()

---------

Co-authored-by: Georgi Gerganov <redacted>

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 215eb23486814e91d87a8e3e9dbb7cb6a092d431..675f3bf7567ff66bd29c4e1675db37f0e64b0be2 100644 (file)
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -360,6 +360,13 @@ write_basic_package_version_file(
     VERSION ${GGML_INSTALL_VERSION}
     COMPATIBILITY SameMajorVersion)
 
+target_compile_definitions(ggml-base PRIVATE
+    GGML_VERSION="${GGML_INSTALL_VERSION}"
+    GGML_COMMIT="${GGML_BUILD_COMMIT}"
+)
+message(STATUS "ggml version: ${GGML_INSTALL_VERSION}")
+message(STATUS "ggml commit:  ${GGML_BUILD_COMMIT}")
+
 install(FILES ${CMAKE_CURRENT_BINARY_DIR}/ggml-config.cmake
               ${CMAKE_CURRENT_BINARY_DIR}/ggml-version.cmake
         DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/ggml)

diff --git a/include/ggml.h b/include/ggml.h
index f8238f3159b9f5f32dc281efff63329262a7d634..abbfcc831b0fb940261fba2bdc67c107dcd5fd31 100644 (file)
--- a/include/ggml.h
+++ b/include/ggml.h
@@ -639,6 +639,9 @@ extern "C" {
 
     // misc
 
+    GGML_API const char * ggml_version(void);
+    GGML_API const char * ggml_commit(void);
+
     GGML_API void    ggml_time_init(void); // call this once at the beginning of the program
     GGML_API int64_t ggml_time_ms(void);
     GGML_API int64_t ggml_time_us(void);

diff --git a/src/ggml.c b/src/ggml.c
index c51cb57cc6821f9940f67dfabbc324c8d4ee0ac7..4d31b2f07229dbb1d4086c095e012ca85368f7d7 100644 (file)
--- a/src/ggml.c
+++ b/src/ggml.c
@@ -458,6 +458,14 @@ bool ggml_guid_matches(ggml_guid_t guid_a, ggml_guid_t guid_b) {
     return memcmp(guid_a, guid_b, sizeof(ggml_guid)) == 0;
 }
 
+const char * ggml_version(void) {
+    return GGML_VERSION;
+}
+
+const char * ggml_commit(void) {
+    return GGML_COMMIT;
+}
+
 //
 // timing
 //