kernel/drivers/staging/lustre/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, 2012, 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 "../include/obd_class.h"
  41 #include "../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 struct lov_lock_handles {
  75         struct portals_handle   llh_handle;
  76         atomic_t            llh_refcount;
  77         int                  llh_stripe_count;
  78         struct lustre_handle    llh_handles[0];
  79 };
  80
  81 struct lov_request {
  82         struct obd_info   rq_oi;
  83         struct lov_request_set  *rq_rqset;
  84
  85         struct list_head               rq_link;
  86
  87         int                   rq_idx;   /* index in lov->tgts array */
  88         int                   rq_stripe;     /* stripe number */
  89         int                   rq_complete;
  90         int                   rq_rc;
  91         int                   rq_buflen;     /* length of sub_md */
  92
  93         u32                   rq_oabufs;
  94         u32                   rq_pgaidx;
  95 };
  96
  97 struct lov_request_set {
  98         struct ldlm_enqueue_info        *set_ei;
  99         struct obd_info                 *set_oi;
 100         atomic_t                        set_refcount;
 101         struct obd_export               *set_exp;
 102         /* XXX: There is @set_exp already, however obd_statfs gets obd_device
 103            only. */
 104         struct obd_device               *set_obd;
 105         int                             set_count;
 106         atomic_t                        set_completes;
 107         atomic_t                        set_success;
 108         atomic_t                        set_finish_checked;
 109         struct llog_cookie              *set_cookies;
 110         int                             set_cookie_sent;
 111         struct obd_trans_info           *set_oti;
 112         u32                             set_oabufs;
 113         struct brw_page                 *set_pga;
 114         struct lov_lock_handles         *set_lockh;
 115         struct list_head                        set_list;
 116         wait_queue_head_t                       set_waitq;
 117         spinlock_t                      set_lock;
 118 };
 119
 120 extern struct kmem_cache *lov_oinfo_slab;
 121
 122 extern struct lu_kmem_descr lov_caches[];
 123
 124 void lov_finish_set(struct lov_request_set *set);
 125
 126 static inline void lov_get_reqset(struct lov_request_set *set)
 127 {
 128         LASSERT(set != NULL);
 129         LASSERT(atomic_read(&set->set_refcount) > 0);
 130         atomic_inc(&set->set_refcount);
 131 }
 132
 133 static inline void lov_put_reqset(struct lov_request_set *set)
 134 {
 135         if (atomic_dec_and_test(&set->set_refcount))
 136                 lov_finish_set(set);
 137 }
 138
 139 static inline struct lov_lock_handles *
 140 lov_handle2llh(struct lustre_handle *handle)
 141 {
 142         LASSERT(handle != NULL);
 143         return class_handle2object(handle->cookie);
 144 }
 145
 146 static inline void lov_llh_put(struct lov_lock_handles *llh)
 147 {
 148         CDEBUG(D_INFO, "PUTting llh %p : new refcount %d\n", llh,
 149                atomic_read(&llh->llh_refcount) - 1);
 150         LASSERT(atomic_read(&llh->llh_refcount) > 0 &&
 151                 atomic_read(&llh->llh_refcount) < 0x5a5a);
 152         if (atomic_dec_and_test(&llh->llh_refcount)) {
 153                 class_handle_unhash(&llh->llh_handle);
 154                 /* The structure may be held by other threads because RCU.
 155                  *   -jxiong */
 156                 if (atomic_read(&llh->llh_refcount))
 157                         return;
 158
 159                 OBD_FREE_RCU(llh, sizeof(*llh) +
 160                              sizeof(*llh->llh_handles) * llh->llh_stripe_count,
 161                              &llh->llh_handle);
 162         }
 163 }
 164
 165 #define lov_uuid2str(lv, index) \
 166         (char *)((lv)->lov_tgts[index]->ltd_uuid.uuid)
 167
 168 /* lov_merge.c */
 169 void lov_merge_attrs(struct obdo *tgt, struct obdo *src, u64 valid,
 170                      struct lov_stripe_md *lsm, int stripeno, int *set);
 171 int lov_adjust_kms(struct obd_export *exp, struct lov_stripe_md *lsm,
 172                    u64 size, int shrink);
 173 int lov_merge_lvb_kms(struct lov_stripe_md *lsm,
 174                       struct ost_lvb *lvb, __u64 *kms_place);
 175
 176 /* lov_offset.c */
 177 u64 lov_stripe_size(struct lov_stripe_md *lsm, u64 ost_size,
 178                          int stripeno);
 179 int lov_stripe_offset(struct lov_stripe_md *lsm, u64 lov_off,
 180                       int stripeno, u64 *u64);
 181 u64 lov_size_to_stripe(struct lov_stripe_md *lsm, u64 file_size,
 182                            int stripeno);
 183 int lov_stripe_intersects(struct lov_stripe_md *lsm, int stripeno,
 184                           u64 start, u64 end,
 185                           u64 *obd_start, u64 *obd_end);
 186 int lov_stripe_number(struct lov_stripe_md *lsm, u64 lov_off);
 187
 188 /* lov_qos.c */
 189 #define LOV_USES_ASSIGNED_STRIPE        0
 190 #define LOV_USES_DEFAULT_STRIPE  1
 191 int qos_add_tgt(struct obd_device *obd, __u32 index);
 192 int qos_del_tgt(struct obd_device *obd, struct lov_tgt_desc *tgt);
 193 void qos_shrink_lsm(struct lov_request_set *set);
 194 int qos_prep_create(struct obd_export *exp, struct lov_request_set *set);
 195 void qos_update(struct lov_obd *lov);
 196 void qos_statfs_done(struct lov_obd *lov);
 197 void qos_statfs_update(struct obd_device *obd, __u64 max_age, int wait);
 198 int qos_remedy_create(struct lov_request_set *set, struct lov_request *req);
 199
 200 /* lov_request.c */
 201 void lov_set_add_req(struct lov_request *req, struct lov_request_set *set);
 202 int lov_set_finished(struct lov_request_set *set, int idempotent);
 203 void lov_update_set(struct lov_request_set *set,
 204                     struct lov_request *req, int rc);
 205 int lov_update_common_set(struct lov_request_set *set,
 206                           struct lov_request *req, int rc);
 207 int lov_check_and_wait_active(struct lov_obd *lov, int ost_idx);
 208 int lov_prep_getattr_set(struct obd_export *exp, struct obd_info *oinfo,
 209                          struct lov_request_set **reqset);
 210 int lov_fini_getattr_set(struct lov_request_set *set);
 211 int lov_prep_destroy_set(struct obd_export *exp, struct obd_info *oinfo,
 212                          struct obdo *src_oa, struct lov_stripe_md *lsm,
 213                          struct obd_trans_info *oti,
 214                          struct lov_request_set **reqset);
 215 int lov_fini_destroy_set(struct lov_request_set *set);
 216 int lov_prep_setattr_set(struct obd_export *exp, struct obd_info *oinfo,
 217                          struct obd_trans_info *oti,
 218                          struct lov_request_set **reqset);
 219 int lov_update_setattr_set(struct lov_request_set *set,
 220                            struct lov_request *req, int rc);
 221 int lov_fini_setattr_set(struct lov_request_set *set);
 222 int lov_prep_statfs_set(struct obd_device *obd, struct obd_info *oinfo,
 223                         struct lov_request_set **reqset);
 224 void lov_update_statfs(struct obd_statfs *osfs, struct obd_statfs *lov_sfs,
 225                        int success);
 226 int lov_fini_statfs(struct obd_device *obd, struct obd_statfs *osfs,
 227                     int success);
 228 int lov_fini_statfs_set(struct lov_request_set *set);
 229 int lov_statfs_interpret(struct ptlrpc_request_set *rqset, void *data, int rc);
 230
 231 /* lov_obd.c */
 232 void lov_fix_desc(struct lov_desc *desc);
 233 void lov_fix_desc_stripe_size(__u64 *val);
 234 void lov_fix_desc_stripe_count(__u32 *val);
 235 void lov_fix_desc_pattern(__u32 *val);
 236 void lov_fix_desc_qos_maxage(__u32 *val);
 237 __u16 lov_get_stripecnt(struct lov_obd *lov, __u32 magic, __u16 stripe_count);
 238 int lov_connect_obd(struct obd_device *obd, __u32 index, int activate,
 239                     struct obd_connect_data *data);
 240 int lov_setup(struct obd_device *obd, struct lustre_cfg *lcfg);
 241 int lov_process_config_base(struct obd_device *obd, struct lustre_cfg *lcfg,
 242                             __u32 *indexp, int *genp);
 243 int lov_del_target(struct obd_device *obd, __u32 index,
 244                    struct obd_uuid *uuidp, int gen);
 245
 246 /* lov_pack.c */
 247 int lov_packmd(struct obd_export *exp, struct lov_mds_md **lmm,
 248                struct lov_stripe_md *lsm);
 249 int lov_unpackmd(struct obd_export *exp, struct lov_stripe_md **lsmp,
 250                  struct lov_mds_md *lmm, int lmm_bytes);
 251 int lov_getstripe(struct obd_export *exp,
 252                   struct lov_stripe_md *lsm, struct lov_user_md *lump);
 253 int lov_alloc_memmd(struct lov_stripe_md **lsmp, __u16 stripe_count,
 254                     int pattern, int magic);
 255 int lov_free_memmd(struct lov_stripe_md **lsmp);
 256
 257 void lov_dump_lmm_v1(int level, struct lov_mds_md_v1 *lmm);
 258 void lov_dump_lmm_v3(int level, struct lov_mds_md_v3 *lmm);
 259 void lov_dump_lmm_common(int level, void *lmmp);
 260 void lov_dump_lmm(int level, void *lmm);
 261
 262 /* lov_ea.c */
 263 struct lov_stripe_md *lsm_alloc_plain(__u16 stripe_count, int *size);
 264 void lsm_free_plain(struct lov_stripe_md *lsm);
 265 void dump_lsm(unsigned int level, const struct lov_stripe_md *lsm);
 266
 267 /* lproc_lov.c */
 268 #if defined (CONFIG_PROC_FS)
 269 extern const struct file_operations lov_proc_target_fops;
 270 void lprocfs_lov_init_vars(struct lprocfs_static_vars *lvars);
 271 #else
 272 static inline void lprocfs_lov_init_vars(struct lprocfs_static_vars *lvars)
 273 {
 274         memset(lvars, 0, sizeof(*lvars));
 275 }
 276 #endif
 277
 278 /* lov_cl.c */
 279 extern struct lu_device_type lov_device_type;
 280
 281 /* pools */
 282 extern cfs_hash_ops_t pool_hash_operations;
 283 /* ost_pool methods */
 284 int lov_ost_pool_init(struct ost_pool *op, unsigned int count);
 285 int lov_ost_pool_extend(struct ost_pool *op, unsigned int min_count);
 286 int lov_ost_pool_add(struct ost_pool *op, __u32 idx, unsigned int min_count);
 287 int lov_ost_pool_remove(struct ost_pool *op, __u32 idx);
 288 int lov_ost_pool_free(struct ost_pool *op);
 289
 290 /* high level pool methods */
 291 int lov_pool_new(struct obd_device *obd, char *poolname);
 292 int lov_pool_del(struct obd_device *obd, char *poolname);
 293 int lov_pool_add(struct obd_device *obd, char *poolname, char *ostname);
 294 int lov_pool_remove(struct obd_device *obd, char *poolname, char *ostname);
 295 void lov_dump_pool(int level, struct pool_desc *pool);
 296 struct pool_desc *lov_find_pool(struct lov_obd *lov, char *poolname);
 297 int lov_check_index_in_pool(__u32 idx, struct pool_desc *pool);
 298 void lov_pool_putref(struct pool_desc *pool);
 299
 300 static inline struct lov_stripe_md *lsm_addref(struct lov_stripe_md *lsm)
 301 {
 302         LASSERT(atomic_read(&lsm->lsm_refc) > 0);
 303         atomic_inc(&lsm->lsm_refc);
 304         return lsm;
 305 }
 306
 307 static inline bool lov_oinfo_is_dummy(const struct lov_oinfo *loi)
 308 {
 309         if (unlikely(loi->loi_oi.oi.oi_id == 0 &&
 310                      loi->loi_oi.oi.oi_seq == 0 &&
 311                      loi->loi_ost_idx == 0 &&
 312                      loi->loi_ost_gen == 0))
 313                 return true;
 314
 315         return false;
 316 }
 317
 318
 319 #endif