ms-nfs41-client/daemon/pnfs_io.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 <stdio.h>
#include <process.h>

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


#define IOLVL 2 /* dprintf level for pnfs io logging */


static uint32_t io_unit_count(
    const pnfs_file_layout *layout,
    uint64_t length)
{
    const uint32_t unit_size = layout_unit_size(layout);
    return (uint32_t)(length / unit_size) + (length % unit_size ? 1 : 0);
}

static enum pnfs_status pattern_init(
    IN pnfs_io_pattern *pattern,
    IN nfs41_root *root,
    IN nfs41_path_fh *meta_file,
    IN stateid4 *stateid,
    IN pnfs_file_layout *layout,
    IN unsigned char *buffer,
    IN uint64_t offset,
    IN uint64_t length,
    IN uint32_t default_lease)
{
#ifndef PNFS_THREAD_BY_SERVER
    pnfs_io_unit io;
#endif
    uint64_t pos;
    uint32_t i;
    enum pnfs_status status;

    /* take a reference on the layout so we don't return it during io */
    status = pnfs_layout_io_start(&layout->layout);
    if (status)
        goto out;

#ifdef PNFS_THREAD_BY_SERVER
    pattern->count = layout->device->servers.count;
#else
    pattern->count = io_unit_count(layout, length);
#endif
    pattern->threads = calloc(pattern->count, sizeof(pnfs_io_thread));
    if (pattern->threads == NULL) {
        status = PNFSERR_RESOURCES;
        free(pattern);
        goto out;
    }

    pattern->root = root;
    pattern->meta_file = meta_file;
    /* 13.9.1.  Global Stateid Requirements
     * "The stateid sent to the data server MUST be sent
     * with the seqid set to zero" */
    memcpy(&pattern->stateid, stateid, sizeof(stateid4));
    pattern->stateid.seqid = 0;
    pattern->layout = layout;
    pattern->buffer = buffer;
    pattern->offset_start = offset;
    pattern->offset_end = offset + length;
    pattern->default_lease = default_lease;

    pos = pattern->offset_start;
    for (i = 0; i < pattern->count; i++) {
        pattern->threads[i].pattern = pattern;
        pattern->threads[i].stable = DATA_SYNC4;
#ifdef PNFS_THREAD_BY_SERVER
        pattern->threads[i].offset = pattern->offset_start;
        pattern->threads[i].offset_end = pattern->offset_end;
        pattern->threads[i].id = i;
#else
        pnfs_file_device_io_unit(pattern, pos, &io);
        pattern->threads[i].offset = pos;
        pattern->threads[i].offset_end = pos += io.length;
        pattern->threads[i].id = io.stripeid;

        if (pattern->threads[i].offset > pattern->offset_end)
            pattern->threads[i].offset = pattern->offset_end;
        if (pattern->threads[i].offset_end > pattern->offset_end)
            pattern->threads[i].offset_end = pattern->offset_end;

        dprintf(IOLVL, "io_unit(off=%llu end=%llu id=%u)\n",
            pattern->threads[i].offset,
            pattern->threads[i].offset_end,
            pattern->threads[i].id);
#endif
    }
out:
    return status;
}

static void pattern_free(
    IN pnfs_io_pattern *pattern)
{
    /* inform the layout that our io is finished */
    pnfs_layout_io_finished(&pattern->layout->layout);
    free(pattern->threads);
}

