x15/kern/syscnt.c

/*
 * Copyright (c) 2014-2019 Richard Braun.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include <stddef.h>
#include <stdio.h>
#include <string.h>

#include <kern/atomic.h>
#include <kern/init.h>
#include <kern/list.h>
#include <kern/log.h>
#include <kern/mutex.h>
#include <kern/shell.h>
#include <kern/spinlock.h>
#include <kern/syscnt.h>
#include <kern/thread.h>

/*
 * Global list of all registered counters.
 */
static struct list syscnt_list;
static struct mutex syscnt_lock;

#ifdef CONFIG_SHELL

static void
syscnt_shell_info(struct shell *shell, int argc, char **argv)
{
    char *prefix;

    (void)shell;

    prefix = (argc >= 2) ? argv[1] : NULL;
    syscnt_info(prefix, printf_ln);
}

static struct shell_cmd syscnt_shell_cmds[] = {
    SHELL_CMD_INITIALIZER("syscnt_info", syscnt_shell_info,
                          "syscnt_info [<prefix>]",
                          "display information about system counters"),
};

static int __init
syscnt_setup_shell(void)
{
    SHELL_REGISTER_CMDS(syscnt_shell_cmds, shell_get_main_cmd_set());
    return 0;
}

INIT_OP_DEFINE(syscnt_setup_shell,
               INIT_OP_DEP(shell_setup, true),
               INIT_OP_DEP(syscnt_setup, true));

#endif /* CONFIG_SHELL */

static int __init
syscnt_setup(void)
{
    list_init(&syscnt_list);
    mutex_init(&syscnt_lock);
    return 0;
}

/*
 * Do not make initialization depend on mutex_setup, since mutex
 * modules may use system counters for debugging.
 */
INIT_OP_DEFINE(syscnt_setup,
               INIT_OP_DEP(mutex_bootstrap, true),
               INIT_OP_DEP(spinlock_setup, true));

void __init
syscnt_register(struct syscnt *syscnt, const char *name)
{
#ifndef ATOMIC_HAVE_64B_OPS
    spinlock_init(&syscnt->lock);
#endif
    syscnt->value = 0;
    strlcpy(syscnt->name, name, sizeof(syscnt->name));

    mutex_lock(&syscnt_lock);
    list_insert_tail(&syscnt_list, &syscnt->node);
    mutex_unlock(&syscnt_lock);
}

void
syscnt_info(const char *prefix, log_print_fn_t print_fn)
{
    struct syscnt *syscnt;
    size_t length, prefix_length;
    uint64_t value;

    prefix_length = (prefix == NULL) ? 0 : strlen(prefix);

    mutex_lock(&syscnt_lock);

    list_for_each_entry(&syscnt_list, syscnt, node) {
        if (prefix_length != 0) {
            length = strlen(syscnt->name);

            if ((length < prefix_length)
                || (memcmp(syscnt->name, prefix, prefix_length) != 0)) {
                continue;
            }
        }

        value = syscnt_read(syscnt);

        print_fn("syscnt: %40s %20llu", syscnt->name,
                 (unsigned long long)value);
    }

    mutex_unlock(&syscnt_lock);
}