Rename API to variorum_get_utilization_json, tested on Lassen.

LLNL · Mar 8, 2024 · 872a229 · 872a229
1 parent 4454367
commit 872a229
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 8 deletions.
diff --git a/src/docs/sphinx/VariorumAPI.rst b/src/docs/sphinx/VariorumAPI.rst
@@ -126,7 +126,7 @@ is accomplished using the ``int variorum_get_gpu_utilization_json(char
 **get_gpu_util_obj_str)`` function. The total memory utilization is computed
 using ``/proc/meminfo``, and CPU utilizations is computed using ``/proc/stat``.
 
-The ``variorum_get_node_utilization_json(char **get_util_obj_str)`` function
+The ``variorum_get_utilization_json(char **get_util_obj_str)`` function
 returns a string type nested JSON object. An example is provided below:
 
 .. code::
@@ -150,7 +150,7 @@ returns a string type nested JSON object. An example is provided below:
 
 The ``*`` here refers to socket ID, and the ``#`` refers to GPU ID.
 
-The ``variorum_get_node_utilization_json(char **get_util_obj_str)`` function
+The ``variorum_get_utilization_json(char **get_util_obj_str)`` function
 returns a string type nested JSON object. An example is provided below:
 
 .. code::

diff --git a/src/docs/sphinx/api/json_support_functions.rst b/src/docs/sphinx/api/json_support_functions.rst
@@ -20,6 +20,6 @@ Defined in ``variorum/variorum.h``.
 
 .. doxygenfunction:: variorum_get_frequency_json
 
-.. doxygenfunction:: variorum_get_node_utilization_json
+.. doxygenfunction:: variorum_get_utilization_json
 
 .. doxygenfunction:: variorum_get_gpu_utilization_json
diff --git a/src/examples/CMakeLists.txt b/src/examples/CMakeLists.txt
@@ -21,7 +21,7 @@ set(BASIC_EXAMPLES
     variorum-get-node-power-domain-info-json-example
     variorum-get-power-json-example
     variorum-get-thermals-json-example
-    variorum-get-node-utilization-json-example
+    variorum-get-utilization-json-example
     variorum-get-topology-info-example
     variorum-integration-using-json-example
     variorum-monitoring-to-file-example

diff --git a/...iorum-get-node-utilization-json-example.c → ...s/variorum-get-utilization-json-example.c b/...iorum-get-node-utilization-json-example.c → ...s/variorum-get-utilization-json-example.c
@@ -52,7 +52,7 @@ int main(int argc, char **argv)
                 return -1;
         }
     }
-    ret = variorum_get_node_utilization_json(&s);
+    ret = variorum_get_utilization_json(&s);
     if (ret != 0)
     {
         printf("First run: JSON get node utilization failed!\n");
@@ -69,7 +69,7 @@ int main(int argc, char **argv)
         x += do_work(i);
     }
     printf("Final result: %f\n", x);
-    ret = variorum_get_node_utilization_json(&s);
+    ret = variorum_get_utilization_json(&s);
     if (ret != 0)
     {
         printf("Second run: JSON get node utilization failed!\n");

diff --git a/src/variorum/variorum.c b/src/variorum/variorum.c
@@ -1090,7 +1090,7 @@ int variorum_get_power_json(char **get_power_obj_str)
     return err;
 }
 
-int variorum_get_node_utilization_json(char **get_util_obj_str)
+int variorum_get_utilization_json(char **get_util_obj_str)
 {
     int err = 0;
     err = variorum_enter(__FILE__, __FUNCTION__, __LINE__);

diff --git a/src/variorum/variorum.h b/src/variorum/variorum.h
@@ -584,7 +584,7 @@ int variorum_get_power_json(char **get_power_obj_str);
 /// @returns 0 if successful, otherwise -1. Note that feature not implemented
 /// returns a -1 for the JSON APIs so that users don't have to explicitly
 /// check for NULL strings.
-int variorum_get_node_utilization_json(char **get_util_obj_str);
+int variorum_get_utilization_json(char **get_util_obj_str);
 
 /// @brief Populate a string in JSON format with utilization of each GPU
 ///