Merge pull request #2008 from clumens/output-retval

Ken Gaillot · web-flow · commit b9fa064f522c · 2020-03-12T16:21:00.000-05:00
Convert formatted output to use new pacemaker return codes
diff --git a/include/crm/common/output.h b/include/crm/common/output.h
@@ -303,10 +303,10 @@ struct pcmk__output_s {
      *                           previous call to register_message.
      * \param[in] ...            Arguments to be passed to the registered function.
      *
-     * \return 0 if a function was registered for the message, that function was
-     *         called, and returned successfully.  A negative value is returned if
-     *         no function was registered.  A positive value is returned if the
-     *         function was called but encountered an error.
+     * \return A standard Pacemaker return code.  Generally: 0 if a function was
+     *         registered for the message, that function was called, and returned
+     *         successfully; EINVAL if no function was registered; or pcmk_rc_no_output
+     *         if a function was called but produced no output.
      */
     int (*message) (pcmk__output_t *out, const char *message_id, ...);
 
diff --git a/include/crm/common/results.h b/include/crm/common/results.h
@@ -107,6 +107,7 @@ enum pcmk_rc_e {
     /* When adding new values, use consecutively lower numbers, update the array
      * in lib/common/results.c, and test with crm_error.
      */
+    pcmk_rc_no_output           = -1026,
     pcmk_rc_after_range         = -1025,
     pcmk_rc_within_range        = -1024,
     pcmk_rc_before_range        = -1023,
diff --git a/include/crm/pengine/internal.h b/include/crm/pengine/internal.h
@@ -395,14 +395,14 @@ gboolean add_tag_ref(GHashTable * tags, const char * tag_name,  const char * obj
 
 void print_rscs_brief(GListPtr rsc_list, const char * pre_text, long options,
                       void * print_data, gboolean print_all);
-void pe__rscs_brief_output(pcmk__output_t *out, GListPtr rsc_list, long options, gboolean print_all);
+int pe__rscs_brief_output(pcmk__output_t *out, GListPtr rsc_list, long options, gboolean print_all);
 void pe_fence_node(pe_working_set_t * data_set, node_t * node, const char *reason);
 
 node_t *pe_create_node(const char *id, const char *uname, const char *type,
                        const char *score, pe_working_set_t * data_set);
 void common_print(resource_t * rsc, const char *pre_text, const char *name, node_t *node, long options, void *print_data);
-void pe__common_output_text(pcmk__output_t *out, resource_t * rsc, const char *name, node_t *node, long options);
-void pe__common_output_html(pcmk__output_t *out, resource_t * rsc, const char *name, node_t *node, long options);
+int pe__common_output_text(pcmk__output_t *out, resource_t * rsc, const char *name, node_t *node, long options);
+int pe__common_output_html(pcmk__output_t *out, resource_t * rsc, const char *name, node_t *node, long options);
 pe_resource_t *pe__find_bundle_replica(const pe_resource_t *bundle,
                                        const pe_node_t *node);
 bool pe__bundle_needs_remote_name(pe_resource_t *rsc);
diff --git a/lib/common/output.c b/lib/common/output.c
@@ -108,12 +108,12 @@ pcmk__register_formats(GOptionGroup *group, pcmk__supported_format_t *formats) {
 int
 pcmk__call_message(pcmk__output_t *out, const char *message_id, ...) {
     va_list args;
-    int rc = 0;
+    int rc = pcmk_rc_ok;
     pcmk__message_fn_t fn;
 
     fn = g_hash_table_lookup(out->messages, message_id);
     if (fn == NULL) {
-        return -EINVAL;
+        return EINVAL;
     }
 
     va_start(args, message_id);
diff --git a/lib/common/results.c b/lib/common/results.c
@@ -235,6 +235,10 @@ static struct pcmk__rc_info {
     { "pcmk_rc_after_range",
       "Result occurs after given range",
       -pcmk_err_generic,
+    },
+    { "pcmk_rc_no_output",
+      "Output message produced no output",
+      -pcmk_err_generic,
     }
 };
 
@@ -655,6 +659,7 @@ pcmk_rc2exitc(int rc)
             return CRM_EX_EXISTS;
 
         case EIO:
+        case pcmk_rc_no_output:
             return CRM_EX_IOERR;
 
         case ENOTSUP:
diff --git a/lib/fencing/st_output.c b/lib/fencing/st_output.c
@@ -36,9 +36,10 @@ last_fenced_html(pcmk__output_t *out, va_list args) {
         char *buf = crm_strdup_printf("Node %s last fenced at: %s", target, ctime(&when));
         pcmk__output_create_html_node(out, "div", NULL, NULL, buf);
         free(buf);
+        return pcmk_rc_ok;
+    } else {
+        return pcmk_rc_no_output;
     }
-
-    return 0;
 }
 
 static int
@@ -52,7 +53,7 @@ last_fenced_text(pcmk__output_t *out, va_list args) {
         pcmk__indented_printf(out, "Node %s has never been fenced\n", target);
     }
 
-    return 0;
+    return pcmk_rc_ok;
 }
 
 static int
@@ -68,9 +69,10 @@ last_fenced_xml(pcmk__output_t *out, va_list args) {
         xmlSetProp(node, (pcmkXmlStr) "when", (pcmkXmlStr) buf);
 
         free(buf);
+        return pcmk_rc_ok;
+    } else {
+        return pcmk_rc_no_output;
     }
-
-    return 0;
 }
 
 static int
@@ -117,7 +119,7 @@ stonith_event_html(pcmk__output_t *out, va_list args) {
             break;
     }
 
-    return 0;
+    return pcmk_rc_ok;
 }
 
 static int
@@ -154,7 +156,7 @@ stonith_event_text(pcmk__output_t *out, va_list args) {
     }
 
     free(buf);
-    return 0;
+    return pcmk_rc_ok;
 }
 
 static int
