fs/nfs/objlayout/objlayout.h

   1 /*
   2  *  Data types and function declerations for interfacing with the
   3  *  pNFS standard object layout driver.
   4  *
   5  *  Copyright (C) 2007 Panasas Inc. [year of first publication]
   6  *  All rights reserved.
   7  *
   8  *  Benny Halevy <bhalevy@panasas.com>
   9  *  Boaz Harrosh <bharrosh@panasas.com>
  10  *
  11  *  This program is free software; you can redistribute it and/or modify
  12  *  it under the terms of the GNU General Public License version 2
  13  *  See the file COPYING included with this distribution for more details.
  14  *
  15  *  Redistribution and use in source and binary forms, with or without
  16  *  modification, are permitted provided that the following conditions
  17  *  are met:
  18  *
  19  *  1. Redistributions of source code must retain the above copyright
  20  *     notice, this list of conditions and the following disclaimer.
  21  *  2. Redistributions in binary form must reproduce the above copyright
  22  *     notice, this list of conditions and the following disclaimer in the
  23  *     documentation and/or other materials provided with the distribution.
  24  *  3. Neither the name of the Panasas company nor the names of its
  25  *     contributors may be used to endorse or promote products derived
  26  *     from this software without specific prior written permission.
  27  *
  28  *  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
  29  *  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  30  *  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  31  *  DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  32  *  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  33  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  34  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  35  *  BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  36  *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  37  *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  38  *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  39  */
  40
  41 #ifndef _OBJLAYOUT_H
  42 #define _OBJLAYOUT_H
  43
  44 #include <linux/nfs_fs.h>
  45 #include <linux/pnfs_osd_xdr.h>
  46 #include "../pnfs.h"
  47
  48 /*
  49  * per-inode layout
  50  */
  51 struct objlayout {
  52         struct pnfs_layout_hdr pnfs_layout;
  53
  54          /* for layout_return */
  55         spinlock_t lock;
  56         struct list_head err_list;
  57 };
  58
  59 static inline struct objlayout *
  60 OBJLAYOUT(struct pnfs_layout_hdr *lo)
  61 {
  62         return container_of(lo, struct objlayout, pnfs_layout);
  63 }
  64
  65 /*
  66  * per-I/O operation state
  67  * embedded in objects provider io_state data structure
  68  */
  69 struct objlayout_io_state {
  70         struct pnfs_layout_segment *lseg;
  71
  72         struct page **pages;
  73         unsigned pgbase;
  74         unsigned nr_pages;
  75         unsigned long count;
  76         loff_t offset;
  77         bool sync;
  78
  79         void *rpcdata;
  80         int status;             /* res */
  81         int eof;                /* res */
  82         int committed;          /* res */
  83
  84         /* Error reporting (layout_return) */
  85         struct list_head err_list;
  86         unsigned num_comps;
  87         /* Pointer to array of error descriptors of size num_comps.
  88          * It should contain as many entries as devices in the osd_layout
  89          * that participate in the I/O. It is up to the io_engine to allocate
  90          * needed space and set num_comps.
  91          */
  92         struct pnfs_osd_ioerr *ioerrs;
  93 };
  94
  95 /*
  96  * Raid engine I/O API
  97  */
  98 extern int objio_alloc_lseg(struct pnfs_layout_segment **outp,
  99         struct pnfs_layout_hdr *pnfslay,
 100         struct pnfs_layout_range *range,
 101         struct xdr_stream *xdr,
 102         gfp_t gfp_flags);
 103 extern void objio_free_lseg(struct pnfs_layout_segment *lseg);
 104
 105 extern int objio_alloc_io_state(
 106         struct pnfs_layout_segment *lseg,
 107         struct objlayout_io_state **outp,
 108         gfp_t gfp_flags);
 109 extern void objio_free_io_state(struct objlayout_io_state *state);
 110
 111 extern ssize_t objio_read_pagelist(struct objlayout_io_state *ol_state);
 112 extern ssize_t objio_write_pagelist(struct objlayout_io_state *ol_state,
 113                                     bool stable);
 114
 115 /*
 116  * callback API
 117  */
 118 extern void objlayout_io_set_result(struct objlayout_io_state *state,
 119                         unsigned index, struct pnfs_osd_objid *pooid,
 120                         int osd_error, u64 offset, u64 length, bool is_write);
 121
 122 extern void objlayout_read_done(struct objlayout_io_state *state,
 123                                 ssize_t status, bool sync);
 124 extern void objlayout_write_done(struct objlayout_io_state *state,
 125                                  ssize_t status, bool sync);
 126
 127 extern int objlayout_get_deviceinfo(struct pnfs_layout_hdr *pnfslay,
 128         struct nfs4_deviceid *d_id, struct pnfs_osd_deviceaddr **deviceaddr,
 129         gfp_t gfp_flags);
 130 extern void objlayout_put_deviceinfo(struct pnfs_osd_deviceaddr *deviceaddr);
 131
 132 /*
 133  * exported generic objects function vectors
 134  */
 135
 136 extern struct pnfs_layout_hdr *objlayout_alloc_layout_hdr(struct inode *, gfp_t gfp_flags);
 137 extern void objlayout_free_layout_hdr(struct pnfs_layout_hdr *);
 138
 139 extern struct pnfs_layout_segment *objlayout_alloc_lseg(
 140         struct pnfs_layout_hdr *,
 141         struct nfs4_layoutget_res *,
 142         gfp_t gfp_flags);
 143 extern void objlayout_free_lseg(struct pnfs_layout_segment *);
 144
 145 extern enum pnfs_try_status objlayout_read_pagelist(
 146         struct nfs_read_data *);
 147
 148 extern enum pnfs_try_status objlayout_write_pagelist(
 149         struct nfs_write_data *,
 150         int how);
 151
 152 extern void objlayout_encode_layoutreturn(
 153         struct pnfs_layout_hdr *,
 154         struct xdr_stream *,
 155         const struct nfs4_layoutreturn_args *);
 156
 157 #endif /* _OBJLAYOUT_H */