ms-nfs41-client/daemon/readwrite.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 <stdio.h>

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


const stateid4 special_read_stateid = {0xffffffff, 
    {0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff}};

static int parse_rw(unsigned char *buffer, uint32_t length, nfs41_upcall *upcall)
{
    int status;
    readwrite_upcall_args *args = &upcall->args.rw;

    status = safe_read(&buffer, &length, &args->len, sizeof(args->len));
    if (status) goto out;
    status = safe_read(&buffer, &length, &args->offset, sizeof(args->offset));
    if (status) goto out;
    status = safe_read(&buffer, &length, &args->buffer, sizeof(args->buffer));
    if (status) goto out;
    status = safe_read(&buffer, &length, &args->root, sizeof(args->root));
    if (status) goto out;
    upcall_root_ref(upcall, args->root);
    status = safe_read(&buffer, &length, &args->state, sizeof(args->state));
    if (status) goto out;
    upcall_open_state_ref(upcall, args->state);

    dprintf(1, "parsing %s len=%ld offset=%ld buf=%p root=%p "
        "open_state=0x%p\n", opcode2string(upcall->opcode), args->len,
        args->offset, args->buffer, args->root, args->state);
out:
    return status;
}

/* NFS41_READ */
static int read_from_mds(
    IN nfs41_session *session,
    IN nfs41_path_fh *file,
    IN stateid_arg *stateid,
    IN uint64_t offset,
    IN uint32_t length,
    OUT unsigned char *buffer,
    OUT ULONG *len_out)
{
    int status = 0;
    bool_t eof;
    unsigned char *p = buffer;
    ULONG to_rcv = length, reloffset = 0, len = 0;
    const uint32_t maxreadsize = max_read_size(session, &file->fh);

    if (to_rcv > maxreadsize)
        dprintf(1, "handle_nfs41_read: reading %d in chunks of %d\n",
            to_rcv, maxreadsize);

    while(to_rcv > 0) {
        uint32_t bytes_read = 0, chunk = min(to_rcv, maxreadsize);

        status = nfs41_read(session, file, stateid,
            offset + reloffset, chunk, p, &bytes_read, &eof);
        if (status == NFS4ERR_OPENMODE && !len) {
            stateid->type = STATEID_SPECIAL;
            memcpy(&stateid->stateid, &special_read_stateid, sizeof(stateid4));
            continue;
        } else if (status && !len) {
            status = nfs_to_windows_error(status, ERROR_NET_WRITE_FAULT);
            goto out;
        }

        p += bytes_read;
        to_rcv -= bytes_read;
        len += bytes_read;
        offset += bytes_read;
        if (status) {
            status = NO_ERROR;
            break;
        }
        if (eof) {
            if (!len)
                status = ERROR_HANDLE_EOF;
            break;
        }
    }
out:
    *len_out = len;
    return status;
}

static int read_from_pnfs(
    IN nfs41_root *root,
    IN nfs41_open_state *state,
    IN const stateid_arg *stateid,
    IN uint64_t offset,
    IN uint32_t length,
    OUT unsigned char *buffer,
    OUT ULONG *len_out)
{
    pnfs_layout_state *layout;
    enum pnfs_status pnfsstat;
    int status = NO_ERROR;

    pnfsstat = pnfs_layout_state_open(state->session->client->layouts,
        state->session, state, PNFS_IOMODE_READ, offset, length, &layout);
    if (pnfsstat) {
        status = ERROR_NOT_SUPPORTED;
        goto out;
    }

    pnfsstat = pnfs_read(root, state->session, &state->file,
        stateid, layout, offset, length, buffer, len_out);
    switch (pnfsstat) {
    case PNFS_SUCCESS:
        break;
    case PNFS_READ_EOF:
        status = ERROR_HANDLE_EOF;
        break;
    default:
        status = ERROR_READ_FAULT;
        break;
    }
out:
    return status;
}

static int handle_read(nfs41_upcall *upcall)
{
    readwrite_upcall_args *args = &upcall->args.rw;
    stateid_arg stateid;
    ULONG pnfs_bytes_read = 0;
    int status = NO_ERROR;

    nfs41_lock_stateid_arg(args->state, &stateid);

#ifdef PNFS_ENABLE_READ
    status = read_from_pnfs(args->root, args->state, &stateid,
        args->offset, args->len, args->buffer, &args->out_len);

    if (status == NO_ERROR || status == ERROR_HANDLE_EOF)
        goto out;

    if (args->out_len) {
        pnfs_bytes_read = args->out_len;
        args->out_len = 0;

        args->offset += pnfs_bytes_read;
        args->buffer += pnfs_bytes_read;
        args->len -= pnfs_bytes_read;
    }
#endif

    status = read_from_mds(args->state->session, &args->state->file,
        &stateid, args->offset, args->len, args->buffer, &args->out_len);

    args->out_len += pnfs_bytes_read;
out:
    return status;
}