@@ -199,7 +201,7 @@ stonith_event_xml(pcmk__output_t *out, va_list args) {
         free(buf);
     }
 
-    return 0;
+    return pcmk_rc_ok;
 }
 
 static int
diff --git a/lib/pacemaker/pcmk_fence.c b/lib/pacemaker/pcmk_fence.c
@@ -286,8 +286,7 @@ pcmk__fence_last(pcmk__output_t *out, const char *target, bool as_nodeid) {
         when = stonith_api_time(0, target, FALSE);
     }
 
-    out->message(out, "last-fenced", target, when);
-    return pcmk_rc_ok;
+    return out->message(out, "last-fenced", target, when);
 }
 
 #ifdef BUILD_PUBLIC_LIBPACEMAKER
diff --git a/lib/pengine/bundle.c b/lib/pengine/bundle.c
@@ -1501,7 +1501,7 @@ pe__bundle_xml(pcmk__output_t *out, va_list args)
     unsigned int options = va_arg(args, unsigned int);
     pe_resource_t *rsc = va_arg(args, pe_resource_t *);
     pe__bundle_variant_data_t *bundle_data = NULL;
-    int rc = 0;
+    int rc = pcmk_rc_no_output;
 
     CRM_ASSERT(rsc != NULL);
 
@@ -1514,7 +1514,7 @@ pe__bundle_xml(pcmk__output_t *out, va_list args)
                  , "unique", BOOL2STR(is_set(rsc->flags, pe_rsc_unique))
                  , "managed", BOOL2STR(is_set(rsc->flags, pe_rsc_managed))
                  , "failed", BOOL2STR(is_set(rsc->flags, pe_rsc_failed)));
-    CRM_ASSERT(rc == 0);
+    CRM_ASSERT(rc == pcmk_rc_ok);
 
     for (GList *gIter = bundle_data->replicas; gIter != NULL;
          gIter = gIter->next) {
@@ -1525,7 +1525,7 @@ pe__bundle_xml(pcmk__output_t *out, va_list args)
 
         rc = pe__name_and_nvpairs_xml(out, true, "replica", 1, "id", id);
         free(id);
-        CRM_ASSERT(rc == 0);
+        CRM_ASSERT(rc == pcmk_rc_ok);
 
         if (replica->ip != NULL) {
             out->message(out, crm_map_element_name(replica->ip->xml), options, replica->ip);
@@ -1634,7 +1634,7 @@ pe__bundle_html(pcmk__output_t *out, va_list args)
     }
 
     out->end_list(out);
-    return 0;
+    return pcmk_rc_ok;
 }
 
 static void
@@ -1719,7 +1719,7 @@ pe__bundle_text(pcmk__output_t *out, va_list args)
     }
 
     out->end_list(out);
