root/sbin/bectl/bectl_list.c
/*
 * Copyright (c) 2018 Kyle Evans <kevans@FreeBSD.org>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#include <sys/param.h>
#include <stdbool.h>
#include <stdio.h>
#include <string.h>
#include <unistd.h>

#include <be.h>

#include "bectl.h"

struct sort_column {
        const char *name;
        const char *val;
        nvlist_t *nvl;
};

struct printc {
        int     active_colsz_def;
        int     be_colsz;
        int     current_indent;
        int     mount_colsz;
        int     space_colsz;
        bool    script_fmt;
        bool    show_all_datasets;
        bool    show_snaps;
        bool    show_space;
};

static const char *get_origin_props(nvlist_t *dsprops, nvlist_t **originprops);
static void print_padding(const char *fval, int colsz, struct printc *pc);
static int print_snapshots(const char *dsname, struct printc *pc);
static void print_info(const char *name, nvlist_t *dsprops, struct printc *pc);
static void print_headers(nvlist_t *props, struct printc *pc);
static unsigned long long dataset_space(const char *oname);

#define HEADER_BE       "BE"
#define HEADER_BEPLUS   "BE/Dataset/Snapshot"
#define HEADER_ACTIVE   "Active"
#define HEADER_MOUNT    "Mountpoint"
#define HEADER_SPACE    "Space"
#define HEADER_CREATED  "Created"

/* Spaces */
#define INDENT_INCREMENT        2

/*
 * Given a set of dataset properties (for a BE dataset), populate originprops
 * with the origin's properties.
 */
static const char *
get_origin_props(nvlist_t *dsprops, nvlist_t **originprops)
{
        const char *propstr;

        if (nvlist_lookup_string(dsprops, "origin", &propstr) == 0) {
                if (be_prop_list_alloc(originprops) != 0) {
                        fprintf(stderr,
                            "bectl list: failed to allocate origin prop nvlist\n");
                        return (NULL);
                }
                if (be_get_dataset_props(be, propstr, *originprops) != 0) {
                        /* XXX TODO: Real errors */
                        fprintf(stderr,
                            "bectl list: failed to fetch origin properties\n");
                        return (NULL);
                }

                return (propstr);
        }
        return (NULL);
}

static void
print_padding(const char *fval, int colsz, struct printc *pc)
{

        /* -H flag handling; all delimiters/padding are a single tab */
        if (pc->script_fmt) {
                printf("\t");
                return;
        }

        if (fval != NULL)
                colsz -= strlen(fval);
        printf("%*s ", colsz, "");
}

static unsigned long long
dataset_space(const char *oname)
{
        unsigned long long space;
        char *dsname, *sep;
        const char *propstr;
        nvlist_t *dsprops;

        space = 0;
        dsname = strdup(oname);
        if (dsname == NULL)
                return (0);

        /* Truncate snapshot to dataset name, as needed */
        if ((sep = strchr(dsname, '@')) != NULL)
                *sep = '\0';

        if (be_prop_list_alloc(&dsprops) != 0) {
                free(dsname);
                return (0);
        }

        if (be_get_dataset_props(be, dsname, dsprops) != 0) {
                nvlist_free(dsprops);
                free(dsname);
                return (0);
        }

        if (nvlist_lookup_string(dsprops, "used", &propstr) == 0)
                space = strtoull(propstr, NULL, 10);

        nvlist_free(dsprops);
        free(dsname);
        return (space);
}

static int
print_snapshots(const char *dsname, struct printc *pc)
{
        nvpair_t *cur;
        nvlist_t *props, *sprops;

        if (be_prop_list_alloc(&props) != 0) {
                fprintf(stderr, "bectl list: failed to allocate snapshot nvlist\n");
                return (1);
        }
        if (be_get_dataset_snapshots(be, dsname, props) != 0) {
                fprintf(stderr, "bectl list: failed to fetch boot ds snapshots\n");
                return (1);
        }
        for (cur = nvlist_next_nvpair(props, NULL); cur != NULL;
            cur = nvlist_next_nvpair(props, cur)) {
                nvpair_value_nvlist(cur, &sprops);
                print_info(nvpair_name(cur), sprops, pc);
        }
        return (0);
}

