examples/quota_watermark/qwctl/commands.c

/*-
 *   BSD LICENSE
 *
 *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following conditions
 *   are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in
 *       the documentation and/or other materials provided with the
 *       distribution.
 *     * Neither the name of Intel Corporation nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include <stdio.h>
#include <stdint.h>
#include <string.h>
#include <termios.h>

#include <cmdline_rdline.h>
#include <cmdline_parse.h>
#include <cmdline_parse_num.h>
#include <cmdline_parse_string.h>
#include <cmdline.h>

#include <rte_ring.h>

#include "qwctl.h"
#include "../include/conf.h"


struct cmd_help_tokens {
    cmdline_fixed_string_t verb;
};

cmdline_parse_token_string_t cmd_help_verb =
        TOKEN_STRING_INITIALIZER(struct cmd_help_tokens, verb, "help");

static void
cmd_help_handler(__attribute__((unused)) void *parsed_result,
        struct cmdline *cl,
        __attribute__((unused)) void *data)
{
    cmdline_printf(cl, "Available commands:\n"
            "- help\n"
            "- set  [ring_name|variable] <value>\n"
            "- show [ring_name|variable]\n"
            "\n"
            "Available variables:\n"
            "- low_watermark\n"
            "- quota\n"
            "- ring names follow the core%%u_port%%u format\n");
}

cmdline_parse_inst_t cmd_help = {
        .f = cmd_help_handler,
        .data = NULL,
        .help_str = "show help",
        .tokens = {
                (void *) &cmd_help_verb,
                NULL,
        },
};


struct cmd_set_tokens {
    cmdline_fixed_string_t verb;
    cmdline_fixed_string_t variable;
    uint32_t value;
};

cmdline_parse_token_string_t cmd_set_verb =
        TOKEN_STRING_INITIALIZER(struct cmd_set_tokens, verb, "set");

cmdline_parse_token_string_t cmd_set_variable =
        TOKEN_STRING_INITIALIZER(struct cmd_set_tokens, variable, NULL);

cmdline_parse_token_num_t cmd_set_value =
        TOKEN_NUM_INITIALIZER(struct cmd_set_tokens, value, UINT32);

static void
cmd_set_handler(__attribute__((unused)) void *parsed_result,
        struct cmdline *cl,
        __attribute__((unused)) void *data)
{
    struct cmd_set_tokens *tokens = parsed_result;
    struct rte_ring *ring;

    if (!strcmp(tokens->variable, "quota")) {

        if (tokens->value > 0 && tokens->value <= MAX_PKT_QUOTA)
            *quota = tokens->value;
        else
            cmdline_printf(cl, "quota must be between 1 and %u\n",
                    MAX_PKT_QUOTA);
    }

    else if (!strcmp(tokens->variable, "low_watermark")) {

        if (tokens->value <= 100)
            *low_watermark = tokens->value * RING_SIZE / 100;
        else
            cmdline_printf(cl,
                    "low_watermark must be between 0%% and 100%%\n");
    }

    else {

        ring = rte_ring_lookup(tokens->variable);
        if (ring == NULL)
            cmdline_printf(cl, "Cannot find ring \"%s\"\n",
                    tokens->variable);
        else
            if (tokens->value >= *low_watermark * 100 / RING_SIZE
                    && tokens->value <= 100)
                *high_watermark = tokens->value *
                        RING_SIZE / 100;
            else
                cmdline_printf(cl,
                    "ring high watermark must be between %u%% and 100%%\n",
                    *low_watermark * 100 / RING_SIZE);
    }
}

cmdline_parse_inst_t cmd_set = {
        .f = cmd_set_handler,
        .data = NULL,
        .help_str = "Set a variable value",
        .tokens = {
                (void *) &cmd_set_verb,
                (void *) &cmd_set_variable,
                (void *) &cmd_set_value,
                NULL,
        },
};


struct cmd_show_tokens {
    cmdline_fixed_string_t verb;
    cmdline_fixed_string_t variable;
};

cmdline_parse_token_string_t cmd_show_verb =
        TOKEN_STRING_INITIALIZER(struct cmd_show_tokens, verb, "show");

cmdline_parse_token_string_t cmd_show_variable =
        TOKEN_STRING_INITIALIZER(struct cmd_show_tokens,
                variable, NULL);


static void
cmd_show_handler(__attribute__((unused)) void *parsed_result,
        struct cmdline *cl,
        __attribute__((unused)) void *data)
{
    struct cmd_show_tokens *tokens = parsed_result;
    struct rte_ring *ring;

    if (!strcmp(tokens->variable, "quota"))
        cmdline_printf(cl, "Global quota: %d\n", *quota);

    else if (!strcmp(tokens->variable, "low_watermark"))
        cmdline_printf(cl, "Global low_watermark: %u\n",
                *low_watermark);

    else {

        ring = rte_ring_lookup(tokens->variable);
        if (ring == NULL)
            cmdline_printf(cl, "Cannot find ring \"%s\"\n",
                    tokens->variable);
        else
            rte_ring_dump(stdout, ring);
    }
}

cmdline_parse_inst_t cmd_show = {
        .f = cmd_show_handler,
        .data = NULL,
        .help_str = "Show a variable value",
        .tokens = {
                (void *) &cmd_show_verb,
                (void *) &cmd_show_variable,
                NULL,
        },
};


cmdline_parse_ctx_t qwctl_ctx[] = {
        (cmdline_parse_inst_t *)&cmd_help,
        (cmdline_parse_inst_t *)&cmd_set,
        (cmdline_parse_inst_t *)&cmd_show,
        NULL,
};