lustre/llite/pcc.h

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2017, DDN Storage Corporation.
  24  */
  25 /*
  26  *
  27  * Persistent Client Cache
  28  *
  29  * Author: Li Xi <lixi@ddn.com>
  30  */
  31
  32 #ifndef LLITE_PCC_H
  33 #define LLITE_PCC_H
  34
  35 #include <linux/types.h>
  36 #include <linux/fs.h>
  37 #include <linux/seq_file.h>
  38 #include <linux/mm.h>
  39 #include <uapi/linux/lustre/lustre_user.h>
  40
  41 extern struct kmem_cache *pcc_inode_slab;
  42
  43 #define LPROCFS_WR_PCC_MAX_CMD 4096
  44
  45 struct pcc_dataset {
  46         __u32                   pccd_id;         /* Archive ID */
  47         __u32                   pccd_projid;     /* Project ID */
  48         char                    pccd_pathname[PATH_MAX]; /* full path */
  49         struct path             pccd_path;       /* Root path */
  50         struct list_head        pccd_linkage;  /* Linked to pccs_datasets */
  51         atomic_t                pccd_refcount; /* reference count */
  52 };
  53
  54 struct pcc_super {
  55         spinlock_t              pccs_lock;      /* Protect pccs_datasets */
  56         struct list_head        pccs_datasets;  /* List of datasets */
  57 };
  58
  59 struct pcc_inode {
  60         struct ll_inode_info    *pcci_lli;
  61         /* Cache path on local file system */
  62         struct path              pcci_path;
  63         /*
  64          * If reference count is 0, then the cache is not inited, if 1, then
  65          * no one is using it.
  66          */
  67         atomic_t                 pcci_refcount;
  68         /* Whether readonly or readwrite PCC */
  69         enum lu_pcc_type         pcci_type;
  70         /* Whether the inode attr is cached locally */
  71         bool                     pcci_attr_valid;
  72         /* Layout generation */
  73         __u32                    pcci_layout_gen;
  74         /*
  75          * How many IOs are on going on this cached object. Layout can be
  76          * changed only if there is no active IO.
  77          */
  78         atomic_t                 pcci_active_ios;
  79         /* Waitq - wait for PCC I/O completion. */
  80         wait_queue_head_t        pcci_waitq;
  81 };
  82
  83 struct pcc_file {
  84         /* Opened cache file */
  85         struct file             *pccf_file;
  86         /* Whether readonly or readwrite PCC */
  87         enum lu_pcc_type         pccf_type;
  88 };
  89
  90 enum pcc_cmd_type {
  91         PCC_ADD_DATASET = 0,
  92         PCC_DEL_DATASET,
  93         PCC_CLEAR_ALL,
  94 };
  95
  96 struct pcc_cmd {
  97         enum pcc_cmd_type                        pccc_cmd;
  98         char                                    *pccc_pathname;
  99         union {
 100                 struct pcc_cmd_add {
 101                         __u32                    pccc_id;
 102                         __u32                    pccc_projid;
 103                 } pccc_add;
 104                 struct pcc_cmd_del {
 105                         __u32                    pccc_pad;
 106                 } pccc_del;
 107         } u;
 108 };
 109
 110 void pcc_super_init(struct pcc_super *super);
 111 void pcc_super_fini(struct pcc_super *super);
 112 int pcc_cmd_handle(char *buffer, unsigned long count,
 113                    struct pcc_super *super);
 114 int pcc_super_dump(struct pcc_super *super, struct seq_file *m);
 115 int pcc_readwrite_attach(struct file *file, struct inode *inode,
 116                          __u32 arch_id);
 117 int pcc_readwrite_attach_fini(struct file *file, struct inode *inode,
 118                               __u32 gen, bool lease_broken, int rc,
 119                               bool attached);
 120 int pcc_ioctl_detach(struct inode *inode);
 121 int pcc_ioctl_state(struct file *file, struct inode *inode,
 122                     struct lu_pcc_state *state);
 123 void pcc_file_init(struct pcc_file *pccf);
 124 int pcc_file_open(struct inode *inode, struct file *file);
 125 void pcc_file_release(struct inode *inode, struct file *file);
 126 ssize_t pcc_file_read_iter(struct kiocb *iocb, struct iov_iter *iter,
 127                            bool *cached);
 128 ssize_t pcc_file_write_iter(struct kiocb *iocb, struct iov_iter *iter,
 129                             bool *cached);
 130 int pcc_inode_getattr(struct inode *inode, bool *cached);
 131 int pcc_inode_setattr(struct inode *inode, struct iattr *attr, bool *cached);
 132 ssize_t pcc_file_splice_read(struct file *in_file, loff_t *ppos,
 133                              struct pipe_inode_info *pipe, size_t count,
 134                              unsigned int flags, bool *cached);
 135 int pcc_fsync(struct file *file, loff_t start, loff_t end,
 136               int datasync, bool *cached);
 137 int pcc_file_mmap(struct file *file, struct vm_area_struct *vma, bool *cached);
 138 void pcc_vm_open(struct vm_area_struct *vma);
 139 void pcc_vm_close(struct vm_area_struct *vma);
 140 int pcc_fault(struct vm_area_struct *mva, struct vm_fault *vmf, bool *cached);
 141 int pcc_page_mkwrite(struct vm_area_struct *vma, struct vm_fault *vmf,
 142                      bool *cached);
 143 int pcc_inode_create(struct pcc_dataset *dataset, struct lu_fid *fid,
 144                      struct dentry **pcc_dentry);
 145 int pcc_inode_create_fini(struct pcc_dataset *dataset, struct inode *inode,
 146                           struct dentry *pcc_dentry);
 147 struct pcc_dataset *pcc_dataset_get(struct pcc_super *super, __u32 projid,
 148                                     __u32 archive_id);
 149 void pcc_dataset_put(struct pcc_dataset *dataset);
 150 void pcc_inode_free(struct inode *inode);
 151 void pcc_layout_invalidate(struct inode *inode);
 152
 153 #endif /* LLITE_PCC_H */