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, 2013, 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 /* lov_do_div64(a, b) returns a % b, and a = a / b.
  44  * The 32-bit code is LOV-specific due to knowing about stripe limits in
  45  * order to reduce the divisor to a 32-bit number.  If the divisor is
  46  * already a 32-bit value the compiler handles this directly. */
  47 #if BITS_PER_LONG == 64
  48 # define lov_do_div64(n, base) ({                                       \
  49         uint64_t __base = (base);                                       \
  50         uint64_t __rem;                                                 \
  51         __rem = ((uint64_t)(n)) % __base;                               \
  52         (n) = ((uint64_t)(n)) / __base;                                 \
  53         __rem;                                                          \
  54 })
  55 #elif BITS_PER_LONG == 32
  56 # define lov_do_div64(n, base) ({                                       \
  57         uint64_t __rem;                                                 \
  58         if ((sizeof(base) > 4) && (((base) & 0xffffffff00000000ULL) != 0)) {  \
  59                 int __remainder;                                              \
  60                 LASSERTF(!((base) & (LOV_MIN_STRIPE_SIZE - 1)), "64 bit lov " \
  61                          "division %llu / %llu\n", (n), (uint64_t)(base));    \
  62                 __remainder = (n) & (LOV_MIN_STRIPE_SIZE - 1);          \
  63                 (n) >>= LOV_MIN_STRIPE_BITS;                            \
  64                 __rem = do_div(n, (base) >> LOV_MIN_STRIPE_BITS);       \
  65                 __rem <<= LOV_MIN_STRIPE_BITS;                          \
  66                 __rem += __remainder;                                   \
  67         } else {                                                        \
  68                 __rem = do_div(n, base);                                \
  69         }                                                               \
  70         __rem;                                                          \
  71 })
  72 #endif
  73
  74 #define pool_tgt_size(p) ((p)->pool_obds.op_size)
  75 #define pool_tgt_count(p) ((p)->pool_obds.op_count)
  76 #define pool_tgt_array(p) ((p)->pool_obds.op_array)
  77 #define pool_tgt_rw_sem(p) ((p)->pool_obds.op_rw_sem)
  78
  79 struct pool_desc {
  80         char                     pool_name[LOV_MAXPOOLNAME + 1];
  81         struct ost_pool          pool_obds;
  82         atomic_t                 pool_refcount;
  83         struct hlist_node        pool_hash;     /* access by poolname */
  84         struct list_head         pool_list;     /* serial access */
  85         struct proc_dir_entry   *pool_proc_entry;
  86         struct obd_device       *pool_lobd;     /* owner */
  87 };
  88
  89 struct lov_request {
  90         struct obd_info          rq_oi;
  91         struct lov_request_set  *rq_rqset;
  92         struct list_head         rq_link;
  93         int                      rq_idx;        /* index in lov->tgts array */
  94         int                      rq_stripe;     /* stripe number */
  95         int                      rq_complete;
  96         int                      rq_rc;
  97 };
  98
  99 struct lov_request_set {
 100         struct obd_info         *set_oi;
 101         atomic_t                 set_refcount;
 102         struct obd_export       *set_exp;
 103         /* XXX: There is @set_exp already, however obd_statfs gets
 104            obd_device only. */
 105         struct obd_device       *set_obd;
 106         int                      set_count;
 107         atomic_t                 set_completes;
 108         atomic_t                 set_success;
 109         atomic_t                 set_finish_checked;
 110         struct llog_cookie      *set_cookies;
 111         struct list_head         set_list;
 112         wait_queue_head_t        set_waitq;
 113 };
 114
 115 extern struct kmem_cache *lov_oinfo_slab;
 116
 117 void lov_finish_set(struct lov_request_set *set);
 118
 119 static inline void lov_put_reqset(struct lov_request_set *set)
 120 {
 121         if (atomic_dec_and_test(&set->set_refcount))
 122                 lov_finish_set(set);
 123 }
 124
 125 #define lov_uuid2str(lv, index) \
 126         (char *)((lv)->lov_tgts[index]->ltd_uuid.uuid)
 127
 128 /* lov_merge.c */
 129 void lov_merge_attrs(struct obdo *tgt, struct obdo *src, obd_valid valid,
 130                      struct lov_stripe_md *lsm, int stripeno, int *set);
 131 int lov_merge_lvb_kms(struct lov_stripe_md *lsm,
 132                       struct ost_lvb *lvb, __u64 *kms_place);
 133
 134 /* lov_offset.c */
 135 obd_size lov_stripe_size(struct lov_stripe_md *lsm, obd_size ost_size,
 136                          int stripeno);
 137 int lov_stripe_offset(struct lov_stripe_md *lsm, obd_off lov_off,
 138                       int stripeno, obd_off *obd_off);
 139 obd_off lov_size_to_stripe(struct lov_stripe_md *lsm, obd_off file_size,
 140                            int stripeno);
 141 int lov_stripe_intersects(struct lov_stripe_md *lsm, int stripeno,
 142                           obd_off start, obd_off end,
 143                           obd_off *obd_start, obd_off *obd_end);
 144 int lov_stripe_number(struct lov_stripe_md *lsm, obd_off lov_off);
 145 pgoff_t lov_stripe_pgoff(struct lov_stripe_md *lsm, pgoff_t stripe_index,
 146                          int stripe);
 147
 148 /* lov_request.c */
 149 void lov_set_add_req(struct lov_request *req, struct lov_request_set *set);
 150 int lov_set_finished(struct lov_request_set *set, int idempotent);
 151 void lov_update_set(struct lov_request_set *set,
 152                     struct lov_request *req, int rc);
 153 int lov_update_common_set(struct lov_request_set *set,
 154                           struct lov_request *req, int rc);
 155 int lov_check_and_wait_active(struct lov_obd *lov, int ost_idx);
 156 int lov_prep_getattr_set(struct obd_export *exp, struct obd_info *oinfo,
 157                          struct lov_request_set **reqset);
 158 int lov_fini_getattr_set(struct lov_request_set *set);
 159 int lov_prep_destroy_set(struct obd_export *exp, struct obd_info *oinfo,
 160                          struct obdo *src_oa, struct lov_stripe_md *lsm,
 161                          struct obd_trans_info *oti,
 162                          struct lov_request_set **reqset);
 163 int lov_fini_destroy_set(struct lov_request_set *set);
 164 int lov_prep_setattr_set(struct obd_export *exp, struct obd_info *oinfo,
 165                          struct obd_trans_info *oti,
 166                          struct lov_request_set **reqset);
 167 int lov_update_setattr_set(struct lov_request_set *set,
 168                            struct lov_request *req, int rc);
 169 int lov_fini_setattr_set(struct lov_request_set *set);
 170 int lov_prep_statfs_set(struct obd_device *obd, struct obd_info *oinfo,
 171                         struct lov_request_set **reqset);
 172 void lov_update_statfs(struct obd_statfs *osfs, struct obd_statfs *lov_sfs,
 173                        int success);
 174 int lov_fini_statfs(struct obd_device *obd, struct obd_statfs *osfs,
 175                     int success);
 176 int lov_fini_statfs_set(struct lov_request_set *set);
 177 int lov_statfs_interpret(struct ptlrpc_request_set *rqset, void *data, int rc);
 178
 179 /* lov_obd.c */
 180 void lov_stripe_lock(struct lov_stripe_md *md);
 181 void lov_stripe_unlock(struct lov_stripe_md *md);
 182 void lov_fix_desc(struct lov_desc *desc);
 183 void lov_fix_desc_stripe_size(__u64 *val);
 184 void lov_fix_desc_stripe_count(__u32 *val);
 185 void lov_fix_desc_pattern(__u32 *val);
 186 void lov_fix_desc_qos_maxage(__u32 *val);
 187 __u16 lov_get_stripecnt(struct lov_obd *lov, __u32 magic, __u16 stripe_count);
 188 int lov_connect_obd(struct obd_device *obd, __u32 index, int activate,
 189                     struct obd_connect_data *data);
 190 int lov_setup(struct obd_device *obd, struct lustre_cfg *lcfg);
 191 int lov_process_config_base(struct obd_device *obd, struct lustre_cfg *lcfg,
 192                             __u32 *indexp, int *genp);
 193 int lov_del_target(struct obd_device *obd, __u32 index,
 194                    struct obd_uuid *uuidp, int gen);
 195
 196 /* lov_pack.c */
 197 int lov_packmd(struct obd_export *exp, struct lov_mds_md **lmm,
 198                struct lov_stripe_md *lsm);
 199 int lov_unpackmd(struct obd_export *exp, struct lov_stripe_md **lsmp,
 200                  struct lov_mds_md *lmm, int lmm_bytes);
 201 int lov_getstripe(struct obd_export *exp,
 202                   struct lov_stripe_md *lsm, struct lov_user_md *lump);
 203 int lov_alloc_memmd(struct lov_stripe_md **lsmp, __u16 stripe_count,
 204                     int pattern, int magic);
 205 int lov_free_memmd(struct lov_stripe_md **lsmp);
 206
 207 void lov_dump_lmm_v1(int level, struct lov_mds_md_v1 *lmm);
 208 void lov_dump_lmm_v3(int level, struct lov_mds_md_v3 *lmm);
 209 void lov_dump_lmm_common(int level, void *lmmp);
 210 void lov_dump_lmm(int level, void *lmm);
 211
 212 /* lov_ea.c */
 213 struct lov_stripe_md *lsm_alloc_plain(__u16 stripe_count, int *size);
 214 void lsm_free_plain(struct lov_stripe_md *lsm);
 215 void dump_lsm(unsigned int level, const struct lov_stripe_md *lsm);
 216
 217 /* lproc_lov.c */
 218 extern struct file_operations lov_proc_target_fops;
 219 #ifdef LPROCFS
 220 extern struct lprocfs_seq_vars lprocfs_lov_obd_vars[];
 221 #endif
 222
 223 /* lov_cl.c */
 224 extern struct lu_device_type lov_device_type;
 225
 226 /* pools */
 227 extern cfs_hash_ops_t pool_hash_operations;
 228 /* ost_pool methods */
 229 int lov_ost_pool_init(struct ost_pool *op, unsigned int count);
 230 int lov_ost_pool_extend(struct ost_pool *op, unsigned int min_count);
 231 int lov_ost_pool_add(struct ost_pool *op, __u32 idx, unsigned int min_count);
 232 int lov_ost_pool_remove(struct ost_pool *op, __u32 idx);
 233 int lov_ost_pool_free(struct ost_pool *op);
 234
 235 /* high level pool methods */
 236 int lov_pool_new(struct obd_device *obd, char *poolname);
 237 int lov_pool_del(struct obd_device *obd, char *poolname);
 238 int lov_pool_add(struct obd_device *obd, char *poolname, char *ostname);
 239 int lov_pool_remove(struct obd_device *obd, char *poolname, char *ostname);
 240 void lov_dump_pool(int level, struct pool_desc *pool);
 241 void lov_pool_putref(struct pool_desc *pool);
 242
 243 static inline struct lov_stripe_md *lsm_addref(struct lov_stripe_md *lsm)
 244 {
 245         LASSERT(atomic_read(&lsm->lsm_refc) > 0);
 246         atomic_inc(&lsm->lsm_refc);
 247         return lsm;
 248 }
 249
 250 static inline bool lov_oinfo_is_dummy(const struct lov_oinfo *loi)
 251 {
 252         if (unlikely(loi->loi_oi.oi.oi_id == 0 &&
 253                      loi->loi_oi.oi.oi_seq == 0 &&
 254                      loi->loi_ost_idx == 0 &&
 255                      loi->loi_ost_gen == 0))
 256                 return true;
 257
 258         return false;
 259 }
 260
 261 #endif