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