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