API: libpacemaker: pcmk_free_injections() calls free instead of g_free

If you're creating or modifying the GList fields of a pcmk_injections_t
object manually, be sure to allocate the list elements using the
malloc() family of allocators. Previously, pcmk_free_injections()
assumed that the list elements had been allocated using the g_malloc()
family of allocators from GLib.

Signed-off-by: Reid Wahl <nrwahl@protonmail.com>

Author: nrwahl2

include/pacemaker.h

@@ -50,31 +50,33 @@ enum pcmk_sim_flags {
 /*!
  * \brief Synthetic cluster events that can be injected into the cluster
  *        for running simulations.
+ *
+ * \note This struct should typically be freed using \c pcmk_free_injections().
  */
 typedef struct {
-    /*! A list of node names (gchar *) to simulate bringing online */
+    /*! A list of node names (char *) to simulate bringing online */
     GList *node_up;
-    /*! A list of node names (gchar *) to simulate bringing offline */
+    /*! A list of node names (char *) to simulate bringing offline */
     GList *node_down;
-    /*! A list of node names (gchar *) to simulate failing */
+    /*! A list of node names (char *) to simulate failing */
     GList *node_fail;
-    /*! A list of operations (gchar *) to inject.  The format of these strings
+    /*! A list of operations (char *) to inject.  The format of these strings
      * is described in the "Operation Specification" section of crm_simulate
      * help output.
      */
     GList *op_inject;
-    /*! A list of operations (gchar *) that should return a given error code
+    /*! A list of operations (char *) that should return a given error code
      * if they fail.  The format of these strings is described in the
      * "Operation Specification" section of crm_simulate help output.
      */
     GList *op_fail;
-    /*! A list of tickets (gchar *) to simulate granting */
+    /*! A list of tickets (char *) to simulate granting */
     GList *ticket_grant;
-    /*! A list of tickets (gchar *) to simulate revoking */
+    /*! A list of tickets (char *) to simulate revoking */
     GList *ticket_revoke;
-    /*! A list of tickets (gchar *) to simulate putting on standby */
+    /*! A list of tickets (char *) to simulate putting on standby */
     GList *ticket_standby;
-    /*! A list of tickets (gchar *) to simulate activating */
+    /*! A list of tickets (char *) to simulate activating */
     GList *ticket_activate;
     /*! Does the cluster have an active watchdog device? */
     char *watchdog;

lib/pacemaker/pcmk_injections.c

@@ -685,7 +685,7 @@ pcmk__inject_scheduler_input(pcmk_scheduler_t *scheduler, cib_t *cib,
     }
 
     for (iter = injections->node_up; iter != NULL; iter = iter->next) {
-        const char *node = (const char *) iter->data;
+        const char *node = iter->data;
 
         out->message(out, "inject-modify-node", "Online", node);
 
@@ -698,7 +698,7 @@ pcmk__inject_scheduler_input(pcmk_scheduler_t *scheduler, cib_t *cib,
     }
 
     for (iter = injections->node_down; iter != NULL; iter = iter->next) {
-        const char *node = (const char *) iter->data;
+        const char *node = iter->data;
         char *xpath = NULL;
 
         out->message(out, "inject-modify-node", "Offline", node);
@@ -726,7 +726,7 @@ pcmk__inject_scheduler_input(pcmk_scheduler_t *scheduler, cib_t *cib,
     }
 
     for (iter = injections->node_fail; iter != NULL; iter = iter->next) {
-        const char *node = (const char *) iter->data;
+        const char *node = iter->data;
 
         out->message(out, "inject-modify-node", "Failing", node);
 
@@ -740,7 +740,7 @@ pcmk__inject_scheduler_input(pcmk_scheduler_t *scheduler, cib_t *cib,
     }
 
     for (iter = injections->ticket_grant; iter != NULL; iter = iter->next) {
-        const char *ticket_id = (const char *) iter->data;
+        const char *ticket_id = iter->data;
 
         out->message(out, "inject-modify-ticket", "Granting", ticket_id);
 
@@ -749,7 +749,7 @@ pcmk__inject_scheduler_input(pcmk_scheduler_t *scheduler, cib_t *cib,
     }
 
     for (iter = injections->ticket_revoke; iter != NULL; iter = iter->next) {
-        const char *ticket_id = (const char *) iter->data;
+        const char *ticket_id = iter->data;
 
         out->message(out, "inject-modify-ticket", "Revoking", ticket_id);
 
@@ -759,7 +759,7 @@ pcmk__inject_scheduler_input(pcmk_scheduler_t *scheduler, cib_t *cib,
     }
 
     for (iter = injections->ticket_standby; iter != NULL; iter = iter->next) {
-        const char *ticket_id = (const char *) iter->data;
+        const char *ticket_id = iter->data;
 
         out->message(out, "inject-modify-ticket", "Standby", ticket_id);
 
@@ -768,7 +768,7 @@ pcmk__inject_scheduler_input(pcmk_scheduler_t *scheduler, cib_t *cib,
     }
 
     for (iter = injections->ticket_activate; iter != NULL; iter = iter->next) {
-        const char *ticket_id = (const char *) iter->data;
+        const char *ticket_id = iter->data;
 
         out->message(out, "inject-modify-ticket", "Activating", ticket_id);
 
@@ -792,15 +792,15 @@ pcmk_free_injections(pcmk_injections_t *injections)
         return;
     }
 
-    g_list_free_full(injections->node_up, g_free);
-    g_list_free_full(injections->node_down, g_free);
-    g_list_free_full(injections->node_fail, g_free);
-    g_list_free_full(injections->op_fail, g_free);
-    g_list_free_full(injections->op_inject, g_free);
-    g_list_free_full(injections->ticket_grant, g_free);
-    g_list_free_full(injections->ticket_revoke, g_free);
-    g_list_free_full(injections->ticket_standby, g_free);
-    g_list_free_full(injections->ticket_activate, g_free);
+    g_list_free_full(injections->node_up, free);
+    g_list_free_full(injections->node_down, free);
+    g_list_free_full(injections->node_fail, free);
+    g_list_free_full(injections->op_fail, free);
+    g_list_free_full(injections->op_inject, free);
+    g_list_free_full(injections->ticket_grant, free);
+    g_list_free_full(injections->ticket_revoke, free);
+    g_list_free_full(injections->ticket_standby, free);
+    g_list_free_full(injections->ticket_activate, free);
     free(injections->quorum);
     free(injections->watchdog);
 

tools/crm_simulate.c

@@ -114,15 +114,17 @@ static gboolean
 node_down_cb(const char *option_name, const char *optarg, void *data,
              GError **error)
 {
-    options.injections->node_down = g_list_append(options.injections->node_down, g_strdup(optarg));
+    options.injections->node_down = g_list_append(options.injections->node_down,
+                                                  pcmk__str_copy(optarg));
     return TRUE;
 }
 
 static gboolean
 node_fail_cb(const char *option_name, const char *optarg, void *data,
              GError **error)
 {
-    options.injections->node_fail = g_list_append(options.injections->node_fail, g_strdup(optarg));
+    options.injections->node_fail = g_list_append(options.injections->node_fail,
+                                                  pcmk__str_copy(optarg));
     return TRUE;
 }
 
@@ -131,7 +133,8 @@ node_up_cb(const char *option_name, const char *optarg, void *data,
            GError **error)
 {
     pcmk__simulate_node_config = true;
-    options.injections->node_up = g_list_append(options.injections->node_up, g_strdup(optarg));
+    options.injections->node_up = g_list_append(options.injections->node_up,
+                                                pcmk__str_copy(optarg));
     return TRUE;
 }
 
@@ -140,15 +143,17 @@ op_fail_cb(const char *option_name, const char *optarg, void *data,
            GError **error)
 {
     options.flags |= pcmk_sim_process | pcmk_sim_simulate;
-    options.injections->op_fail = g_list_append(options.injections->op_fail, g_strdup(optarg));
+    options.injections->op_fail = g_list_append(options.injections->op_fail,
+                                                pcmk__str_copy(optarg));
     return TRUE;
 }
 
 static gboolean
 op_inject_cb(const char *option_name, const char *optarg, void *data,
              GError **error)
 {
-    options.injections->op_inject = g_list_append(options.injections->op_inject, g_strdup(optarg));
+    options.injections->op_inject = g_list_append(options.injections->op_inject,
+                                                  pcmk__str_copy(optarg));
     return TRUE;
 }
 
@@ -214,31 +219,38 @@ static gboolean
 ticket_activate_cb(const char *option_name, const char *optarg, void *data,
                    GError **error)
 {
-    options.injections->ticket_activate = g_list_append(options.injections->ticket_activate, g_strdup(optarg));
+    options.injections->ticket_activate =
+        g_list_append(options.injections->ticket_activate,
+                      pcmk__str_copy(optarg));
     return TRUE;
 }
 
 static gboolean
 ticket_grant_cb(const char *option_name, const char *optarg, void *data,
                 GError **error)
 {
-    options.injections->ticket_grant = g_list_append(options.injections->ticket_grant, g_strdup(optarg));
+    options.injections->ticket_grant =
+        g_list_append(options.injections->ticket_grant, pcmk__str_copy(optarg));
     return TRUE;
 }
 
 static gboolean
 ticket_revoke_cb(const char *option_name, const char *optarg, void *data,
                  GError **error)
 {
-    options.injections->ticket_revoke = g_list_append(options.injections->ticket_revoke, g_strdup(optarg));
+    options.injections->ticket_revoke =
+        g_list_append(options.injections->ticket_revoke,
+                      pcmk__str_copy(optarg));
     return TRUE;
 }
 
 static gboolean
 ticket_standby_cb(const char *option_name, const char *optarg, void *data,
                   GError **error)
 {
-    options.injections->ticket_standby = g_list_append(options.injections->ticket_standby, g_strdup(optarg));
+    options.injections->ticket_standby =
+        g_list_append(options.injections->ticket_standby,
+                      pcmk__str_copy(optarg));
     return TRUE;
 }