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