ms-nfs41-client/daemon/pnfs_device.c

/* Copyright (c) 2010
 * The Regents of the University of Michigan
 * All Rights Reserved
 *
 * Permission is granted to use, copy and redistribute this software
 * for noncommercial education and research purposes, so long as no
 * fee is charged, and so long as the name of the University of Michigan
 * is not used in any advertising or publicity pertaining to the use
 * or distribution of this software without specific, written prior
 * authorization.  Permission to modify or otherwise create derivative
 * works of this software is not granted.
 *
 * This software is provided as is, without representation or warranty
 * of any kind either express or implied, including without limitation
 * the implied warranties of merchantability, fitness for a particular
 * purpose, or noninfringement.  The Regents of the University of
 * Michigan shall not be liable for any damages, including special,
 * indirect, incidental, or consequential damages, with respect to any
 * claim arising out of or in connection with the use of the software,
 * even if it has been or is hereafter advised of the possibility of
 * such damages.
 */

#include <Windows.h>
#include <strsafe.h>
#include <stdio.h>

#include "nfs41_ops.h"
#include "daemon_debug.h"


#define FDLVL 2 /* dprintf level for file device logging */


/* pnfs_file_device_list */
struct pnfs_file_device_list {
    struct list_entry       head;
    CRITICAL_SECTION        lock;
};

#define device_entry(pos) list_container(pos, pnfs_file_device, entry)


static enum pnfs_status file_device_create(
    IN const unsigned char *deviceid,
    OUT pnfs_file_device **device_out)
{
    enum pnfs_status status = PNFS_SUCCESS;
    pnfs_file_device *device;

    device = calloc(1, sizeof(pnfs_file_device));
    if (device == NULL) {
        status = PNFSERR_RESOURCES;
        goto out;
    }

    memcpy(device->device.deviceid, deviceid, PNFS_DEVICEID_SIZE);
    InitializeSRWLock(&device->lock);
    *device_out = device;
out:
    return status;
}

static void file_device_free(
    IN pnfs_file_device *device)
{
    free(device->servers.arr);
    free(device->stripes.arr);
    free(device);
}

static int deviceid_compare(
    const struct list_entry *entry,
    const void *deviceid)
{
    const pnfs_file_device *device = device_entry(entry);
    return memcmp(device->device.deviceid, deviceid, PNFS_DEVICEID_SIZE);
}

static enum pnfs_status file_device_entry_find(
    IN struct pnfs_file_device_list *devices,
    IN const unsigned char *deviceid,
    OUT struct list_entry **entry_out)
{
    *entry_out = list_search(&devices->head, deviceid, deviceid_compare);
    return *entry_out ? PNFS_SUCCESS : PNFSERR_NO_DEVICE;
}

static enum pnfs_status file_device_find_or_create(
    IN const unsigned char *deviceid,
    IN struct pnfs_file_device_list *devices,
    OUT pnfs_file_device **device_out)
{
    struct list_entry *entry;
    enum pnfs_status status;

    dprintf(FDLVL, "--> pnfs_file_device_find_or_create()\n");

    EnterCriticalSection(&devices->lock);

    /* search for an existing device */
    status = file_device_entry_find(devices, deviceid, &entry);
    if (status) {
        /* create a new device */
        pnfs_file_device *device;
        status = file_device_create(deviceid, &device);
        if (status == PNFS_SUCCESS) {
            /* add it to the list */
            list_add_tail(&devices->head, &device->entry);
            *device_out = device;

            dprintf(FDLVL, "<-- pnfs_file_device_find_or_create() "
                "returning new device %p\n", device);
        } else {
            dprintf(FDLVL, "<-- pnfs_file_device_find_or_create() "
                "returning %s\n", pnfs_error_string(status));
        }
    } else {
        *device_out = device_entry(entry);

        dprintf(FDLVL, "<-- pnfs_file_device_find_or_create() "
            "returning existing device %p\n", *device_out);
    }

    LeaveCriticalSection(&devices->lock);
    return status;
}


