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