HelenOS sources

root/uspace/app/vol/vol.c

/* [<][>][^][v][top][bottom][index][help] */

DEFINITIONS

This source file includes following definitions.
  1. vol_cmd_part_by_mp
  2. vol_cmd_eject
  3. vol_cmd_insert
  4. vol_cmd_insert_by_path
  5. vol_cmd_list
  6. vol_cmd_cfglist
  7. print_syntax
  8. main

/*
 * Copyright (c) 2017 Jiri Svoboda
 * 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.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
 */

/** @addtogroup vol
 * @{
 */
/** @file Volume administration (interface to volsrv).
 */

#include <errno.h>
#include <io/table.h>
#include <loc.h>
#include <stdio.h>
#include <stdlib.h>
#include <str.h>
#include <vfs/vfs.h>
#include <vol.h>

#define NAME "vol"

typedef enum {
        vcmd_eject,
        vcmd_insert,
        vcmd_insert_by_path,
        vcmd_help,
        vcmd_list,
        vcmd_cfglist,
} vol_cmd_t;

/** Find volume by current mount point. */
static errno_t vol_cmd_part_by_mp(vol_t *vol, const char *mp,
    service_id_t *rid)
{
        vol_part_info_t vinfo;
        service_id_t *part_ids = NULL;
        char *canon_mp_buf = NULL;
        char *canon_mp;
        size_t nparts;
        size_t i;
        errno_t rc;

        canon_mp_buf = str_dup(mp);
        if (canon_mp_buf == NULL) {
                printf("Out of memory.\n");
                rc = ENOMEM;
                goto out;
        }

        canon_mp = vfs_absolutize(canon_mp_buf, NULL);
        if (canon_mp == NULL) {
                printf("Invalid volume path '%s'.\n", mp);
                rc = EINVAL;
                goto out;
        }

        rc = vol_get_parts(vol, &part_ids, &nparts);
        if (rc != EOK) {
                printf("Error getting list of volumes.\n");
                goto out;
        }

        for (i = 0; i < nparts; i++) {
                rc = vol_part_info(vol, part_ids[i], &vinfo);
                if (rc != EOK) {
                        printf("Error getting volume information.\n");
                        rc = EIO;
                        goto out;
                }

                if (str_cmp(vinfo.cur_mp, canon_mp) == 0) {
                        *rid = part_ids[i];
                        rc = EOK;
                        goto out;
                }
        }

        rc = ENOENT;
out:
        free(part_ids);
        free(canon_mp_buf);
        return rc;
}

static errno_t vol_cmd_eject(const char *volspec)
{
        vol_t *vol = NULL;
        service_id_t part_id;
        errno_t rc;

        rc = vol_create(&vol);
        if (rc != EOK) {
                printf("Error contacting volume service.\n");
                goto out;
        }

        rc = vol_cmd_part_by_mp(vol, volspec, &part_id);
        if (rc != EOK) {
                printf("Error looking up volume '%s'.\n", volspec);
                goto out;
        }

        rc = vol_part_eject(vol, part_id);
        if (rc != EOK) {
                printf("Error ejecting volume.\n");
                goto out;
        }

        rc = EOK;
out:
        vol_destroy(vol);
        return rc;
}

static errno_t vol_cmd_insert(const char *volspec)
{
        vol_t *vol = NULL;
        service_id_t svc_id;
        errno_t rc;

        rc = loc_service_get_id(volspec, &svc_id, 0);
        if (rc != EOK) {
                printf("Error looking up service '%s'.\n", volspec);
                goto out;
        }

        rc = vol_create(&vol);
        if (rc != EOK) {
                printf("Error contacting volume service.\n");
                goto out;
        }

        rc = vol_part_insert(vol, svc_id);
        if (rc != EOK) {
                printf("Error inserting volume.\n");
                goto out;
        }

        rc = EOK;
out:
        vol_destroy(vol);
        return rc;
}

static errno_t vol_cmd_insert_by_path(const char *volspec)
{
        vol_t *vol = NULL;
        errno_t rc;

        rc = vol_create(&vol);
        if (rc != EOK) {
                printf("Error contacting volume service.\n");
                goto out;
        }

        rc = vol_part_insert_by_path(vol, volspec);
        if (rc != EOK) {
                printf("Error inserting volume.\n");
                goto out;
        }

        rc = EOK;
out:
        vol_destroy(vol);
        return rc;
}