static void
print_info(const char *name, nvlist_t *dsprops, struct printc *pc)
{
#define BUFSZ   64
        char buf[BUFSZ];
        unsigned long long ctimenum, space;
        nvlist_t *originprops;
        const char *oname, *dsname, *propstr;
        int active_colsz;
        boolean_t active_now, active_reboot, bootonce;

        dsname = NULL;
        originprops = NULL;
        printf("%*s%s", pc->current_indent, "", name);
        nvlist_lookup_string(dsprops, "dataset", &dsname);

        /* Recurse at the base level if we're breaking info down */
        if (pc->current_indent == 0 && (pc->show_all_datasets ||
            pc->show_snaps)) {
                printf("\n");
                if (dsname == NULL)
                        /* XXX TODO: Error? */
                        return;
                /*
                 * Whether we're dealing with -a or -s, we'll always print the
                 * dataset name/information followed by its origin. For -s, we
                 * additionally iterate through all snapshots of this boot
                 * environment and also print their information.
                 */
                pc->current_indent += INDENT_INCREMENT;
                print_info(dsname, dsprops, pc);
                pc->current_indent += INDENT_INCREMENT;
                if ((oname = get_origin_props(dsprops, &originprops)) != NULL) {
                        print_info(oname, originprops, pc);
                        nvlist_free(originprops);
                }

                /* Back up a level; snapshots at the same level as dataset */
                pc->current_indent -= INDENT_INCREMENT;
                if (pc->show_snaps)
                        print_snapshots(dsname, pc);
                pc->current_indent = 0;
                return;
        } else
                print_padding(name, pc->be_colsz - pc->current_indent, pc);

        active_colsz = pc->active_colsz_def;
        if (nvlist_lookup_boolean_value(dsprops, "active",
            &active_now) == 0 && active_now) {
                printf("N");
                active_colsz--;
        }
        if (nvlist_lookup_boolean_value(dsprops, "nextboot",
            &active_reboot) == 0 && active_reboot) {
                printf("R");
                active_colsz--;
        }
        if (nvlist_lookup_boolean_value(dsprops, "bootonce",
            &bootonce) == 0 && bootonce) {
                printf("T");
                active_colsz--;
        }
        if (active_colsz == pc->active_colsz_def) {
                printf("-");
                active_colsz--;
        }
        print_padding(NULL, active_colsz, pc);
        if (nvlist_lookup_string(dsprops, "mounted", &propstr) == 0) {
                printf("%s", propstr);
                print_padding(propstr, pc->mount_colsz, pc);
        } else {
                printf("%s", "-");
                print_padding("-", pc->mount_colsz, pc);
        }

        oname = get_origin_props(dsprops, &originprops);
        if (nvlist_lookup_string(dsprops, "used", &propstr) == 0) {
                /*
                 * The space used column is some composition of:
                 * - The "used" property of the dataset
                 * - The "used" property of the origin snapshot (not -a or -s)
                 * - The "used" property of the origin dataset (-D flag only)
                 *
                 * The -D flag is ignored if -a or -s are specified.
                 */
                space = strtoull(propstr, NULL, 10);

                if (!pc->show_all_datasets && !pc->show_snaps &&
                    originprops != NULL &&
                    nvlist_lookup_string(originprops, "used", &propstr) == 0)
                        space += strtoull(propstr, NULL, 10);

                if (pc->show_space && oname != NULL)
                        space += dataset_space(oname);

                /* Alas, there's more to it,. */
                be_nicenum(space, buf, 6);
                printf("%s", buf);
                print_padding(buf, pc->space_colsz, pc);
        } else {
                printf("-");
                print_padding("-", pc->space_colsz, pc);
        }

        if (nvlist_lookup_string(dsprops, "creation", &propstr) == 0) {
                ctimenum = strtoull(propstr, NULL, 10);
                strftime(buf, BUFSZ, "%Y-%m-%d %H:%M",
                    localtime((time_t *)&ctimenum));
                printf("%s", buf);
        }

        printf("\n");
        if (originprops != NULL)
                be_prop_list_free(originprops);
#undef BUFSZ
}

