HelenOS sources

root/uspace/lib/device/src/vbd.c

DEFINITIONS

1. vbd_create
2. vbd_destroy
3. vbd_get_disks
4. vbd_disk_info
5. vbd_label_create
6. vbd_label_delete
7. vbd_get_ids_once
8. vbd_get_ids_internal
9. vbd_label_get_parts
10. vbd_part_get_info
11. vbd_part_create
12. vbd_part_delete
13. vbd_pspec_init
14. vbd_suggest_ptype

/*
 * Copyright (c) 2015 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 libdevice
 * @{
 */
/** @file Virtual Block Device client API
 */

#include <abi/ipc/interfaces.h>
#include <errno.h>
#include <ipc/services.h>
#include <ipc/vbd.h>
#include <loc.h>
#include <macros.h>
#include <mem.h>
#include <stdlib.h>
#include <types/label.h>
#include <vbd.h>

static errno_t vbd_get_ids_internal(vbd_t *, sysarg_t, sysarg_t, sysarg_t **,
    size_t *);

errno_t vbd_create(vbd_t **rvbd)
{
        vbd_t *vbd;
        service_id_t vbd_svcid;
        errno_t rc;

        vbd = calloc(1, sizeof(vbd_t));
        if (vbd == NULL) {
                rc = ENOMEM;
                goto error;
        }

        rc = loc_service_get_id(SERVICE_NAME_VBD, &vbd_svcid,
            IPC_FLAG_BLOCKING);
        if (rc != EOK) {
                rc = EIO;
                goto error;
        }

        vbd->sess = loc_service_connect(vbd_svcid, INTERFACE_VBD,
            IPC_FLAG_BLOCKING);
        if (vbd->sess == NULL) {
                rc = EIO;
                goto error;
        }

        *rvbd = vbd;
        return EOK;
error:
        free(vbd);
        return rc;
}

void vbd_destroy(vbd_t *vbd)
{
        if (vbd == NULL)
                return;

        async_hangup(vbd->sess);
        free(vbd);
}

/** Get list of partitions as array of service IDs.
 *
 * @param vbd Virtual block device service
 * @param data Place to store pointer to array
 * @param count Place to store length of array (number of entries)
 *
 * @return EOK on success or an error code
 */
errno_t vbd_get_disks(vbd_t *vbd, service_id_t **data, size_t *count)
{
        return vbd_get_ids_internal(vbd, VBD_GET_DISKS, 0, data, count);
}

/** Get disk information. */
errno_t vbd_disk_info(vbd_t *vbd, service_id_t sid, vbd_disk_info_t *vinfo)
{
        async_exch_t *exch;
        errno_t retval;
        ipc_call_t answer;

        exch = async_exchange_begin(vbd->sess);
        aid_t req = async_send_1(exch, VBD_DISK_INFO, sid, &answer);
        errno_t rc = async_data_read_start(exch, vinfo, sizeof(vbd_disk_info_t));
        async_exchange_end(exch);

        if (rc != EOK) {
                async_forget(req);
                return EIO;
        }

        async_wait_for(req, &retval);
        if (retval != EOK)
                return EIO;

        return EOK;
}

errno_t vbd_label_create(vbd_t *vbd, service_id_t sid, label_type_t ltype)
{
        async_exch_t *exch;
        errno_t retval;

        exch = async_exchange_begin(vbd->sess);
        retval = async_req_2_0(exch, VBD_LABEL_CREATE, sid, ltype);
        async_exchange_end(exch);

        if (retval != EOK)
                return EIO;

        return EOK;
}

errno_t vbd_label_delete(vbd_t *vbd, service_id_t sid)
{
        async_exch_t *exch;
        errno_t retval;

        exch = async_exchange_begin(vbd->sess);
        retval = async_req_1_0(exch, VBD_LABEL_DELETE, sid);
        async_exchange_end(exch);

        if (retval != EOK)
                return EIO;

        return EOK;
}

/** Get list of IDs into a buffer of fixed size.
 *
 * @param vbd      Virtual Block Device
 * @param method   IPC method
 * @param arg1     First argument
 * @param id_buf   Buffer to store IDs
 * @param buf_size Buffer size
 * @param act_size Place to store actual size of complete data.
 *
 * @return EOK on success or an error code.
 */
static errno_t vbd_get_ids_once(vbd_t *vbd, sysarg_t method, sysarg_t arg1,
    sysarg_t *id_buf, size_t buf_size, size_t *act_size)
{
        async_exch_t *exch = async_exchange_begin(vbd->sess);

        ipc_call_t answer;
        aid_t req = async_send_1(exch, method, arg1, &answer);
        errno_t rc = async_data_read_start(exch, id_buf, buf_size);

        async_exchange_end(exch);

        if (rc != EOK) {
                async_forget(req);
                return rc;
        }

        errno_t retval;
        async_wait_for(req, &retval);

        if (retval != EOK) {
                return retval;
        }

        *act_size = ipc_get_arg1(&answer);
        return EOK;
}

