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