root/lib/pengine/group.c

/* */

DEFINITIONS

1. pe__last_group_member
2. pe__group_flag_is_set
3. set_group_flag
4. inactive_resources
5. group_header
6. skip_child_rsc
7. group_unpack
8. group_active
9. group_print_xml
10. group_print
11. PCMK__OUTPUT_ARGS
12. PCMK__OUTPUT_ARGS
13. group_free
14. group_resource_state
15. pe__group_is_filtered
16. pe__group_max_per_node

   1 /*
   2  * Copyright 2004-2023 the Pacemaker project contributors
   3  *
   4  * The version control history for this file may have further details.
   5  *
   6  * This source code is licensed under the GNU Lesser General Public License
   7  * version 2.1 or later (LGPLv2.1+) WITHOUT ANY WARRANTY.
   8  */
   9 
  10 #include <crm_internal.h>
  11 
  12 #include <stdint.h>
  13 
  14 #include <crm/pengine/rules.h>
  15 #include <crm/pengine/status.h>
  16 #include <crm/pengine/internal.h>
  17 #include <crm/msg_xml.h>
  18 #include <crm/common/output.h>
  19 #include <crm/common/strings_internal.h>
  20 #include <crm/common/xml_internal.h>
  21 #include <pe_status_private.h>
  22 
  23 typedef struct group_variant_data_s {
  24     pcmk_resource_t *last_child;    // Last group member
  25     uint32_t flags;                 // Group of enum pcmk__group_flags
  26 } group_variant_data_t;
  27 
  28 /*!
  29  * \internal
  30  * \brief Get a group's last member
  31  *
  32  * \param[in] group  Group resource to check
  33  *
  34  * \return Last member of \p group if any, otherwise NULL
  35  */
  36 pcmk_resource_t *
  37 pe__last_group_member(const pcmk_resource_t *group)
     /*  */
  38 {
  39     if (group != NULL) {
  40         CRM_CHECK((group->variant == pcmk_rsc_variant_group)
  41                   && (group->variant_opaque != NULL), return NULL);
  42         return ((group_variant_data_t *) group->variant_opaque)->last_child;
  43     }
  44     return NULL;
  45 }
  46 
  47 /*!
  48  * \internal
  49  * \brief Check whether a group flag is set
  50  *
  51  * \param[in] group  Group resource to check
  52  * \param[in] flags  Flag or flags to check
  53  *
  54  * \return true if all \p flags are set for \p group, otherwise false
  55  */
  56 bool
  57 pe__group_flag_is_set(const pcmk_resource_t *group, uint32_t flags)
     /*  */
  58 {
  59     group_variant_data_t *group_data = NULL;
  60 
  61     CRM_CHECK((group != NULL) && (group->variant == pcmk_rsc_variant_group)
  62               && (group->variant_opaque != NULL), return false);
  63     group_data = (group_variant_data_t *) group->variant_opaque;
  64     return pcmk_all_flags_set(group_data->flags, flags);
  65 }
  66 
  67 /*!
  68  * \internal
  69  * \brief Set a (deprecated) group flag
  70  *
  71  * \param[in,out] group   Group resource to check
  72  * \param[in]     option  Name of boolean configuration option
  73  * \param[in]     flag    Flag to set if \p option is true (which is default)
  74  * \param[in]     wo_bit  "Warn once" flag to use for deprecation warning
  75  */
  76 static void
  77 set_group_flag(pcmk_resource_t *group, const char *option, uint32_t flag,
     /*  */
  78                uint32_t wo_bit)
  79 {
  80     const char *value_s = NULL;
  81     int value = 0;
  82 
  83     value_s = g_hash_table_lookup(group->meta, option);
  84 
  85     // We don't actually need the null check but it speeds up the common case
  86     if ((value_s == NULL) || (crm_str_to_boolean(value_s, &value) < 0)
  87         || (value != 0)) {
  88 
  89         ((group_variant_data_t *) group->variant_opaque)->flags |= flag;
  90 
  91     } else {
  92         pe_warn_once(wo_bit,
  93                      "Support for the '%s' group meta-attribute is deprecated "
  94                      "and will be removed in a future release "
  95                      "(use a resource set instead)", option);
  96     }
  97 }
  98 
  99 static int
 100 inactive_resources(pcmk_resource_t *rsc)
     /*  */
 101 {
 102     int retval = 0;
 103 
 104     for (GList *gIter = rsc->children; gIter != NULL; gIter = gIter->next) {
 105         pcmk_resource_t *child_rsc = (pcmk_resource_t *) gIter->data;
 106 
 107         if (!child_rsc->fns->active(child_rsc, TRUE)) {
 108             retval++;
 109         }
 110     }
 111 
 112     return retval;
 113 }
 114 
 115 static void
 116 group_header(pcmk__output_t *out, int *rc, const pcmk_resource_t *rsc,
     /*  */
 117              int n_inactive, bool show_inactive, const char *desc)
 118 {
 119     GString *attrs = NULL;
 120 
 121     if (n_inactive > 0 && !show_inactive) {
 122         attrs = g_string_sized_new(64);
 123         g_string_append_printf(attrs, "%d member%s inactive", n_inactive,
 124                                pcmk__plural_s(n_inactive));
 125     }
 126 
 127     if (pe__resource_is_disabled(rsc)) {
 128         pcmk__add_separated_word(&attrs, 64, "disabled", ", ");
 129     }
 130 
 131     if (pcmk_is_set(rsc->flags, pcmk_rsc_maintenance)) {
 132         pcmk__add_separated_word(&attrs, 64, "maintenance", ", ");
 133 
 134     } else if (!pcmk_is_set(rsc->flags, pcmk_rsc_managed)) {
 135         pcmk__add_separated_word(&attrs, 64, "unmanaged", ", ");
 136     }
 137 
 138     if (attrs != NULL) {
 139         PCMK__OUTPUT_LIST_HEADER(out, FALSE, *rc, "Resource Group: %s (%s)%s%s%s",
 140                                  rsc->id,
 141                                  (const char *) attrs->str, desc ? " (" : "",
 142                                  desc ? desc : "", desc ? ")" : "");
 143         g_string_free(attrs, TRUE);
 144     } else {
 145         PCMK__OUTPUT_LIST_HEADER(out, FALSE, *rc, "Resource Group: %s%s%s%s",
 146                                  rsc->id,
 147                                  desc ? " (" : "", desc ? desc : "",
 148                                  desc ? ")" : "");
 149     }
 150 }
 151 
 152 static bool
 153 skip_child_rsc(pcmk_resource_t *rsc, pcmk_resource_t *child,
     /*  */
 154                gboolean parent_passes, GList *only_rsc, uint32_t show_opts)
 155 {
 156     bool star_list = pcmk__list_of_1(only_rsc) &&
 157                      pcmk__str_eq("*", g_list_first(only_rsc)->data, pcmk__str_none);
 158     bool child_filtered = child->fns->is_filtered(child, only_rsc, FALSE);
 159     bool child_active = child->fns->active(child, FALSE);
 160     bool show_inactive = pcmk_is_set(show_opts, pcmk_show_inactive_rscs);
 161 
 162     /* If the resource is in only_rsc by name (so, ignoring "*") then allow
 163      * it regardless of if it's active or not.
 164      */
 165     if (!star_list && !child_filtered) {
 166         return false;
 167 
 168     } else if (!child_filtered && (child_active || show_inactive)) {
 169         return false;
 170 
 171     } else if (parent_passes && (child_active || show_inactive)) {
 172         return false;
 173 
 174     }
 175 
 176     return true;
 177 }
 178 
 179 gboolean
 180 group_unpack(pcmk_resource_t *rsc, pcmk_scheduler_t *scheduler)
     /*  */
 181 {
 182     xmlNode *xml_obj = rsc->xml;
 183     xmlNode *xml_native_rsc = NULL;
 184     group_variant_data_t *group_data = NULL;
 185     const char *clone_id = NULL;
 186 
 187     pe_rsc_trace(rsc, "Processing resource %s...", rsc->id);
 188 
 189     group_data = calloc(1, sizeof(group_variant_data_t));
 190     group_data->last_child = NULL;
 191     rsc->variant_opaque = group_data;
 192 
 193     // @COMPAT These are deprecated since 2.1.5
 194     set_group_flag(rsc, XML_RSC_ATTR_ORDERED, pcmk__group_ordered,
 195                    pcmk__wo_group_order);
 196     set_group_flag(rsc, "collocated", pcmk__group_colocated,
 197                    pcmk__wo_group_coloc);
 198 
 199     clone_id = crm_element_value(rsc->xml, XML_RSC_ATTR_INCARNATION);
 200 
 201     for (xml_native_rsc = pcmk__xe_first_child(xml_obj); xml_native_rsc != NULL;
 202          xml_native_rsc = pcmk__xe_next(xml_native_rsc)) {
 203 
 204         if (pcmk__str_eq((const char *)xml_native_rsc->name,
 205                          XML_CIB_TAG_RESOURCE, pcmk__str_none)) {
 206             pcmk_resource_t *new_rsc = NULL;
 207 
 208             crm_xml_add(xml_native_rsc, XML_RSC_ATTR_INCARNATION, clone_id);
 209             if (pe__unpack_resource(xml_native_rsc, &new_rsc, rsc,
 210                                     scheduler) != pcmk_rc_ok) {
 211                 continue;
 212             }
 213 
 214             rsc->children = g_list_append(rsc->children, new_rsc);
 215             group_data->last_child = new_rsc;
 216             pe_rsc_trace(rsc, "Added %s member %s", rsc->id, new_rsc->id);
 217         }
 218     }
 219 
 220     if (rsc->children == NULL) {
 221         /* The schema does not allow empty groups, but if validation is
 222          * disabled, we allow them (members can be added later).
 223          *
 224          * @COMPAT At a major release bump, we should consider this a failure so
 225          *         that group methods can assume children is not NULL, and there
 226          *         are no strange effects from phantom groups due to their
 227          *         presence or meta-attributes.
 228          */
 229         pcmk__config_warn("Group %s will be ignored because it does not have "
 230                           "any members", rsc->id);
 231     }
 232     return TRUE;
 233 }
 234 
 235 gboolean
 236 group_active(pcmk_resource_t *rsc, gboolean all)
     /*  */
 237 {
 238     gboolean c_all = TRUE;
 239     gboolean c_any = FALSE;
 240     GList *gIter = rsc->children;
 241 
 242     for (; gIter != NULL; gIter = gIter->next) {
 243         pcmk_resource_t *child_rsc = (pcmk_resource_t *) gIter->data;
 244 
 245         if (child_rsc->fns->active(child_rsc, all)) {
 246             c_any = TRUE;
 247         } else {
 248             c_all = FALSE;
 249         }
 250     }
 251 
 252     if (c_any == FALSE) {
 253         return FALSE;
 254     } else if (all && c_all == FALSE) {
 255         return FALSE;
 256     }
 257     return TRUE;
 258 }
 259 
 260 /*!
 261  * \internal
 262  * \deprecated This function will be removed in a future release
 263  */
 264 static void
 265 group_print_xml(pcmk_resource_t *rsc, const char *pre_text, long options,
     /*  */
 266                 void *print_data)
 267 {
 268     GList *gIter = rsc->children;
 269     char *child_text = crm_strdup_printf("%s     ", pre_text);
 270 
 271     status_print("%s<group " XML_ATTR_ID "=\"%s\" ", pre_text, rsc->id);
 272     status_print("number_resources=\"%d\" ", g_list_length(rsc->children));
 273     status_print(">\n");
 274 
 275     for (; gIter != NULL; gIter = gIter->next) {
 276         pcmk_resource_t *child_rsc = (pcmk_resource_t *) gIter->data;
 277 
 278         child_rsc->fns->print(child_rsc, child_text, options, print_data);
 279     }
 280 
 281     status_print("%s</group>\n", pre_text);
 282     free(child_text);
 283 }
 284 
 285 /*!
 286  * \internal
 287  * \deprecated This function will be removed in a future release
 288  */
 289 void
 290 group_print(pcmk_resource_t *rsc, const char *pre_text, long options,
     /*  */
 291             void *print_data)
 292 {
 293     char *child_text = NULL;
 294     GList *gIter = rsc->children;
 295 
 296     if (pre_text == NULL) {
 297         pre_text = " ";
 298     }
 299 
 300     if (options & pe_print_xml) {
 301         group_print_xml(rsc, pre_text, options, print_data);
 302         return;
 303     }
 304 
 305     child_text = crm_strdup_printf("%s    ", pre_text);
 306 
 307     status_print("%sResource Group: %s", pre_text ? pre_text : "", rsc->id);
 308 
 309     if (options & pe_print_html) {
 310         status_print("\n<ul>\n");
 311 
 312     } else if ((options & pe_print_log) == 0) {
 313         status_print("\n");
 314     }
 315 
 316     if (options & pe_print_brief) {
 317         print_rscs_brief(rsc->children, child_text, options, print_data, TRUE);
 318 
 319     } else {
 320         for (; gIter != NULL; gIter = gIter->next) {
 321             pcmk_resource_t *child_rsc = (pcmk_resource_t *) gIter->data;
 322 
 323             if (options & pe_print_html) {
 324                 status_print("<li>\n");
 325             }
 326             child_rsc->fns->print(child_rsc, child_text, options, print_data);
 327             if (options & pe_print_html) {
 328                 status_print("</li>\n");
 329             }
 330         }
 331     }
 332 
 333     if (options & pe_print_html) {
 334         status_print("</ul>\n");
 335     }
 336     free(child_text);
 337 }
 338 
 339 PCMK__OUTPUT_ARGS("group", "uint32_t", "pcmk_resource_t *", "GList *",
     /*  */
 340                   "GList *")
 341 int
 342 pe__group_xml(pcmk__output_t *out, va_list args)
 343 {
 344     uint32_t show_opts = va_arg(args, uint32_t);
 345     pcmk_resource_t *rsc = va_arg(args, pcmk_resource_t *);
 346     GList *only_node = va_arg(args, GList *);
 347     GList *only_rsc = va_arg(args, GList *);
 348     
 349     const char *desc = NULL;
 350     GList *gIter = rsc->children;
 351 
 352     int rc = pcmk_rc_no_output;
 353 
 354     gboolean parent_passes = pcmk__str_in_list(rsc_printable_id(rsc), only_rsc, pcmk__str_star_matches) ||
 355                              (strstr(rsc->id, ":") != NULL && pcmk__str_in_list(rsc->id, only_rsc, pcmk__str_star_matches));
 356 
 357     desc = pe__resource_description(rsc, show_opts);
 358 
 359     if (rsc->fns->is_filtered(rsc, only_rsc, TRUE)) {
 360         return rc;
 361     }
 362 
 363     for (; gIter != NULL; gIter = gIter->next) {
 364         pcmk_resource_t *child_rsc = (pcmk_resource_t *) gIter->data;
 365 
 366         if (skip_child_rsc(rsc, child_rsc, parent_passes, only_rsc, show_opts)) {
 367             continue;
 368         }
 369 
 370         if (rc == pcmk_rc_no_output) {
 371             char *count = pcmk__itoa(g_list_length(gIter));
 372             const char *maint_s = pe__rsc_bool_str(rsc, pcmk_rsc_maintenance);
 373             const char *managed_s = pe__rsc_bool_str(rsc, pcmk_rsc_managed);
 374             const char *disabled_s = pcmk__btoa(pe__resource_is_disabled(rsc));
 375 
 376             rc = pe__name_and_nvpairs_xml(out, true, "group", 5,
 377                                           XML_ATTR_ID, rsc->id,
 378                                           "number_resources", count,
 379                                           "maintenance", maint_s,
 380                                           "managed", managed_s,
 381                                           "disabled", disabled_s,
 382                                           "description", desc);
 383             free(count);
 384             CRM_ASSERT(rc == pcmk_rc_ok);
 385         }
 386 
 387         out->message(out, crm_map_element_name(child_rsc->xml), show_opts, child_rsc,
 388                      only_node, only_rsc);
 389     }
 390 
 391     if (rc == pcmk_rc_ok) {
 392         pcmk__output_xml_pop_parent(out);
 393     }
 394 
 395     return rc;
 396 }
 397 
 398 PCMK__OUTPUT_ARGS("group", "uint32_t", "pcmk_resource_t *", "GList *",
     /*  */
 399                   "GList *")
 400 int
 401 pe__group_default(pcmk__output_t *out, va_list args)
 402 {
 403     uint32_t show_opts = va_arg(args, uint32_t);
 404     pcmk_resource_t *rsc = va_arg(args, pcmk_resource_t *);
 405     GList *only_node = va_arg(args, GList *);
 406     GList *only_rsc = va_arg(args, GList *);
 407 
 408     const char *desc = NULL;
 409     int rc = pcmk_rc_no_output;
 410 
 411     gboolean parent_passes = pcmk__str_in_list(rsc_printable_id(rsc), only_rsc, pcmk__str_star_matches) ||
 412                              (strstr(rsc->id, ":") != NULL && pcmk__str_in_list(rsc->id, only_rsc, pcmk__str_star_matches));
 413 
 414     gboolean active = rsc->fns->active(rsc, TRUE);
 415     gboolean partially_active = rsc->fns->active(rsc, FALSE);
 416 
 417     desc = pe__resource_description(rsc, show_opts);
 418 
 419     if (rsc->fns->is_filtered(rsc, only_rsc, TRUE)) {
 420         return rc;
 421     }
 422 
 423     if (pcmk_is_set(show_opts, pcmk_show_brief)) {
 424         GList *rscs = pe__filter_rsc_list(rsc->children, only_rsc);
 425 
 426         if (rscs != NULL) {
 427             group_header(out, &rc, rsc, !active && partially_active ? inactive_resources(rsc) : 0,
 428                          pcmk_is_set(show_opts, pcmk_show_inactive_rscs), desc);
 429             pe__rscs_brief_output(out, rscs, show_opts | pcmk_show_inactive_rscs);
 430 
 431             rc = pcmk_rc_ok;
 432             g_list_free(rscs);
 433         }
 434 
 435     } else {
 436         for (GList *gIter = rsc->children; gIter; gIter = gIter->next) {
 437             pcmk_resource_t *child_rsc = (pcmk_resource_t *) gIter->data;
 438 
 439             if (skip_child_rsc(rsc, child_rsc, parent_passes, only_rsc, show_opts)) {
 440                 continue;
 441             }
 442 
 443             group_header(out, &rc, rsc, !active && partially_active ? inactive_resources(rsc) : 0,
 444                          pcmk_is_set(show_opts, pcmk_show_inactive_rscs), desc);
 445             out->message(out, crm_map_element_name(child_rsc->xml), show_opts,
 446                          child_rsc, only_node, only_rsc);
 447         }
 448     }
 449 
 450         PCMK__OUTPUT_LIST_FOOTER(out, rc);
 451 
 452     return rc;
 453 }
 454 
 455 void
 456 group_free(pcmk_resource_t * rsc)
     /*  */
 457 {
 458     CRM_CHECK(rsc != NULL, return);
 459 
 460     pe_rsc_trace(rsc, "Freeing %s", rsc->id);
 461 
 462     for (GList *gIter = rsc->children; gIter != NULL; gIter = gIter->next) {
 463         pcmk_resource_t *child_rsc = (pcmk_resource_t *) gIter->data;
 464 
 465         CRM_ASSERT(child_rsc);
 466         pe_rsc_trace(child_rsc, "Freeing child %s", child_rsc->id);
 467         child_rsc->fns->free(child_rsc);
 468     }
 469 
 470     pe_rsc_trace(rsc, "Freeing child list");
 471     g_list_free(rsc->children);
 472 
 473     common_free(rsc);
 474 }
 475 
 476 enum rsc_role_e
 477 group_resource_state(const pcmk_resource_t * rsc, gboolean current)
     /*  */
 478 {
 479     enum rsc_role_e group_role = pcmk_role_unknown;
 480     GList *gIter = rsc->children;
 481 
 482     for (; gIter != NULL; gIter = gIter->next) {
 483         pcmk_resource_t *child_rsc = (pcmk_resource_t *) gIter->data;
 484         enum rsc_role_e role = child_rsc->fns->state(child_rsc, current);
 485 
 486         if (role > group_role) {
 487             group_role = role;
 488         }
 489     }
 490 
 491     pe_rsc_trace(rsc, "%s role: %s", rsc->id, role2text(group_role));
 492     return group_role;
 493 }
 494 
 495 gboolean
 496 pe__group_is_filtered(const pcmk_resource_t *rsc, GList *only_rsc,
     /*  */
 497                       gboolean check_parent)
 498 {
 499     gboolean passes = FALSE;
 500 
 501     if (check_parent
 502         && pcmk__str_in_list(rsc_printable_id(pe__const_top_resource(rsc,
 503                                                                      false)),
 504                              only_rsc, pcmk__str_star_matches)) {
 505         passes = TRUE;
 506     } else if (pcmk__str_in_list(rsc_printable_id(rsc), only_rsc, pcmk__str_star_matches)) {
 507         passes = TRUE;
 508     } else if (strstr(rsc->id, ":") != NULL && pcmk__str_in_list(rsc->id, only_rsc, pcmk__str_star_matches)) {
 509         passes = TRUE;
 510     } else {
 511         for (const GList *iter = rsc->children;
 512              iter != NULL; iter = iter->next) {
 513 
 514             const pcmk_resource_t *child_rsc = iter->data;
 515 
 516             if (!child_rsc->fns->is_filtered(child_rsc, only_rsc, FALSE)) {
 517                 passes = TRUE;
 518                 break;
 519             }
 520         }
 521     }
 522 
 523     return !passes;
 524 }
 525 
 526 /*!
 527  * \internal
 528  * \brief Get maximum group resource instances per node
 529  *
 530  * \param[in] rsc  Group resource to check
 531  *
 532  * \return Maximum number of \p rsc instances that can be active on one node
 533  */
 534 unsigned int
 535 pe__group_max_per_node(const pcmk_resource_t *rsc)
     /*  */
 536 {
 537     CRM_ASSERT((rsc != NULL) && (rsc->variant == pcmk_rsc_variant_group));
 538     return 1U;
 539 }

/* */