-    return 0;
+    return pcmk_rc_ok;
 }
 
 static void
diff --git a/lib/pengine/clone.c b/lib/pengine/clone.c
@@ -584,7 +584,7 @@ pe__clone_xml(pcmk__output_t *out, va_list args)
                  , "failed", BOOL2STR(is_set(rsc->flags, pe_rsc_failed))
                  , "failure_ignored", BOOL2STR(is_set(rsc->flags, pe_rsc_failure_ignored))
                  , "target_role", configured_role_str(rsc));
-    CRM_ASSERT(rc == 0);
+    CRM_ASSERT(rc == pcmk_rc_ok);
 
     for (; gIter != NULL; gIter = gIter->next) {
         pe_resource_t *child_rsc = (pe_resource_t *) gIter->data;
@@ -781,7 +781,7 @@ pe__clone_html(pcmk__output_t *out, va_list args)
 
     out->end_list(out);
 
-    return 0;
+    return pcmk_rc_ok;
 }
 
 int
@@ -968,8 +968,9 @@ pe__clone_text(pcmk__output_t *out, va_list args)
 
     out->end_list(out);
 
-    return 0;
+    return pcmk_rc_ok;
 }
+
 void
 clone_free(resource_t * rsc)
 {
diff --git a/lib/pengine/group.c b/lib/pengine/group.c
@@ -196,7 +196,7 @@ pe__group_xml(pcmk__output_t *out, va_list args)
                                       , "id", rsc->id
                                       , "number_resources", count);
     free(count);
-    CRM_ASSERT(rc == 0);
+    CRM_ASSERT(rc == pcmk_rc_ok);
 
     for (; gIter != NULL; gIter = gIter->next) {
         pe_resource_t *child_rsc = (pe_resource_t *) gIter->data;
@@ -228,7 +228,7 @@ pe__group_html(pcmk__output_t *out, va_list args)
 
     out->end_list(out);
 
-    return 0;
+    return pcmk_rc_ok;
 }
 
 int
@@ -251,7 +251,7 @@ pe__group_text(pcmk__output_t *out, va_list args)
     }
     out->end_list(out);
 
-    return 0;
+    return pcmk_rc_ok;
 }
 
 void
diff --git a/lib/pengine/native.c b/lib/pengine/native.c
@@ -665,7 +665,7 @@ native_output_string(pe_resource_t *rsc, const char *name, pe_node_t *node,
     return retval;
 }
 
-void
+int
 pe__common_output_html(pcmk__output_t *out, resource_t * rsc,
                        const char *name, node_t *node, long options)
 {
@@ -682,7 +682,7 @@ pe__common_output_html(pcmk__output_t *out, resource_t * rsc,
         const char *is_internal = g_hash_table_lookup(rsc->meta, XML_RSC_ATTR_INTERNAL_RSC);
         if (crm_is_true(is_internal) && is_not_set(options, pe_print_implicit)) {
             crm_trace("skipping print of internal resource %s", rsc->id);
-            return;
+            return pcmk_rc_no_output;
         }
         target_role = g_hash_table_lookup(rsc->meta, XML_RSC_ATTR_TARGET_ROLE);
     }
@@ -750,9 +750,11 @@ pe__common_output_html(pcmk__output_t *out, resource_t * rsc,
         }
         out->end_list(out);
     }
+
+    return pcmk_rc_ok;
 }
 
-void
+int
 pe__common_output_text(pcmk__output_t *out, resource_t * rsc,
                        const char *name, node_t *node, long options)
 {
@@ -764,7 +766,7 @@ pe__common_output_text(pcmk__output_t *out, resource_t * rsc,
         const char *is_internal = g_hash_table_lookup(rsc->meta, XML_RSC_ATTR_INTERNAL_RSC);
         if (crm_is_true(is_internal) && is_not_set(options, pe_print_implicit)) {
             crm_trace("skipping print of internal resource %s", rsc->id);
-            return;
+            return pcmk_rc_no_output;
         }
         target_role = g_hash_table_lookup(rsc->meta, XML_RSC_ATTR_TARGET_ROLE);
     }
@@ -812,6 +814,8 @@ pe__common_output_text(pcmk__output_t *out, resource_t * rsc,
         }
         out->end_list(out);
     }
+
+    return pcmk_rc_ok;
 }
 
 void
