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