scores.c

Go to the documentation of this file.

/*
 * Copyright 2004-2024 the Pacemaker project contributors
 *
 * The version control history for this file may have further details.
 *
 * This source code is licensed under the GNU Lesser General Public License
 * version 2.1 or later (LGPLv2.1+) WITHOUT ANY WARRANTY.
 */

#include <crm_internal.h>

#ifndef _GNU_SOURCE
#  define _GNU_SOURCE
#endif

#include <stdio.h>      // snprintf(), NULL
#include <string.h>     // strcpy(), strdup()
#include <ctype.h>      // isspace()
#include <sys/types.h>  // size_t

int pcmk__score_red = 0;
int pcmk__score_green = 0;
int pcmk__score_yellow = 0;

int
pcmk_parse_score(const char *score_s, int *score, int default_score)
{
    int rc = pcmk_rc_ok;
    int local_score = 0;

    // Ensure default score is in bounds
    default_score = QB_MIN(default_score, PCMK_SCORE_INFINITY);
    default_score = QB_MAX(default_score, -PCMK_SCORE_INFINITY);
    local_score = default_score;

    if (score_s == NULL) {

    } else if (pcmk_str_is_minus_infinity(score_s)) {
        local_score = -PCMK_SCORE_INFINITY;

    } else if (pcmk_str_is_infinity(score_s)) {
        local_score = PCMK_SCORE_INFINITY;

    } else if (pcmk__str_eq(score_s, PCMK_VALUE_RED, pcmk__str_casei)) {
        local_score = pcmk__score_red;

    } else if (pcmk__str_eq(score_s, PCMK_VALUE_YELLOW, pcmk__str_casei)) {
        local_score = pcmk__score_yellow;

    } else if (pcmk__str_eq(score_s, PCMK_VALUE_GREEN, pcmk__str_casei)) {
        local_score = pcmk__score_green;

    } else {
        long long score_ll = 0LL;

        rc = pcmk__scan_ll(score_s, &score_ll, default_score);
        if ((rc == EOVERFLOW) || (rc == ERANGE)) {
            const char *c = score_s;

            while (isspace(*c)) {
                ++c;
            }
            rc = pcmk_rc_ok;
            if (*c == '-') {
                score_ll = -PCMK_SCORE_INFINITY;
            } else {
                score_ll = PCMK_SCORE_INFINITY;
            }
        }
        if (rc != pcmk_rc_ok) {
            local_score = default_score;

        } else if (score_ll > PCMK_SCORE_INFINITY) {
            local_score = PCMK_SCORE_INFINITY;

        } else if (score_ll < -PCMK_SCORE_INFINITY) {
            local_score = -PCMK_SCORE_INFINITY;

        } else {
            local_score = (int) score_ll;
        }
    }

    if (score != NULL) {
        *score = local_score;
    }
    return rc;
}

int
char2score(const char *score)
{
    int result = 0;

    (void) pcmk_parse_score(score, &result, 0);
    return result;
}

const char *
pcmk_readable_score(int score)
{
    // The longest possible result is "-INFINITY"
    static char score_s[sizeof(PCMK_VALUE_MINUS_INFINITY)];

    if (score >= PCMK_SCORE_INFINITY) {
        strcpy(score_s, PCMK_VALUE_INFINITY);

    } else if (score <= -PCMK_SCORE_INFINITY) {
        strcpy(score_s, PCMK_VALUE_MINUS_INFINITY);

    } else {
        // Range is limited to +/-1000000, so no chance of overflow
        snprintf(score_s, sizeof(score_s), "%d", score);
    }

    return score_s;
}

int
pcmk__add_scores(int score1, int score2)
{
    /* As long as PCMK_SCORE_INFINITY is less than half of the maximum integer,
     * we can ignore the possibility of integer overflow.
     */
    int result = score1 + score2;

    // First handle the cases where one or both is infinite
    if ((score1 <= -PCMK_SCORE_INFINITY) || (score2 <= -PCMK_SCORE_INFINITY)) {
        return -PCMK_SCORE_INFINITY;
    }
    if ((score1 >= PCMK_SCORE_INFINITY) || (score2 >= PCMK_SCORE_INFINITY)) {
        return PCMK_SCORE_INFINITY;
    }

    // Bound result to infinity.
    if (result >= PCMK_SCORE_INFINITY) {
        return PCMK_SCORE_INFINITY;
    }
    if (result <= -PCMK_SCORE_INFINITY) {
        return -PCMK_SCORE_INFINITY;
    }

    return result;
}

// Deprecated functions kept only for backward API compatibility
// LCOV_EXCL_START

#include <crm/common/scores_compat.h>

char *
score2char(int score)
{
    return pcmk__str_copy(pcmk_readable_score(score));
}

char *
score2char_stack(int score, char *buf, size_t len)
{
    CRM_CHECK((buf != NULL) && (len >= sizeof(PCMK_VALUE_MINUS_INFINITY)),
              return NULL);
    strcpy(buf, pcmk_readable_score(score));
    return buf;
}

// LCOV_EXCL_STOP
// End deprecated API