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.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2011, 2014, Intel Corporation.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  */
  36
  37 #ifndef LOV_INTERNAL_H
  38 #define LOV_INTERNAL_H
  39
  40 #include <obd_class.h>
  41 #include <lustre/lustre_user.h>
  42
  43 /* If we are unable to get the maximum object size from the OST in
  44  * ocd_maxbytes using OBD_CONNECT_MAXBYTES, then we fall back to using
  45  * the old maximum object size from ext3. */
  46 #define LUSTRE_EXT3_STRIPE_MAXBYTES 0x1fffffff000ULL
  47
  48 struct lov_stripe_md {
  49         atomic_t        lsm_refc;
  50         spinlock_t      lsm_lock;
  51         pid_t           lsm_lock_owner; /* debugging */
  52
  53         /* maximum possible file size, might change as OSTs status changes,
  54          * e.g. disconnected, deactivated */
  55         loff_t          lsm_maxbytes;
  56         struct ost_id   lsm_oi;
  57         u32             lsm_magic;
  58         u32             lsm_stripe_size;
  59         u32             lsm_pattern; /* RAID0, RAID1, released, ... */
  60         u16             lsm_stripe_count;
  61         u16             lsm_layout_gen;
  62         char            lsm_pool_name[LOV_MAXPOOLNAME + 1];
  63         struct lov_oinfo        *lsm_oinfo[0];
  64 };
  65
  66 static inline bool lsm_is_released(struct lov_stripe_md *lsm)
  67 {
  68         return !!(lsm->lsm_pattern & LOV_PATTERN_F_RELEASED);
  69 }
  70
  71 static inline bool lsm_has_objects(struct lov_stripe_md *lsm)
  72 {
  73         if (lsm == NULL)
  74                 return false;
  75
  76         if (lsm_is_released(lsm))
  77                 return false;
  78
  79         return true;
  80 }
  81
  82 struct lsm_operations {
  83         void (*lsm_free)(struct lov_stripe_md *);
  84         void (*lsm_stripe_by_index)(struct lov_stripe_md *, int *, loff_t *,
  85                                     loff_t *);
  86         void (*lsm_stripe_by_offset)(struct lov_stripe_md *, int *, loff_t *,
  87                                      loff_t *);
  88         int (*lsm_lmm_verify)(struct lov_mds_md *lmm, int lmm_bytes,
  89                               u16 *stripe_count);
  90         int (*lsm_unpackmd)(struct lov_obd *lov, struct lov_stripe_md *lsm,
  91                             struct lov_mds_md *lmm);
  92 };
  93
  94 extern const struct lsm_operations lsm_v1_ops;
  95 extern const struct lsm_operations lsm_v3_ops;
  96 static inline const struct lsm_operations *lsm_op_find(int magic)
  97 {
  98         switch (magic) {
  99         case LOV_MAGIC_V1:
 100                 return &lsm_v1_ops;
 101         case LOV_MAGIC_V3:
 102                 return &lsm_v3_ops;
 103         default:
 104                 CERROR("unrecognized lsm_magic %08x\n", magic);
 105                 return NULL;
 106         }
 107 }
 108
 109 /* lov_do_div64(a, b) returns a % b, and a = a / b.
 110  * The 32-bit code is LOV-specific due to knowing about stripe limits in
 111  * order to reduce the divisor to a 32-bit number.  If the divisor is
 112  * already a 32-bit value the compiler handles this directly. */
 113 #if BITS_PER_LONG == 64
 114 # define lov_do_div64(n, base) ({                                       \
 115         uint64_t __base = (base);                                       \
 116         uint64_t __rem;                                                 \
 117         __rem = ((uint64_t)(n)) % __base;                               \
 118         (n) = ((uint64_t)(n)) / __base;                                 \
 119         __rem;                                                          \
 120 })
 121 #elif BITS_PER_LONG == 32
 122 # define lov_do_div64(n, base) ({                                       \
 123         uint64_t __rem;                                                 \
 124         if ((sizeof(base) > 4) && (((base) & 0xffffffff00000000ULL) != 0)) {  \
 125                 int __remainder;                                              \
 126                 LASSERTF(!((base) & (LOV_MIN_STRIPE_SIZE - 1)), "64 bit lov " \
 127                          "division %llu / %llu\n", (n), (uint64_t)(base));    \
 128                 __remainder = (n) & (LOV_MIN_STRIPE_SIZE - 1);          \
 129                 (n) >>= LOV_MIN_STRIPE_BITS;                            \
 130                 __rem = do_div(n, (base) >> LOV_MIN_STRIPE_BITS);       \
 131                 __rem <<= LOV_MIN_STRIPE_BITS;                          \
 132                 __rem += __remainder;                                   \
 133         } else {                                                        \
 134                 __rem = do_div(n, base);                                \
 135         }                                                               \
 136         __rem;                                                          \
 137 })
 138 #endif
 139
 140 #define pool_tgt_size(p) ((p)->pool_obds.op_size)
 141 #define pool_tgt_count(p) ((p)->pool_obds.op_count)
 142 #define pool_tgt_array(p) ((p)->pool_obds.op_array)
 143 #define pool_tgt_rw_sem(p) ((p)->pool_obds.op_rw_sem)
 144
 145 struct pool_desc {
 146         char                     pool_name[LOV_MAXPOOLNAME + 1];
 147         struct ost_pool          pool_obds;
 148         atomic_t                 pool_refcount;
 149         struct hlist_node        pool_hash;     /* access by poolname */
 150         struct list_head         pool_list;     /* serial access */
 151         struct proc_dir_entry   *pool_proc_entry;
 152         struct obd_device       *pool_lobd;     /* owner */
 153 };
 154
 155 struct lov_request {
 156         struct obd_info          rq_oi;
 157         struct lov_request_set  *rq_rqset;
 158         struct list_head         rq_link;
 159         int                      rq_idx;        /* index in lov->tgts array */
 160         int                      rq_stripe;     /* stripe number */
 161         int                      rq_complete;
 162         int                      rq_rc;
 163 };
 164
 165 struct lov_request_set {
 166         struct obd_info         *set_oi;
 167         atomic_t                 set_refcount;
 168         struct obd_export       *set_exp;
 169         /* XXX: There is @set_exp already, however obd_statfs gets
 170            obd_device only. */
 171         struct obd_device       *set_obd;
 172         int                      set_count;
 173         atomic_t                 set_completes;
 174         atomic_t                 set_success;
 175         atomic_t                 set_finish_checked;
 176         struct list_head         set_list;
 177         wait_queue_head_t        set_waitq;
 178 };
 179
 180 extern struct kmem_cache *lov_oinfo_slab;
 181
 182 extern struct lu_kmem_descr lov_caches[];
 183
 184 void lov_finish_set(struct lov_request_set *set);
 185
 186 static inline void lov_put_reqset(struct lov_request_set *set)
 187 {
 188         if (atomic_dec_and_test(&set->set_refcount))
 189                 lov_finish_set(set);
 190 }
 191
 192 #define lov_uuid2str(lv, index) \
 193         (char *)((lv)->lov_tgts[index]->ltd_uuid.uuid)
 194
 195 /* lov_merge.c */
 196 int lov_merge_lvb_kms(struct lov_stripe_md *lsm,
 197                       struct ost_lvb *lvb, __u64 *kms_place);
 198
 199 /* lov_offset.c */
 200 u64 lov_stripe_size(struct lov_stripe_md *lsm, u64 ost_size, int stripeno);
 201 int lov_stripe_offset(struct lov_stripe_md *lsm, loff_t lov_off, int stripeno,
 202                       loff_t *obd_off);
 203 loff_t lov_size_to_stripe(struct lov_stripe_md *lsm, u64 file_size,
 204                           int stripeno);
 205 int lov_stripe_intersects(struct lov_stripe_md *lsm, int stripeno,
 206                           loff_t start, loff_t end,
 207                           loff_t *obd_start, loff_t *obd_end);
 208 int lov_stripe_number(struct lov_stripe_md *lsm, loff_t lov_off);
 209 pgoff_t lov_stripe_pgoff(struct lov_stripe_md *lsm, pgoff_t stripe_index,
 210                          int stripe);
 211
 212 /* lov_request.c */
 213 void lov_set_add_req(struct lov_request *req, struct lov_request_set *set);
 214 int lov_set_finished(struct lov_request_set *set, int idempotent);
 215 void lov_update_set(struct lov_request_set *set,
 216                     struct lov_request *req, int rc);
 217 int lov_check_and_wait_active(struct lov_obd *lov, int ost_idx);
 218 int lov_prep_statfs_set(struct obd_device *obd, struct obd_info *oinfo,
 219                         struct lov_request_set **reqset);
 220 void lov_update_statfs(struct obd_statfs *osfs, struct obd_statfs *lov_sfs,
 221                        int success);
 222 int lov_fini_statfs(struct obd_device *obd, struct obd_statfs *osfs,
 223                     int success);
 224 int lov_fini_statfs_set(struct lov_request_set *set);
 225 int lov_statfs_interpret(struct ptlrpc_request_set *rqset, void *data, int rc);
 226
 227 /* lov_obd.c */
 228 void lov_stripe_lock(struct lov_stripe_md *md);
 229 void lov_stripe_unlock(struct lov_stripe_md *md);
 230 void lov_fix_desc(struct lov_desc *desc);
 231 void lov_fix_desc_stripe_size(__u64 *val);
 232 void lov_fix_desc_stripe_count(__u32 *val);
 233 void lov_fix_desc_pattern(__u32 *val);
 234 void lov_fix_desc_qos_maxage(__u32 *val);
 235 __u16 lov_get_stripecnt(struct lov_obd *lov, __u32 magic, __u16 stripe_count);
 236 int lov_connect_obd(struct obd_device *obd, __u32 index, int activate,
 237                     struct obd_connect_data *data);
 238 int lov_setup(struct obd_device *obd, struct lustre_cfg *lcfg);
 239 int lov_process_config_base(struct obd_device *obd, struct lustre_cfg *lcfg,
 240                             __u32 *indexp, int *genp);
 241 int lov_del_target(struct obd_device *obd, __u32 index,
 242                    struct obd_uuid *uuidp, int gen);
 243
 244 /* lov_pack.c */
 245 ssize_t lov_lsm_pack(const struct lov_stripe_md *lsm, void *buf,
 246                      size_t buf_size);
 247 struct lov_stripe_md *lov_unpackmd(struct lov_obd *lov, struct lov_mds_md *lmm,
 248                                    size_t lmm_size);
 249 int lov_free_memmd(struct lov_stripe_md **lsmp);
 250
 251 void lov_dump_lmm_v1(int level, struct lov_mds_md_v1 *lmm);
 252 void lov_dump_lmm_v3(int level, struct lov_mds_md_v3 *lmm);
 253 void lov_dump_lmm_common(int level, void *lmmp);
 254 void lov_dump_lmm(int level, void *lmm);
 255
 256 /* lov_ea.c */
 257 struct lov_stripe_md *lsm_alloc_plain(u16 stripe_count);
 258 void lsm_free_plain(struct lov_stripe_md *lsm);
 259 void dump_lsm(unsigned int level, const struct lov_stripe_md *lsm);
 260
 261 /* lproc_lov.c */
 262 extern struct file_operations lov_proc_target_fops;
 263 #ifdef CONFIG_PROC_FS
 264 extern struct lprocfs_vars lprocfs_lov_obd_vars[];
 265 #endif
 266
 267 /* lov_cl.c */
 268 extern struct lu_device_type lov_device_type;
 269
 270 /* pools */
 271 extern struct cfs_hash_ops pool_hash_operations;
 272 /* ost_pool methods */
 273 int lov_ost_pool_init(struct ost_pool *op, unsigned int count);
 274 int lov_ost_pool_extend(struct ost_pool *op, unsigned int min_count);
 275 int lov_ost_pool_add(struct ost_pool *op, __u32 idx, unsigned int min_count);
 276 int lov_ost_pool_remove(struct ost_pool *op, __u32 idx);
 277 int lov_ost_pool_free(struct ost_pool *op);
 278
 279 /* high level pool methods */
 280 int lov_pool_new(struct obd_device *obd, char *poolname);
 281 int lov_pool_del(struct obd_device *obd, char *poolname);
 282 int lov_pool_add(struct obd_device *obd, char *poolname, char *ostname);
 283 int lov_pool_remove(struct obd_device *obd, char *poolname, char *ostname);
 284 void lov_dump_pool(int level, struct pool_desc *pool);
 285
 286 static inline struct lov_stripe_md *lsm_addref(struct lov_stripe_md *lsm)
 287 {
 288         LASSERT(atomic_read(&lsm->lsm_refc) > 0);
 289         atomic_inc(&lsm->lsm_refc);
 290         return lsm;
 291 }
 292
 293 static inline bool lov_oinfo_is_dummy(const struct lov_oinfo *loi)
 294 {
 295         if (unlikely(loi->loi_oi.oi.oi_id == 0 &&
 296                      loi->loi_oi.oi.oi_seq == 0 &&
 297                      loi->loi_ost_idx == 0 &&
 298                      loi->loi_ost_gen == 0))
 299                 return true;
 300
 301         return false;
 302 }
 303
 304 static inline struct obd_device *lov2obd(const struct lov_obd *lov)
 305 {
 306         return container_of0(lov, struct obd_device, u.lov);
 307 }
 308
 309 #endif