static void
print_headers(nvlist_t *props, struct printc *pc)
{
        const char *chosen_be_header, *propstr;
        nvpair_t *cur;
        nvlist_t *dsprops;
        size_t be_maxcol, mount_colsz;

        if (pc->show_all_datasets || pc->show_snaps)
                chosen_be_header = HEADER_BEPLUS;
        else
                chosen_be_header = HEADER_BE;
        be_maxcol = strlen(chosen_be_header);
        mount_colsz = strlen(HEADER_MOUNT);
        for (cur = nvlist_next_nvpair(props, NULL); cur != NULL;
            cur = nvlist_next_nvpair(props, cur)) {
                be_maxcol = MAX(be_maxcol, strlen(nvpair_name(cur)));
                nvpair_value_nvlist(cur, &dsprops);

                if (nvlist_lookup_string(dsprops, "mounted", &propstr) == 0)
                        mount_colsz = MAX(mount_colsz, strlen(propstr));
                if (!pc->show_all_datasets && !pc->show_snaps)
                        continue;
                if (nvlist_lookup_string(dsprops, "dataset", &propstr) != 0)
                        continue;
                be_maxcol = MAX(be_maxcol, strlen(propstr) + INDENT_INCREMENT);
                if (nvlist_lookup_string(dsprops, "origin", &propstr) != 0)
                        continue;
                be_maxcol = MAX(be_maxcol,
                    strlen(propstr) + INDENT_INCREMENT * 2);
        }

        pc->be_colsz = be_maxcol;
        pc->active_colsz_def = strlen(HEADER_ACTIVE);
        pc->mount_colsz = mount_colsz;
        pc->space_colsz = strlen(HEADER_SPACE);
        printf("%*s %s %*s %s %s\n", -pc->be_colsz, chosen_be_header,
            HEADER_ACTIVE, -pc->mount_colsz, HEADER_MOUNT, HEADER_SPACE, HEADER_CREATED);

        /*
         * All other invocations in which we aren't using the default header
         * will produce quite a bit of input.  Throw an extra blank line after
         * the header to make it look nicer.
         */
        if (strcmp(chosen_be_header, HEADER_BE) != 0)
                printf("\n");
}

/*
 * Sort the given nvlist of boot environments by property.
 */
