fsal_pnfs.h

Go to the documentation of this file.

/*
 *
 * Copyright (C) 2011 Linux Box Corporation
 * Author: Adam C. Emerson
 *         Boaz Harrosh
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3 of
 * the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301 USA
 * ---------------------------------------
 */

#ifndef _FSAL_PNFS_H
#define _FSAL_PNFS_H

/* The next 3 line are mandatory for proper autotools based management */
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif                          /* HAVE_CONFIG_H */

#include <stdint.h>
#include "pnfs_common.h"

#include "nfs4.h"

#ifdef _USE_NFS4_1

#ifdef _USE_LUSTRE
#include "FSAL/FSAL_LUSTRE/fsal_pnfs_types.h"
#endif 

#ifdef _USE_CEPH
#include "FSAL/FSAL_CEPH/fsal_pnfs_types.h"
#endif 

/******************************************************
 *         FSAL MDS function argument structs
 ******************************************************/

struct fsal_layoutget_arg {
     layouttype4 type;
     length4 minlength;
     uint64_t export_id;
     count4 maxcount;
};

struct fsal_layoutget_res {
     struct pnfs_segment segment;
     void *fsal_seg_data;
     fsal_boolean_t return_on_close;
     void *context;
     fsal_boolean_t last_segment;
     fsal_boolean_t signal_available;
};

struct fsal_layoutreturn_arg {
     fsal_boolean_t reclaim;
     layouttype4 lo_type;
     layoutreturn_type4 return_type;
     struct pnfs_segment spec_segment;
     struct pnfs_segment cur_segment;
     void *fsal_seg_data;
     fsal_boolean_t synthetic;
     fsal_boolean_t dispose;
     fsal_boolean_t last_segment;
};

struct fsal_layoutcommit_arg {
     layouttype4 type;
     struct pnfs_segment segment;
     void *fsal_seg_data;
     fsal_boolean_t reclaim;
     fsal_boolean_t new_offset;
     offset4 last_write;
     fsal_boolean_t time_changed;
     fsal_time_t new_time;
};

struct fsal_layoutcommit_res {
     void *context;
     fsal_boolean_t size_supplied;
     length4 new_size;
     fsal_boolean_t commit_done;
};

struct fsal_getdevicelist_arg {
     uint64_t export_id;
     layouttype4 type;
};

struct fsal_getdevicelist_res {
     nfs_cookie4 cookie;
     verifier4 cookieverf;
     fsal_boolean_t eof;
     unsigned int count;
     uint64_t *devids;
};

typedef struct fsal_mdsfunctions__ {
     nfsstat4 (*layoutget)(
          fsal_handle_t *handle,
          fsal_op_context_t *context,
          XDR *loc_body,
          const struct fsal_layoutget_arg *arg,
          struct fsal_layoutget_res *res);

     nfsstat4 (*layoutreturn)(
          fsal_handle_t* handle,
          fsal_op_context_t* context,
          XDR *lrf_body,
          const struct fsal_layoutreturn_arg *arg);


     nfsstat4 (*layoutcommit)(
          fsal_handle_t *handle,
          fsal_op_context_t *context,
          XDR *lou_body,
          const struct fsal_layoutcommit_arg *arg,
          struct fsal_layoutcommit_res *res);

     nfsstat4 (*getdeviceinfo)(
          fsal_op_context_t *context,
          XDR* da_addr_body,
          const layouttype4 type,
          const struct pnfs_deviceid *deviceid);

     nfsstat4 (*getdevicelist)(
          fsal_handle_t *handle,
          fsal_op_context_t *context,
          const struct fsal_getdevicelist_arg *arg,
          struct fsal_getdevicelist_res *res);
} fsal_mdsfunctions_t;

/*
 * XXX This is built on the assumption of a single FSAL.  This
 * XXX variable must be removed and references to it must be updated
 * XXX after the Lieb Rearchitecture.
 */
#ifdef _PNFS_MDS
extern fsal_mdsfunctions_t fsal_mdsfunctions;
#endif /* _PNFS_MDS */

typedef struct fsal_dsfunctions__ {
  nfsstat4 (*DS_read)(
       fsal_handle_t *handle,
       fsal_op_context_t *context,
       const stateid4 *stateid,
       offset4 offset,
       count4 requested_length,
       caddr_t buffer,
       count4 *supplied_length,
       fsal_boolean_t *end_of_file);

     nfsstat4 (*DS_write)(
          fsal_handle_t *handle,
          fsal_op_context_t *context,
          const stateid4 *stateid,
          offset4 offset,
          count4 write_length,
          const caddr_t buffer,
          stable_how4 stability_wanted,
          count4 *written_length,
          verifier4 *writeverf,
          stable_how4 *stability_got);

  nfsstat4 (*DS_commit)(
       fsal_handle_t *handle,
       fsal_op_context_t *context,
       offset4 offset,
       count4 count,
       verifier4 *writeverf);
} fsal_dsfunctions_t;

/*
 * XXX This is built on the assumption of a single FSAL.  This
 * XXX variable must be removed and references to it must be updated
 * XXX after the Lieb Rearchitecture.
 */
#ifdef _PNFS_DS
extern fsal_dsfunctions_t fsal_dsfunctions;
#endif /* _PNFS_DS */

fsal_mdsfunctions_t FSAL_GetMDSFunctions(void);
void FSAL_LoadMDSFunctions(void);

fsal_dsfunctions_t FSAL_GetDSFunctions();
void FSAL_LoadDSFunctions(void);

#endif /* _USE_NFS4_1 */

#endif /* _FSAL_PNFS_H */