Refactor: libcrmcommon: New pcmk__generate_uuid()

Signed-off-by: Reid Wahl <[email protected]>

Author: nrwahl2

daemons/based/based_remote.c

@@ -391,7 +391,7 @@ cib_handle_remote_msg(pcmk__client_t *client, xmlNode *command)
     pcmk__xe_set(command, PCMK__XA_CIB_USER, client->user);
 
     if (pcmk__xe_get(command, PCMK__XA_CIB_CALLID) == NULL) {
-        char *call_uuid = crm_generate_uuid();
+        char *call_uuid = pcmk__generate_uuid();
 
         /* fix the command */
         pcmk__xe_set(command, PCMK__XA_CIB_CALLID, call_uuid);

daemons/controld/controld_schedulerd.c

@@ -91,7 +91,7 @@ handle_disconnect(void)
 
     if (pcmk__is_set(controld_globals.fsa_input_register, R_PE_REQUIRED)) {
         int rc = pcmk_ok;
-        char *uuid_str = crm_generate_uuid();
+        char *uuid_str = pcmk__generate_uuid();
 
         crm_crit("Lost connection to the scheduler "
                  QB_XS " CIB will be saved to " PCMK_SCHEDULER_INPUT_DIR "/pe-core-%s.bz2",

daemons/controld/controld_transition.c

@@ -63,7 +63,7 @@ do_te_control(long long action,
     }
 
     if (controld_globals.te_uuid == NULL) {
-        controld_globals.te_uuid = crm_generate_uuid();
+        controld_globals.te_uuid = pcmk__generate_uuid();
         crm_info("Registering TE UUID: %s", controld_globals.te_uuid);
     }
 

daemons/fenced/fenced_remote.c

@@ -1191,7 +1191,7 @@ create_remote_stonith_op(const char *client, xmlNode *request, gboolean peer)
     if (peer && dev) {
         op->id = pcmk__xe_get_copy(dev, PCMK__XA_ST_REMOTE_OP);
     } else {
-        op->id = crm_generate_uuid();
+        op->id = pcmk__generate_uuid();
     }
 
     g_hash_table_replace(stonith_remote_op_list, op->id, op);

include/crm/common/internal.h

@@ -247,6 +247,7 @@ pcmk__flag_text(uint64_t flag_group, uint64_t flags)
 // miscellaneous utilities (from utils.c)
 
 void pcmk__daemonize(const char *name, const char *pidfile);
+char *pcmk__generate_uuid(void);
 void pcmk__panic(const char *reason);
 pid_t pcmk__locate_sbd(void);
 void pcmk__sleep_ms(unsigned int ms);

lib/cib/cib_file.c

@@ -667,7 +667,7 @@ cib_file_new(const char *cib_location)
         return NULL;
     }
 
-    private->id = crm_generate_uuid();
+    private->id = pcmk__generate_uuid();
     private->filename = filename;
 
     cib->variant = cib_file;

lib/cluster/membership.c

@@ -985,7 +985,7 @@ pcmk__get_node(unsigned int id, const char *uname, const char *xml_id,
     }
 
     if (node == NULL) {
-        char *uniqueid = crm_generate_uuid();
+        char *uniqueid = pcmk__generate_uuid();
 
         node = pcmk__assert_alloc(1, sizeof(pcmk__node_status_t));
 
@@ -1465,7 +1465,7 @@ cluster_node_cib_cache_refresh_helper(xmlNode *xml_node, void *user_data)
     node = find_cib_cluster_node(id, uname);
 
     if (node == NULL) {
-        char *uniqueid = crm_generate_uuid();
+        char *uniqueid = pcmk__generate_uuid();
 
         node = pcmk__assert_alloc(1, sizeof(pcmk__node_status_t));
 

lib/common/ipc_server.c

@@ -180,7 +180,7 @@ client_from_connection(qb_ipcs_connection_t *c, void *key, uid_t uid_client)
         }
     }
 
-    client->id = crm_generate_uuid();
+    client->id = pcmk__generate_uuid();
     if (key == NULL) {
         key = client->id;
     }

lib/common/utils.c

@@ -327,22 +327,48 @@ pcmk__daemonize(const char *name, const char *pidfile)
     pcmk__open_devnull(O_WRONLY);   // stderr (fd 2)
 }
 
+/* @FIXME uuid.h is an optional header per configure.ac, and we include it
+ * conditionally above. But uuid_generate() and uuid_unparse() depend on it, on
+ * many or perhaps all systems with libuuid. So it's not clear how it would ever
+ * be optional in practice.
+ *
+ * Note that these functions are not POSIX, although there is probably no good
+ * portable alternative.
+ *
+ * We do list libuuid as a build dependency in INSTALL.md already.
+ */
+
 #ifdef HAVE_UUID_UUID_H
-#  include <uuid/uuid.h>
-#endif
+#include <uuid/uuid.h>
+#endif  // HAVE_UUID_UUID_H
 
+/*!
+ * \internal
+ * \brief Generate a 37-byte (36 bytes plus null terminator) UUID string
+ *
+ * \return Newly allocated UUID string
+ *
+ * \note The caller is responsible for freeing the return value using \c free().
+ */
 char *
-crm_generate_uuid(void)
+pcmk__generate_uuid(void)
 {
-    unsigned char uuid[16];
-    char *buffer = malloc(37);  /* Including NUL byte */
+    uuid_t uuid;
+
+    // uuid_unparse() converts a UUID to a 37-byte string (including null byte)
+    char *buffer = pcmk__assert_alloc(37, sizeof(char));
 
-    pcmk__mem_assert(buffer);
     uuid_generate(uuid);
     uuid_unparse(uuid, buffer);
     return buffer;
 }
 
+char *
+crm_generate_uuid(void)
+{
+    return pcmk__generate_uuid();
+}
+
 /*!
  * \internal
  * \brief Sleep for given milliseconds

lib/common/xml_io.c

@@ -619,7 +619,7 @@ pcmk__xml_write_temp_file(const xmlNode *xml, const char *desc,
     CRM_CHECK((xml != NULL) && (desc != NULL), return);
 
     if (filename == NULL) {
-        uuid = crm_generate_uuid();
+        uuid = pcmk__generate_uuid();
         filename = uuid;
     }
     path = pcmk__assert_asprintf("%s/%s", pcmk__get_tmpdir(), filename);
@@ -642,7 +642,7 @@ save_xml_to_file(const xmlNode *xml, const char *desc, const char *filename)
     char *f = NULL;
 
     if (filename == NULL) {
-        char *uuid = crm_generate_uuid();
+        char *uuid = pcmk__generate_uuid();
 
         f = pcmk__assert_asprintf("%s/%s", pcmk__get_tmpdir(), uuid);
         filename = f;