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 static inline bool lov_supported_comp_magic(unsigned int magic)
 188 {
 189         return magic == LOV_MAGIC_V1 || magic == LOV_MAGIC_V3 ||
 190                magic == LOV_MAGIC_FOREIGN;
 191 }
 192
 193 #define pool_tgt_count(p) ((p)->pool_obds.op_count)
 194 #define pool_tgt_array(p) ((p)->pool_obds.op_array)
 195 #define pool_tgt_rw_sem(p) ((p)->pool_obds.op_rw_sem)
 196
 197 struct lov_pool_desc {
 198         char                     pool_name[LOV_MAXPOOLNAME + 1];
 199         struct lu_tgt_pool       pool_obds;
 200         atomic_t                 pool_refcount;
 201         struct rhash_head        pool_hash;     /* access by poolname */
 202         struct list_head         pool_list;     /* serial access */
 203         struct rcu_head          pool_rcu;
 204         struct proc_dir_entry   *pool_proc_entry;
 205         struct obd_device       *pool_lobd;     /* owner */
 206 };
 207
 208 int lov_pool_hash_init(struct rhashtable *tbl);
 209 void lov_pool_hash_destroy(struct rhashtable *tbl);
 210
 211 struct lov_request {
 212         struct obd_info          rq_oi;
 213         struct lov_request_set  *rq_rqset;
 214         struct list_head         rq_link;
 215         int                      rq_idx;        /* index in lov->tgts array */
 216 };
 217
 218 struct lov_request_set {
 219         struct obd_info         *set_oi;
 220         struct obd_device       *set_obd;
 221         int                      set_count;
 222         atomic_t                 set_completes;
 223         atomic_t                 set_success;
 224         struct list_head         set_list;
 225 };
 226
 227 extern struct kmem_cache *lov_oinfo_slab;
 228
 229 extern struct lu_kmem_descr lov_caches[];
 230
 231 #define lov_uuid2str(lv, index) \
 232         (char *)((lv)->lov_tgts[index]->ltd_uuid.uuid)
 233
 234 /* lov_merge.c */
 235 int lov_merge_lvb_kms(struct lov_stripe_md *lsm, int index,
 236                       struct cl_attr *attr);
 237
 238 /* lov_offset.c */
 239 u64 stripe_width(struct lov_stripe_md *lsm, unsigned int index);
 240 u64 lov_stripe_size(struct lov_stripe_md *lsm, int index,
 241                     u64 ost_size, int stripeno);
 242 int lov_stripe_offset(struct lov_stripe_md *lsm, int index, loff_t lov_off,
 243                       int stripeno, loff_t *obd_off);
 244 loff_t lov_size_to_stripe(struct lov_stripe_md *lsm, int index, u64 file_size,
 245                           int stripeno);
 246 int lov_stripe_intersects(struct lov_stripe_md *lsm, int index, int stripeno,
 247                           struct lu_extent *ext, u64 *obd_start, u64 *obd_end);
 248 int lov_stripe_number(struct lov_stripe_md *lsm, int index, u64 lov_off);
 249 pgoff_t lov_stripe_pgoff(struct lov_stripe_md *lsm, int index,
 250                          pgoff_t stripe_index, int stripe);
 251
 252 /* lov_request.c */
 253 int lov_prep_statfs_set(struct obd_device *obd, struct obd_info *oinfo,
 254                         struct lov_request_set **reqset);
 255 int lov_fini_statfs_set(struct lov_request_set *set);
 256
 257 /* lov_obd.c */
 258 void lov_tgts_getref(struct obd_device *obd);
 259 void lov_tgts_putref(struct obd_device *obd);
 260 void lov_stripe_lock(struct lov_stripe_md *md);
 261 void lov_stripe_unlock(struct lov_stripe_md *md);
 262 void lov_fix_desc(struct lov_desc *desc);
 263 void lov_fix_desc_stripe_size(__u64 *val);
 264 void lov_fix_desc_stripe_count(__u32 *val);
 265 void lov_fix_desc_pattern(__u32 *val);
 266 void lov_fix_desc_qos_maxage(__u32 *val);
 267 __u16 lov_get_stripe_count(struct lov_obd *lov, __u32 magic,
 268                            __u16 stripe_count);
 269 int lov_connect_obd(struct obd_device *obd, u32 index, int activate,
 270                     struct obd_connect_data *data);
 271 int lov_setup(struct obd_device *obd, struct lustre_cfg *lcfg);
 272 int lov_process_config_base(struct obd_device *obd, struct lustre_cfg *lcfg,
 273                             u32 *indexp, int *genp);
 274 int lov_del_target(struct obd_device *obd, u32 index,
 275                    struct obd_uuid *uuidp, int gen);
 276
 277 /* lov_pack.c */
 278 ssize_t lov_lsm_pack(const struct lov_stripe_md *lsm, void *buf,
 279                      size_t buf_size);
 280 struct lov_stripe_md *lov_unpackmd(struct lov_obd *lov, void *buf,
 281                                    size_t buf_size);
 282 int lov_free_memmd(struct lov_stripe_md **lsmp);
 283
 284 void lov_dump_lmm_v1(int level, struct lov_mds_md_v1 *lmm);
 285 void lov_dump_lmm_common(int level, void *lmmp);
 286
 287 /* lov_ea.c */
 288 void lsm_free_plain(struct lov_stripe_md *lsm);
 289 void dump_lsm(unsigned int level, const struct lov_stripe_md *lsm);
 290
 291 /* lproc_lov.c */
 292 int lov_tunables_init(struct obd_device *obd);
 293
 294 /* lov_cl.c */
 295 extern struct lu_device_type lov_device_type;
 296
 297 #define LOV_MDC_TGT_MAX 256
 298
 299 /* high level pool methods */
 300 int lov_pool_new(struct obd_device *obd, char *poolname);
 301 int lov_pool_del(struct obd_device *obd, char *poolname);
 302 int lov_pool_add(struct obd_device *obd, char *poolname, char *ostname);
 303 int lov_pool_remove(struct obd_device *obd, char *poolname, char *ostname);
 304
 305 static inline struct lov_stripe_md *lsm_addref(struct lov_stripe_md *lsm)
 306 {
 307         LASSERT(atomic_read(&lsm->lsm_refc) > 0);
 308         atomic_inc(&lsm->lsm_refc);
 309         return lsm;
 310 }
 311
 312 static inline bool lov_oinfo_is_dummy(const struct lov_oinfo *loi)
 313 {
 314         if (unlikely(loi->loi_oi.oi.oi_id == 0 &&
 315                      loi->loi_oi.oi.oi_seq == 0 &&
 316                      loi->loi_ost_idx == 0 &&
 317                      loi->loi_ost_gen == 0))
 318                 return true;
 319
 320         return false;
 321 }
 322
 323 static inline struct obd_device *lov2obd(const struct lov_obd *lov)
 324 {
 325         return container_of_safe(lov, struct obd_device, u.lov);
 326 }
 327
 328 static inline void lov_lsm2layout(struct lov_stripe_md *lsm,
 329                                   struct lov_stripe_md_entry *lsme,
 330                                   struct ost_layout *ol)
 331 {
 332         ol->ol_stripe_size = lsme->lsme_stripe_size;
 333         ol->ol_stripe_count = lsme->lsme_stripe_count;
 334         if (lsm->lsm_magic == LOV_MAGIC_COMP_V1) {
 335                 ol->ol_comp_start = lsme->lsme_extent.e_start;
 336                 ol->ol_comp_end = lsme->lsme_extent.e_end;
 337                 ol->ol_comp_id = lsme->lsme_id;
 338         } else {
 339                 ol->ol_comp_start = 0;
 340                 ol->ol_comp_end = 0;
 341                 ol->ol_comp_id = 0;
 342         }
 343 }
 344
 345 struct lov_pool_desc *lov_pool_find(struct obd_device *obd, char *poolname);
 346 void lov_pool_putref(struct lov_pool_desc *pool);
 347 #endif