static errno_t vol_cmd_list(void)
{
        vol_t *vol = NULL;
        vol_part_info_t vinfo;
        service_id_t *part_ids = NULL;
        char *svc_name;
        char *sfstype;
        size_t nparts;
        size_t i;
        table_t *table = NULL;
        errno_t rc;

        rc = vol_create(&vol);
        if (rc != EOK) {
                printf("Error contacting volume service.\n");
                goto out;
        }

        rc = vol_get_parts(vol, &part_ids, &nparts);
        if (rc != EOK) {
                printf("Error getting list of volumes.\n");
                goto out;
        }

        rc = table_create(&table);
        if (rc != EOK) {
                printf("Out of memory.\n");
                goto out;
        }

        table_header_row(table);
        table_printf(table, "Volume Name\t" "Resource\t" "Content\t" "Auto\t"
            "Mounted at\n");

        for (i = 0; i < nparts; i++) {
                rc = vol_part_info(vol, part_ids[i], &vinfo);
                if (rc != EOK) {
                        printf("Error getting volume information.\n");
                        return EIO;
                }

                rc = loc_service_get_name(part_ids[i], &svc_name);
                if (rc != EOK) {
                        printf("Error getting service name.\n");
                        return EIO;
                }

                rc = vol_pcnt_fs_format(vinfo.pcnt, vinfo.fstype, &sfstype);
                if (rc != EOK) {
                        printf("Out of memory.\n");
                        free(svc_name);
                        return ENOMEM;
                }

                table_printf(table, "%s\t" "%s\t" "%s\t" "%s\t" "%s\n",
                    vinfo.label, svc_name, sfstype,
                    vinfo.cur_mp_auto ? "Yes" : "", vinfo.cur_mp);

                free(svc_name);
                free(sfstype);
                svc_name = NULL;
        }

        rc = table_print_out(table, stdout);
        if (rc != EOK)
                printf("Error printing table.\n");
out:
        table_destroy(table);
        vol_destroy(vol);
        free(part_ids);

        return rc;
}

/** List volume configuration entries.
 *
 * @return EOK on success or an error code
 */
static errno_t vol_cmd_cfglist(void)
{
        vol_t *vol = NULL;
        vol_info_t vinfo;
        volume_id_t *volume_ids = NULL;
        size_t nvols;
        size_t i;
        table_t *table = NULL;
        errno_t rc;

        rc = vol_create(&vol);
        if (rc != EOK) {
                printf("Error contacting volume service.\n");
                goto out;
        }

        rc = vol_get_volumes(vol, &volume_ids, &nvols);
        if (rc != EOK) {
                printf("Error getting list of volumes.\n");
                goto out;
        }

        rc = table_create(&table);
        if (rc != EOK) {
                printf("Out of memory.\n");
                goto out;
        }

        table_header_row(table);
        table_printf(table, "Volume Name\t" "Path\n");

        for (i = 0; i < nvols; i++) {
                rc = vol_info(vol, volume_ids[i], &vinfo);
                if (rc != EOK) {
                        printf("Error getting volume information.\n");
                        return EIO;
                }

                table_printf(table, "%s\t" "%s\n", vinfo.label, vinfo.path);
        }

        rc = table_print_out(table, stdout);
        if (rc != EOK)
                printf("Error printing table.\n");
out:
        table_destroy(table);
        vol_destroy(vol);
        free(volume_ids);

        return rc;
}

static void print_syntax(void)
{
        printf("Syntax:\n");
        printf("  %s                List present volumes\n", NAME);
        printf("  %s -c             List volume configuration entries\n", NAME);
        printf("  %s -h             Print help\n", NAME);
        printf("  %s eject <mp>     Eject volume mounted in a directory\n", NAME);
        printf("  %s insert <svc>   Insert volume based on service identifier\n", NAME);
        printf("  %s insert -p <mp> Insert volume based on filesystem path\n", NAME);
}

int main(int argc, char *argv[])
{
        char *cmd;
        char *volspec;
        vol_cmd_t vcmd;
        int i;
        errno_t rc = EINVAL;

        if (argc < 2) {
                vcmd = vcmd_list;
                i = 1;
        } else {
                cmd = argv[1];
                i = 2;
                if (str_cmp(cmd, "-h") == 0) {
                        vcmd = vcmd_help;
                } else if (str_cmp(cmd, "-c") == 0) {
                        vcmd = vcmd_cfglist;
                } else if (str_cmp(cmd, "eject") == 0) {
                        vcmd = vcmd_eject;
                        if (argc <= i) {
                                printf("Parameter missing.\n");
                                goto syntax_error;
                        }
                        volspec = argv[i++];
                } else if (str_cmp(cmd, "insert") == 0) {
                        if (str_cmp(argv[i], "-p") == 0) {
                                vcmd = vcmd_insert_by_path;
                                ++i;
                        } else {
                                vcmd = vcmd_insert;
                        }

                        if (argc <= i) {
                                printf("Parameter missing.\n");
                                goto syntax_error;
                        }
                        volspec = argv[i++];
                } else {
                        printf("Invalid sub-command '%s'.\n", cmd);
                        goto syntax_error;
                }
        }

        if (argc > i) {
                printf("Unexpected argument '%s'.\n", argv[i]);
                goto syntax_error;
        }

        switch (vcmd) {
        case vcmd_eject:
                rc = vol_cmd_eject(volspec);
                break;
        case vcmd_insert:
                rc = vol_cmd_insert(volspec);
                break;
        case vcmd_insert_by_path:
                rc = vol_cmd_insert_by_path(volspec);
                break;
        case vcmd_help:
                print_syntax();
                rc = EOK;
                break;
        case vcmd_list:
                rc = vol_cmd_list();
                break;
        case vcmd_cfglist:
                rc = vol_cmd_cfglist();
                break;
        }

        if (rc != EOK)
                return 1;

        return 0;

syntax_error:
        printf("Use %s -h to get help.\n", NAME);
        return 1;
}

/** @}
 */

/* [<][>][^][v][top][bottom][index][help] */
HelenOS homepage, sources at GitHub