@@ -1003,7 +1007,7 @@ pe__resource_xml(pcmk__output_t *out, va_list args)
     char ra_name[LINE_MAX];
     char *nodes_running_on = NULL;
     char *priority = NULL;
-    int rc = 0;
+    int rc = pcmk_rc_no_output;
 
     CRM_ASSERT(rsc->variant == pe_native);
 
@@ -1034,7 +1038,7 @@ pe__resource_xml(pcmk__output_t *out, va_list args)
     free(priority);
     free(nodes_running_on);
 
-    CRM_ASSERT(rc == 0);
+    CRM_ASSERT(rc == pcmk_rc_ok);
 
     if (rsc->running_on != NULL) {
         GListPtr gIter = rsc->running_on;
@@ -1046,7 +1050,7 @@ pe__resource_xml(pcmk__output_t *out, va_list args)
                                           , "name", node->details->uname
                                           , "id", node->details->id
                                           , "cached", BOOL2STR(node->details->online));
-            CRM_ASSERT(rc == 0);
+            CRM_ASSERT(rc == pcmk_rc_ok);
         }
     }
 
@@ -1067,8 +1071,7 @@ pe__resource_html(pcmk__output_t *out, va_list args)
         // This is set only if a non-probe action is pending on this node
         node = rsc->pending_node;
     }
-    pe__common_output_html(out, rsc, rsc_printable_id(rsc), node, options);
-    return 0;
+    return pe__common_output_html(out, rsc, rsc_printable_id(rsc), node, options);
 }
 
 int
@@ -1085,8 +1088,7 @@ pe__resource_text(pcmk__output_t *out, va_list args)
         // This is set only if a non-probe action is pending on this node
         node = rsc->pending_node;
     }
-    pe__common_output_text(out, rsc, rsc_printable_id(rsc), node, options);
-    return 0;
+    return pe__common_output_text(out, rsc, rsc_printable_id(rsc), node, options);
 }
 
 void
@@ -1325,7 +1327,7 @@ print_rscs_brief(GListPtr rsc_list, const char *pre_text, long options,
     }
 }
 
-void
+int
 pe__rscs_brief_output(pcmk__output_t *out, GListPtr rsc_list, long options, gboolean print_all)
 {
     GHashTable *rsc_table = crm_str_table_new();
@@ -1334,6 +1336,7 @@ pe__rscs_brief_output(pcmk__output_t *out, GListPtr rsc_list, long options, gboo
     GHashTableIter hash_iter;
     char *type = NULL;
     int *rsc_counter = NULL;
+    int rc = pcmk_rc_no_output;
 
     get_rscs_brief(rsc_list, rsc_table, active_table);
 
@@ -1369,12 +1372,15 @@ pe__rscs_brief_output(pcmk__output_t *out, GListPtr rsc_list, long options, gboo
                                *active_counter, type,
                                (*active_counter > 0) && node_name ? node_name : "");
             }
+
+            rc = pcmk_rc_ok;
         }
 
         if (print_all && active_counter_all == 0) {
             out->list_item(out, NULL, " %d/%d\t(%s):\tActive",
                            active_counter_all,
                            rsc_counter ? *rsc_counter : 0, type);
+            rc = pcmk_rc_ok;
         }
     }
 
@@ -1386,4 +1392,6 @@ pe__rscs_brief_output(pcmk__output_t *out, GListPtr rsc_list, long options, gboo
         g_hash_table_destroy(active_table);
         active_table = NULL;
     }
+
+    return rc;
 }
diff --git a/lib/pengine/pe_output.c b/lib/pengine/pe_output.c
diff --git a/tools/crm_mon_curses.c b/tools/crm_mon_curses.c
diff --git a/tools/crm_mon_print.c b/tools/crm_mon_print.c

Original file line number	Diff line number	Diff line change
`@@ -36,9 +36,10 @@ last_fenced_html(pcmk__output_t *out, va_list args) {`
`36`	`36`	`char *buf = crm_strdup_printf("Node %s last fenced at: %s", target, ctime(&when));`
`37`	`37`	`pcmk__output_create_html_node(out, "div", NULL, NULL, buf);`
`38`	`38`	`free(buf);`
	`39`	`+ return pcmk_rc_ok;`
	`40`	`+ } else {`
	`41`	`+ return pcmk_rc_no_output;`
