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