static enum pnfs_status thread_next_unit(
    IN pnfs_io_thread *thread,
    OUT pnfs_io_unit *io)
{
    pnfs_io_pattern *pattern = thread->pattern;
    pnfs_file_layout *layout = pattern->layout;
    enum pnfs_status status = PNFS_SUCCESS;

    AcquireSRWLockShared(&layout->layout.lock);

    /* stop io if the layout is recalled */
    if (layout->layout.status & PNFS_LAYOUT_CHANGED) {
        status = PNFSERR_LAYOUT_CHANGED;
        goto out_unlock;
    }
    if (layout->layout.status & PNFS_LAYOUT_RECALLED) {
        status = PNFSERR_LAYOUT_RECALLED;
        goto out_unlock;
    }

    /* loop until we find an io unit that matches this thread */
    while (thread->offset < thread->offset_end) {
        status = pnfs_file_device_io_unit(pattern, thread->offset, io);
        if (status)
            break;

#ifdef PNFS_THREAD_BY_SERVER
        if (io->serverid == thread->id) {
#else
        if (io->stripeid == thread->id) {
#endif
            status = PNFS_PENDING;
            break;
        }

        thread->offset += io->length;
    }
out_unlock:
    ReleaseSRWLockShared(&layout->layout.lock);
    return status;
}

static enum pnfs_status thread_data_server(
    IN pnfs_io_thread *thread,
    OUT pnfs_data_server **server_out)
{
    pnfs_file_device *device = thread->pattern->layout->device;
#ifdef PNFS_THREAD_BY_SERVER
    const uint32_t serverid = thread->id;
#else
    const uint32_t serverid = data_server_index(device, thread->id);
#endif

    if (serverid >= device->servers.count)
        return PNFSERR_INVALID_DS_INDEX;

    *server_out = &device->servers.arr[serverid];
    return PNFS_SUCCESS;
}

static enum pnfs_status pattern_fork(
    IN pnfs_io_pattern *pattern,
    IN pnfs_io_thread_fn thread_fn)
{
    pnfs_io_unit io;
#ifdef PNFS_THREADING
    HANDLE *threads;
    uint32_t num_threads;
#endif
    uint32_t i;
    DWORD status;
    enum pnfs_status pnfsstat = PNFS_SUCCESS;

    if (pattern->count == 0)
        goto out;

#ifdef PNFS_THREADING
    /* create a thread for each unit that has actual io */
    threads = calloc(pattern->count, sizeof(HANDLE));
    if (threads == NULL) {
        pnfsstat = PNFSERR_RESOURCES;
        goto out;
    }

    num_threads = 0;
    for (i = 0; i < pattern->count; i++) {
        if (thread_next_unit(&pattern->threads[i], &io) == PNFS_PENDING) {
            threads[num_threads++] = (HANDLE)_beginthreadex(NULL, 0,
                thread_fn, &pattern->threads[i], 0, NULL);
        }
    }

    if (num_threads) { /* wait on all threads to finish */
        status = WaitForMultipleObjects(num_threads, threads, TRUE, INFINITE);
        if (status == WAIT_OBJECT_0)
            status = NO_ERROR;

        for (i = 0; i < num_threads; i++) {
            /* keep track of the most severe error returned by a thread */
            if (GetExitCodeThread(threads[i], &status))
                pnfsstat = max(pnfsstat, (enum pnfs_status)status);

            CloseHandle(threads[i]);
        }
    }

    free(threads);
#else
    /* process each server that has actual io */
    for (i = 0; i < pattern->count; i++) {
        if (thread_next_unit(&pattern->threads[i], &io) == PNFS_PENDING) {
            /* keep track of the most severe error returned by a thread */
            status = thread_fn(&pattern->threads[i]);
            pnfsstat = max(pnfsstat, (enum pnfs_status)status);
        }
    }
#endif
out:
    return pnfsstat;
}

static uint64_t pattern_bytes_transferred(
    IN pnfs_io_pattern *pattern,
    OUT OPTIONAL enum stable_how4 *stable)
{
    uint64_t lowest_offset = pattern->offset_end;
    uint32_t i;

    if (stable) *stable = DATA_SYNC4;

    for (i = 0; i < pattern->count; i++) {
        if (lowest_offset > pattern->threads[i].offset)
            lowest_offset = pattern->threads[i].offset;
        if (stable && pattern->threads[i].stable == UNSTABLE4)
            *stable = UNSTABLE4;
    }

    return lowest_offset - pattern->offset_start;
}


static enum pnfs_status map_ds_error(
    IN enum nfsstat4 nfsstat,
    IN pnfs_layout *layout)
{
    switch (nfsstat) {
    case NO_ERROR:
        return PNFS_SUCCESS;

    /* 13.11 Layout Revocation and Fencing
     * http://tools.ietf.org/html/rfc5661#section-13.11
     * if we've been fenced, we'll either get ERR_STALE when we PUTFH
     * something in layout.filehandles, or ERR_PNFS_NO_LAYOUT when
     * attempting to READ or WRITE */
    case NFS4ERR_STALE:
    case NFS4ERR_PNFS_NO_LAYOUT:
        dprintf(IOLVL, "data server fencing detected!\n");

        AcquireSRWLockExclusive(&layout->lock);
        /* flag the layout for return once io is finished */
        layout->status |= PNFS_LAYOUT_RECALLED | PNFS_LAYOUT_CHANGED;
        /* reset GRANTED so we know not to try LAYOUTRETURN */
        layout->status &= ~PNFS_LAYOUT_GRANTED;
        ReleaseSRWLockExclusive(&layout->lock);

        /* return CHANGED to prevent any further use of the layout */
        return PNFSERR_LAYOUT_CHANGED;

    default:
        return PNFSERR_IO;
    }
}

static uint32_t WINAPI file_layout_read_thread(void *args)
{
    pnfs_io_unit io;
    pnfs_io_thread *thread = (pnfs_io_thread*)args;
    pnfs_io_pattern *pattern = thread->pattern;
    stateid4 *state = &pattern->stateid;
    pnfs_data_server *server;
    nfs41_client *client;
    uint32_t maxreadsize, bytes_read, total_read;
    enum pnfs_status status;
    enum nfsstat4 nfsstat;
    bool_t eof;

    dprintf(IOLVL, "--> file_layout_read_thread(%u)\n", thread->id);

    /* get the data server for this thread */
    status = thread_data_server(thread, &server);
    if (status) {
        eprintf("thread_data_server() failed with %s\n",
            pnfs_error_string(status));
        goto out;
    }
    /* find or establish a client for this data server */
    status = pnfs_data_server_client(pattern->root,
        server, pattern->default_lease, &client);
    if (status) {
        eprintf("pnfs_data_server_client() failed with %s\n",
            pnfs_error_string(status));
        goto out;
    }

    total_read = 0;
    while ((status = thread_next_unit(thread, &io)) == PNFS_PENDING) {
        maxreadsize = max_read_size(client->session, &io.file->fh);
        if (io.length > maxreadsize)
            io.length = maxreadsize;

        nfsstat = nfs41_read(client->session, io.file, state, io.offset,
            (uint32_t)io.length, io.buffer, &bytes_read, &eof);
        if (nfsstat) {
            eprintf("nfs41_read() failed with %s\n",
                nfs_error_string(nfsstat));
            status = map_ds_error(nfsstat, &pattern->layout->layout);
            break;
        }

        total_read += bytes_read;
        thread->offset += bytes_read;

        if (eof) {
            dprintf(IOLVL, "read thread %u reached eof: offset %llu\n",
                thread->id, thread->offset);
            status = total_read ? PNFS_SUCCESS : PNFS_READ_EOF;
            break;
        }
    }
out:
    dprintf(IOLVL, "<-- file_layout_read_thread(%u) returning %s\n",
        thread->id, pnfs_error_string(status));
    return status;
}

static uint32_t WINAPI file_layout_write_thread(void *args)
{
    pnfs_io_unit io;
    nfs41_write_verf verf;
    pnfs_io_thread *thread = (pnfs_io_thread*)args;
    pnfs_io_pattern *pattern = thread->pattern;
    stateid4 *state = &pattern->stateid;
    pnfs_data_server *server;
    pnfs_file_layout *layout = pattern->layout;
    nfs41_client *client;
    nfs41_path_fh *commit_file;
    const uint64_t offset_start = thread->offset;
    uint64_t commit_len;
    uint32_t maxwritesize, bytes_written, total_written;
    enum pnfs_status status;
    enum nfsstat4 nfsstat;

    dprintf(IOLVL, "--> file_layout_write_thread(%u)\n", thread->id);

    /* get the data server for this thread */
    status = thread_data_server(thread, &server);
    if (status) {
        eprintf("thread_data_server() failed with %s\n",
            pnfs_error_string(status));
        goto out;
    }
    /* find or establish a client for this data server */
    status = pnfs_data_server_client(pattern->root,
        server, pattern->default_lease, &client);
    if (status) {
        eprintf("pnfs_data_server_client() failed with %s\n",
            pnfs_error_string(status));
        goto out;
    }

retry_write:
    thread->offset = offset_start;
    thread->stable = DATA_SYNC4;
    commit_file = NULL;
    total_written = 0;

    while ((status = thread_next_unit(thread, &io)) == PNFS_PENDING) {
        maxwritesize = max_write_size(client->session, &io.file->fh);
        if (io.length > maxwritesize)
            io.length = maxwritesize;

        nfsstat = nfs41_write(client->session, io.file, state, io.buffer,
            (uint32_t)io.length, io.offset, UNSTABLE4, &bytes_written, &verf);
        if (nfsstat) {
            eprintf("nfs41_write() failed with %s\n",
                nfs_error_string(nfsstat));
            status = map_ds_error(nfsstat, &layout->layout);
            break;
        }
        if (!verify_write(&verf, &thread->stable))
            goto retry_write;

        total_written += bytes_written;
        thread->offset += bytes_written;
        commit_file = io.file;
    }

    commit_len = thread->offset - pattern->offset_start;
    /* nothing to commit */
    if (commit_len == 0)
        goto out;
    /* layout changed; redo all io against metadata server */
    if (status == PNFSERR_LAYOUT_CHANGED)
        goto out;
    /* XXX: commit offsets (and possibly fh) are different in dense layouts! */
    if (is_dense(layout))
        goto out;
    /* the data is already in stable storage */
    if (thread->stable != UNSTABLE4)
        goto out;
    /* the metadata server expects us to commit there instead */
    if (should_commit_to_mds(layout))
        goto out;

    dprintf(1, "sending COMMIT to data server for offset=%d and len=%d\n",
        pattern->offset_start, commit_len);
    nfsstat = nfs41_commit(client->session, commit_file,
        pattern->offset_start, (uint32_t)commit_len, 0);

    /* on successful commit, leave pnfs_status unchanged; if the layout
     * was recalled, we still want to return the error */
    if (nfsstat == NFS4_OK)
        thread->stable = DATA_SYNC4;
    else
        status = map_ds_error(nfsstat, &pattern->layout->layout);
out:
    dprintf(IOLVL, "<-- file_layout_write_thread(%u) returning %s\n",
        thread->id, pnfs_error_string(status));
    return status;
}


enum pnfs_status pnfs_read(
    IN nfs41_root *root,
    IN nfs41_session *session,
    IN nfs41_path_fh *file,
    IN stateid4 *stateid,
    IN pnfs_file_layout *layout,
    IN uint64_t offset,
    IN uint64_t length,
    OUT unsigned char *buffer_out,
    OUT ULONG *len_out)
{
    pnfs_io_pattern pattern;
    enum pnfs_status status;

    dprintf(IOLVL, "--> pnfs_read(%llu, %llu)\n", offset, length);

    *len_out = 0;

    status = pattern_init(&pattern, root, file, stateid,
        layout, buffer_out, offset, length, session->lease_time);
    if (status) {
        eprintf("pattern_init() failed with %s\n",
            pnfs_error_string(status));
        goto out;
    }

    status = pattern_fork(&pattern, file_layout_read_thread);
    if (status != PNFS_SUCCESS && status != PNFS_READ_EOF)
        goto out_free_pattern;

    *len_out = (ULONG)pattern_bytes_transferred(&pattern, NULL);

out_free_pattern:
    pattern_free(&pattern);
out:
    dprintf(IOLVL, "<-- pnfs_read() returning %s\n",
        pnfs_error_string(status));
    return status;
}

enum pnfs_status pnfs_write(
    IN nfs41_root *root,
    IN nfs41_session *session,
    IN nfs41_path_fh *file,
    IN stateid4 *stateid,
    IN pnfs_file_layout *layout,
    IN uint64_t offset,
    IN uint64_t length,
    IN unsigned char *buffer,
    OUT ULONG *len_out)
{
    pnfs_io_pattern pattern;
    uint64_t new_last_offset;
    enum stable_how4 stable;
    enum pnfs_status status;
    enum nfsstat4 nfsstat;

    dprintf(IOLVL, "--> pnfs_write(%llu, %llu)\n", offset, length);

    *len_out = 0;

    status = pattern_init(&pattern, root, file, stateid,
        layout, buffer, offset, length, session->lease_time);
    if (status) {
        eprintf("pattern_init() failed with %s\n",
            pnfs_error_string(status));
        goto out;
    }

    status = pattern_fork(&pattern, file_layout_write_thread);
    /* on layout recall, we still attempt to commit what we wrote */
    if (status != PNFS_SUCCESS && status != PNFSERR_LAYOUT_RECALLED)
        goto out_free_pattern;

    *len_out = (ULONG)pattern_bytes_transferred(&pattern, &stable);
    if (*len_out == 0)
        goto out_free_pattern;

    if (stable == UNSTABLE4) {
        /* not all data was committed, so commit to metadata server.
         * pass do_getattr=0 to nfs41_commit() because we'll GETATTR
         * after LAYOUTCOMMIT */
        dprintf(1, "sending COMMIT to meta server for offset=%d and len=%d\n",
            offset, *len_out);
        nfsstat = nfs41_commit(session, pattern.meta_file, offset, *len_out, 0);
        if (nfsstat) {
            dprintf(IOLVL, "nfs41_commit() failed with %s\n",
                nfs_error_string(nfsstat));
            status = PNFSERR_IO;
            goto out_free_pattern;
        }
    }

    /* send LAYOUTCOMMIT */
    new_last_offset = offset + *len_out - 1;

    nfsstat = pnfs_rpc_layoutcommit(session, pattern.meta_file,
        &pattern.layout->layout.state, offset, *len_out,
        &new_last_offset, NULL);
    if (nfsstat) {
        dprintf(IOLVL, "pnfs_rpc_layoutcommit() failed with %s\n",
            nfs_error_string(nfsstat));
        /* acceptable failure? if COMMIT worked, return success */
    }

out_free_pattern:
    pattern_free(&pattern);
out:
    dprintf(IOLVL, "<-- pnfs_write() returning %s\n",
        pnfs_error_string(status));
    return status;
}