`39`	`42`	`}`
`40`		`-`
`41`		`- return 0;`
`42`	`43`	`}`
`43`	`44`
`44`	`45`	`static int`
`@@ -52,7 +53,7 @@ last_fenced_text(pcmk__output_t *out, va_list args) {`
`52`	`53`	`pcmk__indented_printf(out, "Node %s has never been fenced\n", target);`
`53`	`54`	`}`
`54`	`55`
`55`		`- return 0;`
	`56`	`+ return pcmk_rc_ok;`
`56`	`57`	`}`
`57`	`58`
`58`	`59`	`static int`
`@@ -68,9 +69,10 @@ last_fenced_xml(pcmk__output_t *out, va_list args) {`
`68`	`69`	`xmlSetProp(node, (pcmkXmlStr) "when", (pcmkXmlStr) buf);`
`69`	`70`
`70`	`71`	`free(buf);`
	`72`	`+ return pcmk_rc_ok;`
	`73`	`+ } else {`
	`74`	`+ return pcmk_rc_no_output;`
`71`	`75`	`}`
`72`		`-`
`73`		`- return 0;`
`74`	`76`	`}`
`75`	`77`
`76`	`78`	`static int`
`@@ -117,7 +119,7 @@ stonith_event_html(pcmk__output_t *out, va_list args) {`
`117`	`119`	`break;`
`118`	`120`	`}`
`119`	`121`
`120`		`- return 0;`
	`122`	`+ return pcmk_rc_ok;`
`121`	`123`	`}`
`122`	`124`
`123`	`125`	`static int`
`@@ -154,7 +156,7 @@ stonith_event_text(pcmk__output_t *out, va_list args) {`
`154`	`156`	`}`
`155`	`157`
`156`	`158`	`free(buf);`
`157`		`- return 0;`
	`159`	`+ return pcmk_rc_ok;`
`158`	`160`	`}`
`159`	`161`
`160`	`162`	`static int`
`@@ -199,7 +201,7 @@ stonith_event_xml(pcmk__output_t *out, va_list args) {`
`199`	`201`	`free(buf);`
`200`	`202`	`}`
`201`	`203`
`202`		`- return 0;`
	`204`	`+ return pcmk_rc_ok;`
`203`	`205`	`}`
`204`	`206`
`205`	`207`	`static int`
Original file line number	Diff line number	Diff line change
`@@ -286,8 +286,7 @@ pcmk__fence_last(pcmk__output_t out, const char target, bool as_nodeid) {`
`286`	`286`	`when = stonith_api_time(0, target, FALSE);`
`287`	`287`	`}`
`288`	`288`
`289`		`- out->message(out, "last-fenced", target, when);`
`290`		`- return pcmk_rc_ok;`
	`289`	`+ return out->message(out, "last-fenced", target, when);`
`291`	`290`	`}`
`292`	`291`
`293`	`292`	`#ifdef BUILD_PUBLIC_LIBPACEMAKER`
Original file line number	Diff line number	Diff line change
`@@ -196,7 +196,7 @@ pe__group_xml(pcmk__output_t *out, va_list args)`
`196`	`196`	`, "id", rsc->id`
`197`	`197`	`, "number_resources", count);`
`198`	`198`	`free(count);`
`199`		`- CRM_ASSERT(rc == 0);`
	`199`	`+ CRM_ASSERT(rc == pcmk_rc_ok);`
`200`	`200`
`201`	`201`	`for (; gIter != NULL; gIter = gIter->next) {`
`202`	`202`	`pe_resource_t child_rsc = (pe_resource_t ) gIter->data;`
`@@ -228,7 +228,7 @@ pe__group_html(pcmk__output_t *out, va_list args)`
`228`	`228`
`229`	`229`	`out->end_list(out);`
`230`	`230`
`231`		`- return 0;`
	`231`	`+ return pcmk_rc_ok;`
`232`	`232`	`}`
`233`	`233`
`234`	`234`	`int`
`@@ -251,7 +251,7 @@ pe__group_text(pcmk__output_t *out, va_list args)`
`251`	`251`	`}`
`252`	`252`	`out->end_list(out);`
`253`	`253`
`254`		`- return 0;`
	`254`	`+ return pcmk_rc_ok;`
`255`	`255`	`}`
`256`	`256`
`257`	`257`	`void`