[FEATURE] Hardcode build-time branch and commit hash into the library (#20755)

* Embed commit hash and branch into library

* set git branch and commit from CMake

* Hook up new functions to python

* Remove old system

* Use GIT_EXECUTABLE

* Fix script formatting

* Linter fixes

* Move python functions

* Switch between old and new system in diagnose.py

* Update exception types

Co-authored-by: Sheng Zha <szha@users.noreply.github.com>

Author: matteosal

CMakeLists.txt

@@ -102,6 +102,32 @@ message(STATUS "CMAKE_SYSTEM_PROCESSOR ${CMAKE_SYSTEM_PROCESSOR}")
 
 message(STATUS "CMAKE_SYSTEM_NAME ${CMAKE_SYSTEM_NAME}")
 
+find_package(Git QUIET)
+if(${GIT_FOUND})
+  execute_process(COMMAND ${GIT_EXECUTABLE} rev-parse --abbrev-ref HEAD 
+    WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
+    OUTPUT_VARIABLE GIT_BRANCH
+    RESULT_VARIABLE BRANCH_FAILED
+  )
+  execute_process(COMMAND ${GIT_EXECUTABLE} rev-parse HEAD
+    WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
+    OUTPUT_VARIABLE GIT_COMMIT
+    RESULT_VARIABLE COMMIT_FAILED
+  )
+  if(NOT BRANCH_FAILED)
+    string(REGEX REPLACE "\n$" "" GIT_BRANCH "${GIT_BRANCH}")
+    add_compile_definitions(MXNET_BRANCH="${GIT_BRANCH}")
+  else()
+    add_compile_definitions(MXNET_BRANCH="Unavailable")
+  endif()
+  if(NOT COMMIT_FAILED)
+    string(REGEX REPLACE "\n$" "" GIT_COMMIT "${GIT_COMMIT}")
+    add_compile_definitions(MXNET_COMMIT_HASH="${GIT_COMMIT}")
+  else()
+    add_compile_definitions(MXNET_COMMIT_HASH="Unavailable")
+  endif()
+endif()
+
 if(USE_TVM_OP)
   add_definitions(-DMXNET_USE_TVM_OP=1)
 endif()

include/mxnet/c_api.h

@@ -53,6 +53,14 @@ extern "C" {
 #define MXNET_DLL
 #endif
 
+#ifndef MXNET_BRANCH
+#define MXNET_BRANCH "NotProvided"
+#endif
+
+#ifndef MXNET_COMMIT_HASH
+#define MXNET_COMMIT_HASH "NotProvided"
+#endif
+
 /*! \brief manually define unsigned int */
 typedef uint32_t mx_uint;
 /*! \brief manually define float */
@@ -542,6 +550,20 @@ MXNET_DLL int MXGetGPUMemoryInformation64(int dev, uint64_t* free_mem, uint64_t*
  */
 MXNET_DLL int MXGetVersion(int* out);
 
+/*!
+ * \brief get the MXNet library branch at build time, usually provided by cmake
+ * \param pointer to the string holding the branch name
+ * \return 0 when success, -1 when failure happens
+ */
+MXNET_DLL int MXGetBranch(const char** out);
+
+/*!
+ * \brief get the MXNet library commit hash at build time, usually provided by cmake
+ * \param pointer to the string holding the commit hash
+ * \return 0 when success, -1 when failure happens
+ */
+MXNET_DLL int MXGetCommitHash(const char** out);
+
 /*!
  * \brief Load TVM operator from the binary library
  * \param libpath TVM operators lib file

python/mxnet/runtime.py

@@ -116,3 +116,13 @@ def is_enabled(self, feature_name):
             raise RuntimeError("Feature '{}' is unknown, known features are: {}".format(
                 feature_name, list(self.keys())))
         return self[feature_name].enabled
+
+def get_branch():
+    out = ctypes.c_char_p()
+    check_call(_LIB.MXGetBranch(ctypes.byref(out)))
+    return out.value.decode('utf-8')
+
+def get_commit_hash():
+    out = ctypes.c_char_p()
+    check_call(_LIB.MXGetCommitHash(ctypes.byref(out)))
+    return out.value.decode('utf-8')

src/c_api/c_api.cc

@@ -1959,6 +1959,18 @@ int MXGetVersion(int* out) {
   API_END();
 }
 
+int MXGetBranch(const char** out) {
+  API_BEGIN();
+  *out = MXNET_BRANCH;
+  API_END();
+}
+
+int MXGetCommitHash(const char** out) {
+  API_BEGIN();
+  *out = MXNET_COMMIT_HASH;
+  API_END();
+}
+
 #if MXNET_USE_TVM_OP
 int MXLoadTVMOp(const char* libpath) {
   API_BEGIN();

tools/diagnose.py

@@ -96,18 +96,24 @@ def check_mxnet():
         print('Version      :', mxnet.__version__)
         mx_dir = os.path.dirname(mxnet.__file__)
         print('Directory    :', mx_dir)
-        commit_hash = os.path.join(mx_dir, 'COMMIT_HASH')
-        if os.path.exists(commit_hash):
-            with open(commit_hash, 'r') as f:
-                ch = f.read().strip()
-                print('Commit Hash   :', ch)
-        else:
-            print('Commit hash file "{}" not found. Not installed from pre-built package or built from source.'.format(commit_hash))
+        try:
+            branch = mxnet.runtime.get_branch()
+            commit_hash = mxnet.runtime.get_commit_hash()
+            print('Branch       :', branch)
+            print('Commit Hash  :', commit_hash)
+        except AttributeError:
+            commit_hash = os.path.join(mx_dir, 'COMMIT_HASH')
+            if os.path.exists(commit_hash):
+                with open(commit_hash, 'r') as f:
+                    ch = f.read().strip()
+                    print('Commit Hash   :', ch)
+            else:
+                print('Commit hash file "{}" not found. Not installed from pre-built package or built from source.'.format(commit_hash))
         print('Library      :', mxnet.libinfo.find_lib_path())
         try:
             print('Build features:')
             print(get_build_features_str())
-        except Exception:
+        except (AttributeError, ModuleNotFoundError):
             print('No runtime build feature info available')
     except ImportError:
         print('No MXNet installed.')

tools/pip/MANIFEST.in

@@ -19,7 +19,6 @@ include README
 include LICENSE
 include DISCLAIMER
 include NOTICE
-include mxnet/COMMIT_HASH
 recursive-include mxnet/tools *
 recursive-include mxnet *.py
 recursive-include mxnet *.so

tools/staticbuild/build_wheel.sh

@@ -18,7 +18,6 @@
 # under the License.
 
 # This script builds the wheel for binary distribution and performs sanity check.
-echo $(git rev-parse HEAD) >> python/mxnet/COMMIT_HASH
 cd python/
 
 # Make wheel for testing