drivers/staging/lustre/lustre/lov/lov_internal.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) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2011, 2015, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  */
  32
  33 #ifndef LOV_INTERNAL_H
  34 #define LOV_INTERNAL_H
  35
  36 #include <obd_class.h>
  37 #include <uapi/linux/lustre/lustre_idl.h>
  38
  39 /*
  40  * If we are unable to get the maximum object size from the OST in
  41  * ocd_maxbytes using OBD_CONNECT_MAXBYTES, then we fall back to using
  42  * the old maximum object size from ext3.
  43  */
  44 #define LUSTRE_EXT3_STRIPE_MAXBYTES 0x1fffffff000ULL
  45
  46 struct lov_stripe_md {
  47         atomic_t        lsm_refc;
  48         spinlock_t      lsm_lock;
  49         pid_t           lsm_lock_owner; /* debugging */
  50
  51         /*
  52          * maximum possible file size, might change as OSTs status changes,
  53          * e.g. disconnected, deactivated
  54          */
  55         loff_t          lsm_maxbytes;
  56         struct ost_id   lsm_oi;
  57         u32             lsm_magic;
  58         u32             lsm_stripe_size;
  59         u32             lsm_pattern; /* RAID0, RAID1, released, ... */
  60         u16             lsm_stripe_count;
  61         u16             lsm_layout_gen;
  62         char            lsm_pool_name[LOV_MAXPOOLNAME + 1];
  63         struct lov_oinfo        *lsm_oinfo[0];
  64 };
  65
  66 static inline bool lsm_is_released(struct lov_stripe_md *lsm)
  67 {
  68         return !!(lsm->lsm_pattern & LOV_PATTERN_F_RELEASED);
  69 }
  70
  71 static inline bool lsm_has_objects(struct lov_stripe_md *lsm)
  72 {
  73         if (!lsm)
  74                 return false;
  75
  76         if (lsm_is_released(lsm))
  77                 return false;
  78
  79         return true;
  80 }
  81
  82 struct lsm_operations {
  83         void (*lsm_free)(struct lov_stripe_md *);
  84         void (*lsm_stripe_by_index)(struct lov_stripe_md *, int *, loff_t *,
  85                                     loff_t *);
  86         void (*lsm_stripe_by_offset)(struct lov_stripe_md *, int *, loff_t *,
  87                                      loff_t *);
  88         int (*lsm_lmm_verify)(struct lov_mds_md *lmm, int lmm_bytes,
  89                               u16 *stripe_count);
  90         int (*lsm_unpackmd)(struct lov_obd *lov, struct lov_stripe_md *lsm,
  91                             struct lov_mds_md *lmm);
  92 };
  93
  94 extern const struct lsm_operations lsm_v1_ops;
  95 extern const struct lsm_operations lsm_v3_ops;
  96
  97 static inline const struct lsm_operations *lsm_op_find(int magic)
  98 {
  99         switch (magic) {
 100         case LOV_MAGIC_V1:
 101                 return &lsm_v1_ops;
 102         case LOV_MAGIC_V3:
 103                 return &lsm_v3_ops;
 104         default:
 105                 CERROR("unrecognized lsm_magic %08x\n", magic);
 106                 return NULL;
 107         }
 108 }
 109
 110 /* lov_do_div64(a, b) returns a % b, and a = a / b.
 111  * The 32-bit code is LOV-specific due to knowing about stripe limits in
 112  * order to reduce the divisor to a 32-bit number.  If the divisor is
 113  * already a 32-bit value the compiler handles this directly.
 114  */
 115 #if BITS_PER_LONG == 64
 116 # define lov_do_div64(n, base) ({                                       \
 117         uint64_t __base = (base);                                       \
 118         uint64_t __rem;                                                 \
 119         __rem = ((uint64_t)(n)) % __base;                               \
 120         (n) = ((uint64_t)(n)) / __base;                                 \
 121         __rem;                                                          \
 122 })
 123 #elif BITS_PER_LONG == 32
 124 # define lov_do_div64(n, base) ({                                       \
 125         uint64_t __rem;                                                 \
 126         if ((sizeof(base) > 4) && (((base) & 0xffffffff00000000ULL) != 0)) {  \
 127                 int __remainder;                                              \
 128                 LASSERTF(!((base) & (LOV_MIN_STRIPE_SIZE - 1)), "64 bit lov " \
 129                          "division %llu / %llu\n", (n), (uint64_t)(base));    \
 130                 __remainder = (n) & (LOV_MIN_STRIPE_SIZE - 1);          \
 131                 (n) >>= LOV_MIN_STRIPE_BITS;                            \
 132                 __rem = do_div(n, (base) >> LOV_MIN_STRIPE_BITS);       \
 133                 __rem <<= LOV_MIN_STRIPE_BITS;                          \
 134                 __rem += __remainder;                                   \
 135         } else {                                                        \
 136                 __rem = do_div(n, base);                                \
 137         }                                                               \
 138         __rem;                                                          \
 139 })
 140 #endif
 141
 142 #define pool_tgt_size(p)        ((p)->pool_obds.op_size)
 143 #define pool_tgt_count(p)       ((p)->pool_obds.op_count)
 144 #define pool_tgt_array(p)       ((p)->pool_obds.op_array)
 145 #define pool_tgt_rw_sem(p)      ((p)->pool_obds.op_rw_sem)
 146
 147 struct pool_desc {
 148         char                     pool_name[LOV_MAXPOOLNAME + 1];
 149         struct ost_pool          pool_obds;
 150         atomic_t                 pool_refcount;
 151         struct hlist_node        pool_hash;             /* access by poolname */
 152         struct list_head         pool_list;             /* serial access */
 153         struct dentry           *pool_debugfs_entry;    /* file in debugfs */
 154         struct obd_device       *pool_lobd;             /* owner */
 155 };
 156
 157 struct lov_request {
 158         struct obd_info   rq_oi;
 159         struct lov_request_set  *rq_rqset;
 160
 161         struct list_head               rq_link;
 162
 163         int                   rq_idx;   /* index in lov->tgts array */
 164 };
 165
 166 struct lov_request_set {
 167         struct obd_info                 *set_oi;
 168         struct obd_device               *set_obd;
 169         int                             set_count;
 170         atomic_t                        set_completes;
 171         atomic_t                        set_success;
 172         struct list_head                        set_list;
 173 };
 174
 175 extern struct kmem_cache *lov_oinfo_slab;
 176
 177 extern struct lu_kmem_descr lov_caches[];
 178
 179 #define lov_uuid2str(lv, index) \
 180         (char *)((lv)->lov_tgts[index]->ltd_uuid.uuid)
 181
 182 /* lov_merge.c */
 183 int lov_merge_lvb_kms(struct lov_stripe_md *lsm,
 184                       struct ost_lvb *lvb, __u64 *kms_place);
 185
 186 /* lov_offset.c */
 187 u64 lov_stripe_size(struct lov_stripe_md *lsm, u64 ost_size, int stripeno);
 188 int lov_stripe_offset(struct lov_stripe_md *lsm, u64 lov_off,
 189                       int stripeno, u64 *u64);
 190 u64 lov_size_to_stripe(struct lov_stripe_md *lsm, u64 file_size, int stripeno);
 191 int lov_stripe_intersects(struct lov_stripe_md *lsm, int stripeno,
 192                           u64 start, u64 end,
 193                           u64 *obd_start, u64 *obd_end);
 194 int lov_stripe_number(struct lov_stripe_md *lsm, u64 lov_off);
 195 pgoff_t lov_stripe_pgoff(struct lov_stripe_md *lsm, pgoff_t stripe_index,
 196                          int stripe);
 197
 198 /* lov_request.c */
 199 int lov_prep_statfs_set(struct obd_device *obd, struct obd_info *oinfo,
 200                         struct lov_request_set **reqset);
 201 int lov_fini_statfs_set(struct lov_request_set *set);
 202
 203 /* lov_obd.c */
 204 void lov_stripe_lock(struct lov_stripe_md *md);
 205 void lov_stripe_unlock(struct lov_stripe_md *md);
 206 void lov_fix_desc(struct lov_desc *desc);
 207 void lov_fix_desc_stripe_size(__u64 *val);
 208 void lov_fix_desc_stripe_count(__u32 *val);
 209 void lov_fix_desc_pattern(__u32 *val);
 210 void lov_fix_desc_qos_maxage(__u32 *val);
 211 __u16 lov_get_stripecnt(struct lov_obd *lov, __u32 magic, __u16 stripe_count);
 212 int lov_connect_obd(struct obd_device *obd, __u32 index, int activate,
 213                     struct obd_connect_data *data);
 214 int lov_setup(struct obd_device *obd, struct lustre_cfg *lcfg);
 215 int lov_process_config_base(struct obd_device *obd, struct lustre_cfg *lcfg,
 216                             __u32 *indexp, int *genp);
 217 int lov_del_target(struct obd_device *obd, __u32 index,
 218                    struct obd_uuid *uuidp, int gen);
 219
 220 /* lov_pack.c */
 221 ssize_t lov_lsm_pack(const struct lov_stripe_md *lsm, void *buf,
 222                      size_t buf_size);
 223 struct lov_stripe_md *lov_unpackmd(struct lov_obd *lov, struct lov_mds_md *lmm,
 224                                    size_t lmm_size);
 225 int lov_free_memmd(struct lov_stripe_md **lsmp);
 226
 227 void lov_dump_lmm_v1(int level, struct lov_mds_md_v1 *lmm);
 228 void lov_dump_lmm_v3(int level, struct lov_mds_md_v3 *lmm);
 229 void lov_dump_lmm_common(int level, void *lmmp);
 230
 231 /* lov_ea.c */
 232 struct lov_stripe_md *lsm_alloc_plain(u16 stripe_count);
 233 void lsm_free_plain(struct lov_stripe_md *lsm);
 234 void dump_lsm(unsigned int level, const struct lov_stripe_md *lsm);
 235
 236 /* lproc_lov.c */
 237 extern const struct file_operations lov_proc_target_fops;
 238 void lprocfs_lov_init_vars(struct lprocfs_static_vars *lvars);
 239
 240 /* lov_cl.c */
 241 extern struct lu_device_type lov_device_type;
 242
 243 /* pools */
 244 extern struct cfs_hash_ops pool_hash_operations;
 245 /* ost_pool methods */
 246 int lov_ost_pool_init(struct ost_pool *op, unsigned int count);
 247 int lov_ost_pool_extend(struct ost_pool *op, unsigned int min_count);
 248 int lov_ost_pool_add(struct ost_pool *op, __u32 idx, unsigned int min_count);
 249 int lov_ost_pool_remove(struct ost_pool *op, __u32 idx);
 250 int lov_ost_pool_free(struct ost_pool *op);
 251
 252 /* high level pool methods */
 253 int lov_pool_new(struct obd_device *obd, char *poolname);
 254 int lov_pool_del(struct obd_device *obd, char *poolname);
 255 int lov_pool_add(struct obd_device *obd, char *poolname, char *ostname);
 256 int lov_pool_remove(struct obd_device *obd, char *poolname, char *ostname);
 257 void lov_pool_putref(struct pool_desc *pool);
 258
 259 static inline struct lov_stripe_md *lsm_addref(struct lov_stripe_md *lsm)
 260 {
 261         LASSERT(atomic_read(&lsm->lsm_refc) > 0);
 262         atomic_inc(&lsm->lsm_refc);
 263         return lsm;
 264 }
 265
 266 static inline bool lov_oinfo_is_dummy(const struct lov_oinfo *loi)
 267 {
 268         if (unlikely(loi->loi_oi.oi.oi_id == 0 &&
 269                      loi->loi_oi.oi.oi_seq == 0 &&
 270                      loi->loi_ost_idx == 0 &&
 271                      loi->loi_ost_gen == 0))
 272                 return true;
 273
 274         return false;
 275 }
 276
 277 static inline struct obd_device *lov2obd(const struct lov_obd *lov)
 278 {
 279         return container_of0(lov, struct obd_device, u.lov);
 280 }
 281
 282 #endif