/* NFS41_WRITE */
static int write_to_mds(
    IN nfs41_session *session,
    IN nfs41_path_fh *file,
    IN stateid_arg *stateid,
    IN uint64_t offset,
    IN uint32_t length,
    IN unsigned char *buffer,
    OUT ULONG *len_out)
{
    nfs41_write_verf verf;
    enum stable_how4 stable, committed;
    unsigned char *p;
    const uint32_t maxwritesize = max_write_size(session, &file->fh);
    uint32_t to_send, reloffset, len;
    int status = 0;

retry_write:
    p = buffer;
    to_send = length;
    reloffset = 0;
    len = 0;
    stable = to_send <= maxwritesize ? DATA_SYNC4 : UNSTABLE4;
    committed = DATA_SYNC4;

    if (to_send > maxwritesize)
        dprintf(1, "handle_nfs41_write: writing %d in chunks of %d\n",
            to_send, maxwritesize);

    while(to_send > 0) {
        uint32_t bytes_written = 0, chunk = min(to_send, maxwritesize);

        status = nfs41_write(session, file, stateid, p, chunk,
            offset + reloffset, stable, &bytes_written, &verf);
        if (status && !len)
            goto out;
        p += bytes_written;
        to_send -= bytes_written;
        len += bytes_written;
        reloffset += bytes_written;
        if (status) {
            status = 0;
            break;
        }
        if (!verify_write(&verf, &committed))
            goto retry_write;
    }
    if (committed == UNSTABLE4) {
        dprintf(1, "sending COMMIT for offset=%d and len=%d\n", offset, len);
        status = nfs41_commit(session, file, offset, len, 1);
    }
out:
    *len_out = len;
    return nfs_to_windows_error(status, ERROR_NET_WRITE_FAULT);
}

static int write_to_pnfs(
    IN nfs41_root *root,
    IN nfs41_open_state *state,
    IN const stateid_arg *stateid,
    IN uint64_t offset,
    IN uint32_t length,
    IN unsigned char *buffer,
    OUT ULONG *len_out)
{
    pnfs_layout_state *layout;
    enum pnfs_status pnfsstat;
    int status = NO_ERROR;

    pnfsstat = pnfs_layout_state_open(state->session->client->layouts,
        state->session, state, PNFS_IOMODE_RW, offset, length, &layout);
    if (pnfsstat) {
        status = ERROR_NOT_SUPPORTED;
        goto out;
    }

    pnfsstat = pnfs_write(root, state->session, &state->file,
        stateid, layout, offset, length, buffer, len_out);
    if (pnfsstat) {
        status = ERROR_WRITE_FAULT;
        goto out;
    }
out:
    return status;
}

static int handle_write(nfs41_upcall *upcall)
{
    readwrite_upcall_args *args = &upcall->args.rw;
    stateid_arg stateid;
    ULONG pnfs_bytes_written = 0;
    int status;

    nfs41_lock_stateid_arg(args->state, &stateid);

#ifdef PNFS_ENABLE_WRITE
    status = write_to_pnfs(args->root, args->state, &stateid,
        args->offset, args->len, args->buffer, &args->out_len);

    if (status == NO_ERROR)
        goto out;

    if (args->out_len) {
        pnfs_bytes_written = args->out_len;
        args->out_len = 0;

        args->offset += pnfs_bytes_written;
        args->buffer += pnfs_bytes_written;
        args->len -= pnfs_bytes_written;
    }
#endif

    status = write_to_mds(args->state->session, &args->state->file,
        &stateid, args->offset, args->len, args->buffer, &args->out_len);

    args->out_len += pnfs_bytes_written;
out:
    return status;
}

static int marshall_rw(unsigned char *buffer, uint32_t *length, nfs41_upcall *upcall)
{
    readwrite_upcall_args *args = &upcall->args.rw;
    return safe_write(&buffer, length, &args->out_len, sizeof(args->out_len));
}


const nfs41_upcall_op nfs41_op_read = {
    parse_rw,
    handle_read,
    marshall_rw
};
const nfs41_upcall_op nfs41_op_write = {
    parse_rw,
    handle_write,
    marshall_rw
};