enum pnfs_status pnfs_file_device_list_create(
    OUT struct pnfs_file_device_list **devices_out)
{
    enum pnfs_status status = PNFS_SUCCESS;
    struct pnfs_file_device_list *devices;

    devices = calloc(1, sizeof(struct pnfs_file_device_list));
    if (devices == NULL) {
        status = PNFSERR_RESOURCES;
        goto out;
    }

    list_init(&devices->head);
    InitializeCriticalSection(&devices->lock);

    *devices_out = devices;
out:
    return status;
}

void pnfs_file_device_list_free(
    IN struct pnfs_file_device_list *devices)
{
    struct list_entry *entry, *tmp;

    EnterCriticalSection(&devices->lock);

    list_for_each_tmp(entry, tmp, &devices->head)
        file_device_free(device_entry(entry));

    LeaveCriticalSection(&devices->lock);

    free(devices);
}


/* pnfs_file_device */
static enum pnfs_status file_device_status(
    IN pnfs_file_device *device)
{
    return device->device.type == 0 ? PNFS_PENDING : PNFS_SUCCESS;
}

enum pnfs_status pnfs_file_device_get(
    IN nfs41_session *session,
    IN struct pnfs_file_device_list *devices,
    IN unsigned char *deviceid,
    OUT pnfs_file_device **device_out)
{
    pnfs_file_device *device;
    enum pnfs_status status;
    enum nfsstat4 nfsstat;

    dprintf(FDLVL, "--> pnfs_file_device_get()\n");

    status = file_device_find_or_create(deviceid, devices, &device);
    if (status)
        goto out;

    AcquireSRWLockShared(&device->lock);
    status = file_device_status(device);
    ReleaseSRWLockShared(&device->lock);

    if (status == PNFS_PENDING) {
        AcquireSRWLockExclusive(&device->lock);

        status = file_device_status(device);
        if (status == PNFS_PENDING) {
            nfsstat = pnfs_rpc_getdeviceinfo(session, deviceid, device);
            if (nfsstat == NFS4_OK) {
                status = PNFS_SUCCESS;

                dprintf(FDLVL, "Received device info:\n");
                dprint_device(FDLVL, device);
            } else {
                status = PNFSERR_NO_DEVICE;

                eprintf("pnfs_rpc_getdeviceinfo() failed with %s\n",
                    nfs_error_string(nfsstat));
            }
        }

        ReleaseSRWLockExclusive(&device->lock);
    }

    *device_out = device;
out:
    dprintf(FDLVL, "<-- pnfs_file_device_get() returning %s\n",
        pnfs_error_string(status));
    return status;
}

static enum pnfs_status data_client_status(
    IN pnfs_data_server *server,
    OUT nfs41_client **client_out)
{
    enum pnfs_status status = PNFSERR_NOT_CONNECTED;

    if (server->client) {
        dprintf(FDLVL, "pnfs_data_server_client() returning "
            "existing client %llu\n", server->client->clnt_id);
        *client_out = server->client;
        status = PNFS_SUCCESS;
    }
    return status;
}

enum pnfs_status pnfs_data_server_client(
    IN nfs41_root *root,
    IN pnfs_data_server *server,
    IN uint32_t default_lease,
    OUT nfs41_client **client_out)
{
    int status;
    enum pnfs_status pnfsstat;

    dprintf(FDLVL, "--> pnfs_data_server_client('%s')\n",
        server->addrs.arr[0].uaddr);

    /* if we've already created the client, return it */
    AcquireSRWLockShared(&server->lock);
    pnfsstat = data_client_status(server, client_out);
    ReleaseSRWLockShared(&server->lock);

    if (pnfsstat) {
        AcquireSRWLockExclusive(&server->lock);

        pnfsstat = data_client_status(server, client_out);
        if (pnfsstat) {
            status = nfs41_root_mount_addrs(root, &server->addrs,
                1, default_lease, &server->client);
            if (status) {
                dprintf(FDLVL, "data_client_create('%s') failed with %d\n",
                    server->addrs.arr[0].uaddr, status);
            } else {
                *client_out = server->client;
                pnfsstat = PNFS_SUCCESS;

                dprintf(FDLVL, "pnfs_data_server_client() returning "
                    "new client %llu\n", server->client->clnt_id);
            }
        }

        ReleaseSRWLockExclusive(&server->lock);
    }
    return pnfsstat;
}