static int
prop_list_sort(nvlist_t *props, char *property, bool reverse)
{
        nvpair_t *nvp;
        nvlist_t *nvl;
        int i, nvp_count;
        uint64_t lval, rval;
        struct sort_column sc_prev, sc_next;

        /* a temporary list to work with */
        nvlist_dup(props, &nvl, 0);

        nvp_count = fnvlist_num_pairs(nvl);
        for (i = 0; i < nvp_count; i++) {

                nvp = nvlist_next_nvpair(nvl, NULL);
                nvpair_value_nvlist(nvp, &sc_prev.nvl);
                nvlist_lookup_string(sc_prev.nvl, "name", &sc_prev.name);
                nvlist_lookup_string(sc_prev.nvl, property, &sc_prev.val);

                while ((nvp = nvlist_next_nvpair(nvl, nvp)) != NULL) {

                        nvpair_value_nvlist(nvp, &sc_next.nvl);
                        nvlist_lookup_string(sc_next.nvl, "name", &sc_next.name);
                        nvlist_lookup_string(sc_next.nvl, property, &sc_next.val);

                        /* properties that use numerical comparison */
                        if (strcmp(property, "creation") == 0 ||
                            strcmp(property, "used") == 0 ||
                            strcmp(property, "usedds") == 0 ||
                            strcmp(property, "usedsnap") == 0 ||
                            strcmp(property, "usedrefreserv") == 0) {

                                lval = strtoull(sc_prev.val, NULL, 10);
                                rval = strtoull(sc_next.val, NULL, 10);

                                if ((lval < rval && reverse) ||
                                    (lval > rval && !reverse))
                                        sc_prev = sc_next;
                        }

                        /* properties that use string comparison */
                        else if (strcmp(property, "name") == 0 ||
                                 strcmp(property, "origin") == 0) {
                                if ((strcmp(sc_prev.val, sc_next.val) < 0 && reverse) ||
                                    (strcmp(sc_prev.val, sc_next.val) > 0 && !reverse))
                                        sc_prev = sc_next;
                        }
                }

                /*
                 * The 'props' nvlist has been created to only have unique names.
                 * When a name is added, any existing nvlist's with the same name
                 * will be removed. Eventually, all existing nvlist's are replaced
                 * in sorted order.
                 */
                nvlist_add_nvlist(props, sc_prev.name, sc_prev.nvl);
                nvlist_remove_all(nvl, sc_prev.name);
        }

        be_prop_list_free(nvl);

        return 0;
}

int
bectl_cmd_list(int argc, char *argv[])
{
        struct printc pc;
        nvpair_t *cur;
        nvlist_t *dsprops, *props;
        int opt, printed;
        char *column;
        bool reverse;

        column = NULL;
        props = NULL;
        printed = 0;
        bzero(&pc, sizeof(pc));
        reverse = false;
        while ((opt = getopt(argc, argv, "aDHsc:C:")) != -1) {
                switch (opt) {
                case 'a':
                        pc.show_all_datasets = true;
                        break;
                case 'D':
                        pc.show_space = true;
                        break;
                case 'H':
                        pc.script_fmt = true;
                        break;
                case 's':
                        pc.show_snaps = true;
                        break;
                case 'c':
                        if (column != NULL)
                                free(column);
                        column = strdup(optarg);
                        reverse = false;
                        break;
                case 'C':
                        if (column != NULL)
                                free(column);
                        column = strdup(optarg);
                        reverse = true;
                        break;
                default:
                        fprintf(stderr, "bectl list: unknown option '-%c'\n",
                            optopt);
                        return (usage(false));
                }
        }

        argc -= optind;

        if (argc != 0) {
                fprintf(stderr, "bectl list: extra argument provided\n");
                return (usage(false));
        }

        if (be_prop_list_alloc(&props) != 0) {
                fprintf(stderr, "bectl list: failed to allocate prop nvlist\n");
                return (1);
        }
        if (be_get_bootenv_props(be, props) != 0) {
                /* XXX TODO: Real errors */
                fprintf(stderr, "bectl list: failed to fetch boot environments\n");
                return (1);
        }

        /* List boot environments in alphabetical order by default */
        if (column == NULL)
                column = strdup("name");

        prop_list_sort(props, column, reverse);

        /* Force -D off if either -a or -s are specified */
        if (pc.show_all_datasets || pc.show_snaps)
                pc.show_space = false;
        if (!pc.script_fmt)
                print_headers(props, &pc);

        /* Print boot environments */
        for (cur = nvlist_next_nvpair(props, NULL); cur != NULL;
            cur = nvlist_next_nvpair(props, cur)) {
                nvpair_value_nvlist(cur, &dsprops);

                if (printed > 0 && (pc.show_all_datasets || pc.show_snaps))
                        printf("\n");

                print_info(nvpair_name(cur), dsprops, &pc);
                printed++;
        }

        free(column);
        be_prop_list_free(props);

        return (0);
}