/** Get list of IDs.
 *
 * Returns an allocated array of service IDs.
 *
 * @param vbd    Virtual Block Device
 * @param method IPC method
 * @param arg1   IPC argument 1
 * @param data   Place to store pointer to array of IDs
 * @param count  Place to store number of IDs
 * @return       EOK on success or an error code
 */
static errno_t vbd_get_ids_internal(vbd_t *vbd, sysarg_t method, sysarg_t arg1,
    sysarg_t **data, size_t *count)
{
        *data = NULL;
        *count = 0;

        size_t act_size = 0;
        errno_t rc = vbd_get_ids_once(vbd, method, arg1, NULL, 0, &act_size);
        if (rc != EOK)
                return rc;

        size_t alloc_size = act_size;
        service_id_t *ids = malloc(alloc_size);
        if (ids == NULL)
                return ENOMEM;

        while (true) {
                rc = vbd_get_ids_once(vbd, method, arg1, ids, alloc_size,
                    &act_size);
                if (rc != EOK)
                        return rc;

                if (act_size <= alloc_size)
                        break;

                alloc_size = act_size;
                service_id_t *tmp = realloc(ids, alloc_size);
                if (tmp == NULL) {
                        free(ids);
                        return ENOMEM;
                }
                ids = tmp;
        }

        *count = act_size / sizeof(service_id_t);
        *data = ids;
        return EOK;
}

/** Get list of disks as array of service IDs.
 *
 * @param vbd   Virtual Block Device
 * @param data  Place to store pointer to array
 * @param count Place to store length of array (number of entries)
 *
 * @return EOK on success or an error code
 */
errno_t vbd_label_get_parts(vbd_t *vbd, service_id_t disk,
    service_id_t **data, size_t *count)
{
        return vbd_get_ids_internal(vbd, VBD_LABEL_GET_PARTS, disk,
            data, count);
}

errno_t vbd_part_get_info(vbd_t *vbd, vbd_part_id_t part, vbd_part_info_t *pinfo)
{
        async_exch_t *exch;
        errno_t retval;
        ipc_call_t answer;

        exch = async_exchange_begin(vbd->sess);
        aid_t req = async_send_1(exch, VBD_PART_GET_INFO, part, &answer);
        errno_t rc = async_data_read_start(exch, pinfo, sizeof(vbd_part_info_t));
        async_exchange_end(exch);

        if (rc != EOK) {
                async_forget(req);
                return EIO;
        }

        async_wait_for(req, &retval);
        if (retval != EOK)
                return EIO;

        return EOK;
}

errno_t vbd_part_create(vbd_t *vbd, service_id_t disk, vbd_part_spec_t *pspec,
    vbd_part_id_t *rpart)
{
        async_exch_t *exch;
        errno_t retval;
        ipc_call_t answer;

        exch = async_exchange_begin(vbd->sess);
        aid_t req = async_send_1(exch, VBD_PART_CREATE, disk, &answer);
        errno_t rc = async_data_write_start(exch, pspec, sizeof(vbd_part_spec_t));
        async_exchange_end(exch);

        if (rc != EOK) {
                async_forget(req);
                return EIO;
        }

        async_wait_for(req, &retval);
        if (retval != EOK)
                return EIO;

        *rpart = (vbd_part_id_t)ipc_get_arg1(&answer);
        return EOK;

}

errno_t vbd_part_delete(vbd_t *vbd, vbd_part_id_t part)
{
        async_exch_t *exch;
        errno_t retval;

        exch = async_exchange_begin(vbd->sess);
        retval = async_req_1_0(exch, VBD_PART_DELETE, part);
        async_exchange_end(exch);

        if (retval != EOK)
                return EIO;

        return EOK;
}

void vbd_pspec_init(vbd_part_spec_t *pspec)
{
        memset(pspec, 0, sizeof(vbd_part_spec_t));
}

/** Suggest partition type based on partition content.
 *
 * @param vbd   Virtual Block Device
 * @param disk  Disk on which the partition will be created
 * @param pcnt  Partition content
 * @param ptype Place to store suggested partition type
 *
 * @return EOK on success or an error code
 */
errno_t vbd_suggest_ptype(vbd_t *vbd, service_id_t disk, label_pcnt_t pcnt,
    label_ptype_t *ptype)
{
        async_exch_t *exch;
        errno_t retval;
        ipc_call_t answer;

        exch = async_exchange_begin(vbd->sess);
        aid_t req = async_send_2(exch, VBD_SUGGEST_PTYPE, disk, pcnt, &answer);
        errno_t rc = async_data_read_start(exch, ptype, sizeof(label_ptype_t));
        async_exchange_end(exch);

        if (rc != EOK) {
                async_forget(req);
                return EIO;
        }

        async_wait_for(req, &retval);
        if (retval != EOK)
                return EIO;

        return EOK;
}

/** @}
 */