/* 13.4.2. Interpreting the File Layout Using Sparse Packing
 * http://tools.ietf.org/html/rfc5661#section-13.4.2 */

static enum pnfs_status get_sparse_fh(
    IN pnfs_io_pattern *pattern,
    IN uint32_t stripeid,
    OUT nfs41_path_fh **file_out)
{
    pnfs_file_layout *layout = pattern->layout;
    const uint32_t filehandle_count = layout->filehandles.count;
    const uint32_t server_count = layout->device->servers.count;
    enum pnfs_status status = PNFS_SUCCESS;

    if (filehandle_count == server_count) {
        const uint32_t serverid = data_server_index(layout->device, stripeid);
        *file_out = &layout->filehandles.arr[serverid];
    } else if (filehandle_count == 1) {
        *file_out = &layout->filehandles.arr[0];
    } else if (filehandle_count == 0) {
        *file_out = pattern->meta_file;
    } else {
        eprintf("invalid sparse layout! has %u file handles "
            "and %u servers\n", filehandle_count, server_count);
        status = PNFSERR_INVALID_FH_LIST;
    }
    return status;
}

/* 13.4.3. Interpreting the File Layout Using Dense Packing
* http://tools.ietf.org/html/rfc5661#section-13.4.3 */

static enum pnfs_status get_dense_fh(
    IN pnfs_io_pattern *pattern,
    IN uint32_t stripeid,
    OUT nfs41_path_fh **file_out)
{
    pnfs_file_layout *layout = pattern->layout;
    const uint32_t filehandle_count = layout->filehandles.count;
    const uint32_t stripe_count = layout->device->stripes.count;
    enum pnfs_status status = PNFS_SUCCESS;

    if (filehandle_count == stripe_count) {
        *file_out = &layout->filehandles.arr[stripeid];
    } else {
        eprintf("invalid dense layout! has %u file handles "
            "and %u stripes\n", filehandle_count, stripe_count);
        status = PNFSERR_INVALID_FH_LIST;
    }
    return status;
}

static __inline uint64_t positive_remainder(
    IN uint64_t dividend,
    IN uint32_t divisor)
{
    const uint64_t remainder = dividend % divisor;
    return remainder < divisor ? remainder : remainder + divisor;
}

/* 13.4.4. Sparse and Dense Stripe Unit Packing
 * http://tools.ietf.org/html/rfc5661#section-13.4.4 */

enum pnfs_status pnfs_file_device_io_unit(
    IN pnfs_io_pattern *pattern,
    IN uint64_t offset,
    OUT pnfs_io_unit *io)
{
    pnfs_file_layout *layout = pattern->layout;
    enum pnfs_status status = PNFS_SUCCESS;

    const uint32_t unit_size = layout_unit_size(layout);
    const uint32_t stripe_count = layout->device->stripes.count;
    const uint64_t sui = stripe_unit_number(layout, offset, unit_size);
    const uint64_t offset_end = layout->pattern_offset + unit_size * (sui + 1);

    io->stripeid = stripe_index(layout, sui, stripe_count);
    io->serverid = data_server_index(layout->device, io->stripeid);

    if (is_dense(layout)) {
        const uint64_t rel_offset = offset - layout->pattern_offset;
        const uint64_t remainder = positive_remainder(rel_offset, unit_size);
        const uint32_t stride = unit_size * stripe_count;

        io->offset = (rel_offset / stride) * unit_size + remainder;

        status = get_dense_fh(pattern, io->stripeid, &io->file);
    } else {
        io->offset = offset;

        status = get_sparse_fh(pattern, io->stripeid, &io->file);
    }

    io->buffer = pattern->buffer + offset - pattern->offset_start;
    io->length = offset_end - offset;
    if (offset + io->length > pattern->offset_end)
        io->length = pattern->offset_end - offset;
    return status;
}