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, 2015, 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 {
  45         atomic_t        lsm_refc;
  46         spinlock_t      lsm_lock;
  47         pid_t           lsm_lock_owner; /* debugging */
  48
  49         /* maximum possible file size, might change as OSTs status changes,
  50          * e.g. disconnected, deactivated */
  51         loff_t          lsm_maxbytes;
  52         struct ost_id   lsm_oi;
  53         u32             lsm_magic;
  54         u32             lsm_stripe_size;
  55         u32             lsm_pattern; /* RAID0, RAID1, released, ... */
  56         u16             lsm_stripe_count;
  57         u16             lsm_layout_gen;
  58         char            lsm_pool_name[LOV_MAXPOOLNAME + 1];
  59         struct lov_oinfo        *lsm_oinfo[0];
  60 };
  61
  62 static inline bool lsm_is_released(struct lov_stripe_md *lsm)
  63 {
  64         return !!(lsm->lsm_pattern & LOV_PATTERN_F_RELEASED);
  65 }
  66
  67 static inline bool lsm_has_objects(struct lov_stripe_md *lsm)
  68 {
  69         if (lsm == NULL)
  70                 return false;
  71
  72         if (lsm_is_released(lsm))
  73                 return false;
  74
  75         return true;
  76 }
  77
  78 struct lsm_operations {
  79         void (*lsm_free)(struct lov_stripe_md *);
  80         void (*lsm_stripe_by_index)(struct lov_stripe_md *, int *, loff_t *,
  81                                     loff_t *);
  82         void (*lsm_stripe_by_offset)(struct lov_stripe_md *, int *, loff_t *,
  83                                      loff_t *);
  84         int (*lsm_lmm_verify)(struct lov_mds_md *lmm, int lmm_bytes,
  85                               u16 *stripe_count);
  86         int (*lsm_unpackmd)(struct lov_obd *lov, struct lov_stripe_md *lsm,
  87                             struct lov_mds_md *lmm);
  88 };
  89
  90 extern const struct lsm_operations lsm_v1_ops;
  91 extern const struct lsm_operations lsm_v3_ops;
  92 static inline const struct lsm_operations *lsm_op_find(int magic)
  93 {
  94         switch (magic) {
  95         case LOV_MAGIC_V1:
  96                 return &lsm_v1_ops;
  97         case LOV_MAGIC_V3:
  98                 return &lsm_v3_ops;
  99         default:
 100                 CERROR("unrecognized lsm_magic %08x\n", magic);
 101                 return NULL;
 102         }
 103 }
 104
 105 /* lov_do_div64(a, b) returns a % b, and a = a / b.
 106  * The 32-bit code is LOV-specific due to knowing about stripe limits in
 107  * order to reduce the divisor to a 32-bit number.  If the divisor is
 108  * already a 32-bit value the compiler handles this directly. */
 109 #if BITS_PER_LONG == 64
 110 # define lov_do_div64(n, base) ({                                       \
 111         uint64_t __base = (base);                                       \
 112         uint64_t __rem;                                                 \
 113         __rem = ((uint64_t)(n)) % __base;                               \
 114         (n) = ((uint64_t)(n)) / __base;                                 \
 115         __rem;                                                          \
 116 })
 117 #elif BITS_PER_LONG == 32
 118 # define lov_do_div64(n, base) ({                                       \
 119         uint64_t __rem;                                                 \
 120         if ((sizeof(base) > 4) && (((base) & 0xffffffff00000000ULL) != 0)) {  \
 121                 int __remainder;                                              \
 122                 LASSERTF(!((base) & (LOV_MIN_STRIPE_SIZE - 1)), "64 bit lov " \
 123                          "division %llu / %llu\n", (n), (uint64_t)(base));    \
 124                 __remainder = (n) & (LOV_MIN_STRIPE_SIZE - 1);          \
 125                 (n) >>= LOV_MIN_STRIPE_BITS;                            \
 126                 __rem = do_div(n, (base) >> LOV_MIN_STRIPE_BITS);       \
 127                 __rem <<= LOV_MIN_STRIPE_BITS;                          \
 128                 __rem += __remainder;                                   \
 129         } else {                                                        \
 130                 __rem = do_div(n, base);                                \
 131         }                                                               \
 132         __rem;                                                          \
 133 })
 134 #endif
 135
 136 #define pool_tgt_size(p) ((p)->pool_obds.op_size)
 137 #define pool_tgt_count(p) ((p)->pool_obds.op_count)
 138 #define pool_tgt_array(p) ((p)->pool_obds.op_array)
 139 #define pool_tgt_rw_sem(p) ((p)->pool_obds.op_rw_sem)
 140
 141 struct pool_desc {
 142         char                     pool_name[LOV_MAXPOOLNAME + 1];
 143         struct ost_pool          pool_obds;
 144         atomic_t                 pool_refcount;
 145         struct hlist_node        pool_hash;     /* access by poolname */
 146         struct list_head         pool_list;     /* serial access */
 147         struct proc_dir_entry   *pool_proc_entry;
 148         struct obd_device       *pool_lobd;     /* owner */
 149 };
 150
 151 struct lov_request {
 152         struct obd_info          rq_oi;
 153         struct lov_request_set  *rq_rqset;
 154         struct list_head         rq_link;
 155         int                      rq_idx;        /* index in lov->tgts array */
 156 };
 157
 158 struct lov_request_set {
 159         struct obd_info         *set_oi;
 160         struct obd_device       *set_obd;
 161         int                      set_count;
 162         atomic_t                 set_completes;
 163         atomic_t                 set_success;
 164         struct list_head         set_list;
 165 };
 166
 167 extern struct kmem_cache *lov_oinfo_slab;
 168
 169 extern struct lu_kmem_descr lov_caches[];
 170
 171 #define lov_uuid2str(lv, index) \
 172         (char *)((lv)->lov_tgts[index]->ltd_uuid.uuid)
 173
 174 /* lov_merge.c */
 175 int lov_merge_lvb_kms(struct lov_stripe_md *lsm,
 176                       struct ost_lvb *lvb, __u64 *kms_place);
 177
 178 /* lov_offset.c */
 179 u64 lov_stripe_size(struct lov_stripe_md *lsm, u64 ost_size, int stripeno);
 180 int lov_stripe_offset(struct lov_stripe_md *lsm, loff_t lov_off, int stripeno,
 181                       loff_t *obd_off);
 182 loff_t lov_size_to_stripe(struct lov_stripe_md *lsm, u64 file_size,
 183                           int stripeno);
 184 int lov_stripe_intersects(struct lov_stripe_md *lsm, int stripeno,
 185                           loff_t start, loff_t end,
 186                           loff_t *obd_start, loff_t *obd_end);
 187 int lov_stripe_number(struct lov_stripe_md *lsm, loff_t lov_off);
 188 pgoff_t lov_stripe_pgoff(struct lov_stripe_md *lsm, pgoff_t stripe_index,
 189                          int stripe);
 190
 191 /* lov_request.c */
 192 int lov_prep_statfs_set(struct obd_device *obd, struct obd_info *oinfo,
 193                         struct lov_request_set **reqset);
 194 int lov_fini_statfs_set(struct lov_request_set *set);
 195
 196 /* lov_obd.c */
 197 void lov_stripe_lock(struct lov_stripe_md *md);
 198 void lov_stripe_unlock(struct lov_stripe_md *md);
 199 void lov_fix_desc(struct lov_desc *desc);
 200 void lov_fix_desc_stripe_size(__u64 *val);
 201 void lov_fix_desc_stripe_count(__u32 *val);
 202 void lov_fix_desc_pattern(__u32 *val);
 203 void lov_fix_desc_qos_maxage(__u32 *val);
 204 __u16 lov_get_stripecnt(struct lov_obd *lov, __u32 magic, __u16 stripe_count);
 205 int lov_connect_obd(struct obd_device *obd, __u32 index, int activate,
 206                     struct obd_connect_data *data);
 207 int lov_setup(struct obd_device *obd, struct lustre_cfg *lcfg);
 208 int lov_process_config_base(struct obd_device *obd, struct lustre_cfg *lcfg,
 209                             __u32 *indexp, int *genp);
 210 int lov_del_target(struct obd_device *obd, __u32 index,
 211                    struct obd_uuid *uuidp, int gen);
 212
 213 /* lov_pack.c */
 214 ssize_t lov_lsm_pack(const struct lov_stripe_md *lsm, void *buf,
 215                      size_t buf_size);
 216 struct lov_stripe_md *lov_unpackmd(struct lov_obd *lov, struct lov_mds_md *lmm,
 217                                    size_t lmm_size);
 218 int lov_free_memmd(struct lov_stripe_md **lsmp);
 219
 220 void lov_dump_lmm_v1(int level, struct lov_mds_md_v1 *lmm);
 221 void lov_dump_lmm_v3(int level, struct lov_mds_md_v3 *lmm);
 222 void lov_dump_lmm_common(int level, void *lmmp);
 223 void lov_dump_lmm(int level, void *lmm);
 224
 225 /* lov_ea.c */
 226 struct lov_stripe_md *lsm_alloc_plain(u16 stripe_count);
 227 void lsm_free_plain(struct lov_stripe_md *lsm);
 228 void dump_lsm(unsigned int level, const struct lov_stripe_md *lsm);
 229
 230 /* lproc_lov.c */
 231 extern struct file_operations lov_proc_target_fops;
 232 #ifdef CONFIG_PROC_FS
 233 extern struct lprocfs_vars lprocfs_lov_obd_vars[];
 234 #endif
 235
 236 /* lov_cl.c */
 237 extern struct lu_device_type lov_device_type;
 238
 239 /* pools */
 240 extern struct cfs_hash_ops pool_hash_operations;
 241 /* ost_pool methods */
 242 int lov_ost_pool_init(struct ost_pool *op, unsigned int count);
 243 int lov_ost_pool_extend(struct ost_pool *op, unsigned int min_count);
 244 int lov_ost_pool_add(struct ost_pool *op, __u32 idx, unsigned int min_count);
 245 int lov_ost_pool_remove(struct ost_pool *op, __u32 idx);
 246 int lov_ost_pool_free(struct ost_pool *op);
 247
 248 /* high level pool methods */
 249 int lov_pool_new(struct obd_device *obd, char *poolname);
 250 int lov_pool_del(struct obd_device *obd, char *poolname);
 251 int lov_pool_add(struct obd_device *obd, char *poolname, char *ostname);
 252 int lov_pool_remove(struct obd_device *obd, char *poolname, char *ostname);
 253 void lov_dump_pool(int level, struct pool_desc *pool);
 254
 255 static inline struct lov_stripe_md *lsm_addref(struct lov_stripe_md *lsm)
 256 {
 257         LASSERT(atomic_read(&lsm->lsm_refc) > 0);
 258         atomic_inc(&lsm->lsm_refc);
 259         return lsm;
 260 }
 261
 262 static inline bool lov_oinfo_is_dummy(const struct lov_oinfo *loi)
 263 {
 264         if (unlikely(loi->loi_oi.oi.oi_id == 0 &&
 265                      loi->loi_oi.oi.oi_seq == 0 &&
 266                      loi->loi_ost_idx == 0 &&
 267                      loi->loi_ost_gen == 0))
 268                 return true;
 269
 270         return false;
 271 }
 272
 273 static inline struct obd_device *lov2obd(const struct lov_obd *lov)
 274 {
 275         return container_of0(lov, struct obd_device, u.lov);
 276 }
 277
 278 #endif