lustre/lov/lov_internal.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  30  * Use is subject to license terms.
  31  */
  32 /*
  33  * Copyright (c) 2011 Whamcloud, Inc.
  34  */
  35 /*
  36  * This file is part of Lustre, http://www.lustre.org/
  37  * Lustre is a trademark of Sun Microsystems, Inc.
  38  */
  39
  40 #ifndef LOV_INTERNAL_H
  41 #define LOV_INTERNAL_H
  42
  43 #include <obd_class.h>
  44 #include <lustre/lustre_user.h>
  45
  46 struct lov_lock_handles {
  47         struct portals_handle   llh_handle;
  48         cfs_atomic_t            llh_refcount;
  49         int                     llh_stripe_count;
  50         struct lustre_handle    llh_handles[0];
  51 };
  52
  53 struct lov_request {
  54         struct obd_info          rq_oi;
  55         struct lov_request_set  *rq_rqset;
  56
  57         cfs_list_t               rq_link;
  58
  59         int                      rq_idx;        /* index in lov->tgts array */
  60         int                      rq_stripe;     /* stripe number */
  61         int                      rq_complete;
  62         int                      rq_rc;
  63         int                      rq_buflen;     /* length of sub_md */
  64
  65         obd_count                rq_oabufs;
  66         obd_count                rq_pgaidx;
  67 };
  68
  69 struct lov_request_set {
  70         struct ldlm_enqueue_info*set_ei;
  71         struct obd_info         *set_oi;
  72         cfs_atomic_t             set_refcount;
  73         struct obd_export       *set_exp;
  74         /* XXX: There is @set_exp already, however obd_statfs gets obd_device
  75            only. */
  76         struct obd_device       *set_obd;
  77         int                      set_count;
  78         int                      set_completes;
  79         int                      set_success;
  80         cfs_atomic_t             set_finish_checked;
  81         struct llog_cookie      *set_cookies;
  82         int                      set_cookie_sent;
  83         struct obd_trans_info   *set_oti;
  84         obd_count                set_oabufs;
  85         struct brw_page         *set_pga;
  86         struct lov_lock_handles *set_lockh;
  87         cfs_list_t               set_list;
  88         cfs_waitq_t              set_waitq;
  89         cfs_spinlock_t           set_lock;
  90 };
  91
  92 extern cfs_mem_cache_t *lov_oinfo_slab;
  93
  94 static inline void lov_llh_addref(void *llhp)
  95 {
  96         struct lov_lock_handles *llh = llhp;
  97         cfs_atomic_inc(&llh->llh_refcount);
  98         CDEBUG(D_INFO, "GETting llh %p : new refcount %d\n", llh,
  99                cfs_atomic_read(&llh->llh_refcount));
 100 }
 101
 102 static inline struct lov_lock_handles *lov_llh_new(struct lov_stripe_md *lsm)
 103 {
 104         struct lov_lock_handles *llh;
 105
 106         OBD_ALLOC(llh, sizeof *llh +
 107                   sizeof(*llh->llh_handles) * lsm->lsm_stripe_count);
 108         if (llh == NULL)
 109                 return NULL;
 110         cfs_atomic_set(&llh->llh_refcount, 2);
 111         llh->llh_stripe_count = lsm->lsm_stripe_count;
 112         CFS_INIT_LIST_HEAD(&llh->llh_handle.h_link);
 113         class_handle_hash(&llh->llh_handle, lov_llh_addref);
 114         return llh;
 115 }
 116
 117 void lov_finish_set(struct lov_request_set *set);
 118
 119 static inline void lov_get_reqset(struct lov_request_set *set)
 120 {
 121         LASSERT(set != NULL);
 122         LASSERT(cfs_atomic_read(&set->set_refcount) > 0);
 123         cfs_atomic_inc(&set->set_refcount);
 124 }
 125
 126 static inline void lov_put_reqset(struct lov_request_set *set)
 127 {
 128         if (cfs_atomic_dec_and_test(&set->set_refcount))
 129                 lov_finish_set(set);
 130 }
 131
 132 static inline struct lov_lock_handles *
 133 lov_handle2llh(struct lustre_handle *handle)
 134 {
 135         LASSERT(handle != NULL);
 136         return(class_handle2object(handle->cookie));
 137 }
 138
 139 static inline void lov_llh_put(struct lov_lock_handles *llh)
 140 {
 141         CDEBUG(D_INFO, "PUTting llh %p : new refcount %d\n", llh,
 142                cfs_atomic_read(&llh->llh_refcount) - 1);
 143         LASSERT(cfs_atomic_read(&llh->llh_refcount) > 0 &&
 144                 cfs_atomic_read(&llh->llh_refcount) < 0x5a5a);
 145         if (cfs_atomic_dec_and_test(&llh->llh_refcount)) {
 146                 class_handle_unhash(&llh->llh_handle);
 147                 /* The structure may be held by other threads because RCU.
 148                  *   -jxiong */
 149                 if (cfs_atomic_read(&llh->llh_refcount))
 150                         return;
 151
 152                 OBD_FREE_RCU(llh, sizeof *llh +
 153                              sizeof(*llh->llh_handles) * llh->llh_stripe_count,
 154                              &llh->llh_handle);
 155         }
 156 }
 157
 158 #define lov_uuid2str(lv, index) \
 159         (char *)((lv)->lov_tgts[index]->ltd_uuid.uuid)
 160
 161 /* lov_merge.c */
 162 void lov_merge_attrs(struct obdo *tgt, struct obdo *src, obd_flag valid,
 163                      struct lov_stripe_md *lsm, int stripeno, int *set);
 164 int lov_merge_lvb(struct obd_export *exp, struct lov_stripe_md *lsm,
 165                   struct ost_lvb *lvb, int kms_only);
 166 int lov_adjust_kms(struct obd_export *exp, struct lov_stripe_md *lsm,
 167                    obd_off size, int shrink);
 168 int lov_merge_lvb_kms(struct lov_stripe_md *lsm,
 169                       struct ost_lvb *lvb, __u64 *kms_place);
 170
 171 /* lov_offset.c */
 172 obd_size lov_stripe_size(struct lov_stripe_md *lsm, obd_size ost_size,
 173                          int stripeno);
 174 int lov_stripe_offset(struct lov_stripe_md *lsm, obd_off lov_off,
 175                       int stripeno, obd_off *obd_off);
 176 obd_off lov_size_to_stripe(struct lov_stripe_md *lsm, obd_off file_size,
 177                            int stripeno);
 178 int lov_stripe_intersects(struct lov_stripe_md *lsm, int stripeno,
 179                           obd_off start, obd_off end,
 180                           obd_off *obd_start, obd_off *obd_end);
 181 int lov_stripe_number(struct lov_stripe_md *lsm, obd_off lov_off);
 182
 183 /* lov_qos.c */
 184 #define LOV_USES_ASSIGNED_STRIPE        0
 185 #define LOV_USES_DEFAULT_STRIPE         1
 186 int qos_add_tgt(struct obd_device *obd, __u32 index);
 187 int qos_del_tgt(struct obd_device *obd, struct lov_tgt_desc *tgt);
 188 void qos_shrink_lsm(struct lov_request_set *set);
 189 int qos_prep_create(struct obd_export *exp, struct lov_request_set *set);
 190 void qos_update(struct lov_obd *lov);
 191 void qos_statfs_done(struct lov_obd *lov);
 192 void qos_statfs_update(struct obd_device *obd, __u64 max_age, int wait);
 193 int qos_remedy_create(struct lov_request_set *set, struct lov_request *req);
 194
 195 /* lov_request.c */
 196 void lov_set_add_req(struct lov_request *req, struct lov_request_set *set);
 197 int lov_set_finished(struct lov_request_set *set, int idempotent);
 198 void lov_update_set(struct lov_request_set *set,
 199                     struct lov_request *req, int rc);
 200 int lov_update_common_set(struct lov_request_set *set,
 201                           struct lov_request *req, int rc);
 202 int lov_prep_create_set(struct obd_export *exp, struct obd_info *oifo,
 203                         struct lov_stripe_md **ea, struct obdo *src_oa,
 204                         struct obd_trans_info *oti,
 205                         struct lov_request_set **reqset);
 206 int cb_create_update(void *cookie, int rc);
 207 int lov_fini_create_set(struct lov_request_set *set, struct lov_stripe_md **ea);
 208 int lov_prep_brw_set(struct obd_export *exp, struct obd_info *oinfo,
 209                      obd_count oa_bufs, struct brw_page *pga,
 210                      struct obd_trans_info *oti,
 211                      struct lov_request_set **reqset);
 212 int lov_fini_brw_set(struct lov_request_set *set);
 213 int lov_prep_getattr_set(struct obd_export *exp, struct obd_info *oinfo,
 214                          struct lov_request_set **reqset);
 215 int lov_fini_getattr_set(struct lov_request_set *set);
 216 int lov_prep_destroy_set(struct obd_export *exp, struct obd_info *oinfo,
 217                          struct obdo *src_oa, struct lov_stripe_md *lsm,
 218                          struct obd_trans_info *oti,
 219                          struct lov_request_set **reqset);
 220 int lov_update_destroy_set(struct lov_request_set *set,
 221                            struct lov_request *req, int rc);
 222 int lov_fini_destroy_set(struct lov_request_set *set);
 223 int lov_prep_setattr_set(struct obd_export *exp, struct obd_info *oinfo,
 224                          struct obd_trans_info *oti,
 225                          struct lov_request_set **reqset);
 226 int lov_update_setattr_set(struct lov_request_set *set,
 227                            struct lov_request *req, int rc);
 228 int lov_fini_setattr_set(struct lov_request_set *set);
 229 int lov_prep_punch_set(struct obd_export *exp, struct obd_info *oinfo,
 230                        struct obd_trans_info *oti,
 231                        struct lov_request_set **reqset);
 232 int lov_fini_punch_set(struct lov_request_set *set);
 233 int lov_prep_sync_set(struct obd_export *exp, struct obd_info *obd_info,
 234                       obd_off start, obd_off end,
 235                       struct lov_request_set **reqset);
 236 int lov_fini_sync_set(struct lov_request_set *set);
 237 int lov_prep_enqueue_set(struct obd_export *exp, struct obd_info *oinfo,
 238                          struct ldlm_enqueue_info *einfo,
 239                          struct lov_request_set **reqset);
 240 int lov_fini_enqueue_set(struct lov_request_set *set, __u32 mode, int rc,
 241                          struct ptlrpc_request_set *rqset);
 242 int lov_prep_match_set(struct obd_export *exp, struct obd_info *oinfo,
 243                        struct lov_stripe_md *lsm,
 244                        ldlm_policy_data_t *policy, __u32 mode,
 245                        struct lustre_handle *lockh,
 246                        struct lov_request_set **reqset);
 247 int lov_update_match_set(struct lov_request_set *set, struct lov_request *req,
 248                          int rc);
 249 int lov_fini_match_set(struct lov_request_set *set, __u32 mode, int flags);
 250 int lov_prep_cancel_set(struct obd_export *exp, struct obd_info *oinfo,
 251                         struct lov_stripe_md *lsm,
 252                         __u32 mode, struct lustre_handle *lockh,
 253                         struct lov_request_set **reqset);
 254 int lov_fini_cancel_set(struct lov_request_set *set);
 255 int lov_prep_statfs_set(struct obd_device *obd, struct obd_info *oinfo,
 256                         struct lov_request_set **reqset);
 257 void lov_update_statfs(struct obd_statfs *osfs, struct obd_statfs *lov_sfs,
 258                        int success);
 259 int lov_fini_statfs(struct obd_device *obd, struct obd_statfs *osfs,
 260                     int success);
 261 int lov_fini_statfs_set(struct lov_request_set *set);
 262 int lov_statfs_interpret(struct ptlrpc_request_set *rqset, void *data, int rc);
 263
 264 /* lov_obd.c */
 265 void lov_fix_desc(struct lov_desc *desc);
 266 void lov_fix_desc_stripe_size(__u64 *val);
 267 void lov_fix_desc_stripe_count(__u32 *val);
 268 void lov_fix_desc_pattern(__u32 *val);
 269 void lov_fix_desc_qos_maxage(__u32 *val);
 270 int lov_get_stripecnt(struct lov_obd *lov, __u32 stripe_count);
 271 int lov_connect_obd(struct obd_device *obd, __u32 index, int activate,
 272                     struct obd_connect_data *data);
 273 int lov_setup(struct obd_device *obd, struct lustre_cfg *lcfg);
 274 int lov_process_config_base(struct obd_device *obd, struct lustre_cfg *lcfg,
 275                             __u32 *indexp, int *genp);
 276 int lov_del_target(struct obd_device *obd, __u32 index,
 277                    struct obd_uuid *uuidp, int gen);
 278 /* lov_log.c */
 279 int lov_llog_init(struct obd_device *obd, struct obd_llog_group *olg,
 280                   struct obd_device *tgt, int *idx);
 281 int lov_llog_finish(struct obd_device *obd, int count);
 282
 283 /* lov_pack.c */
 284 int lov_packmd(struct obd_export *exp, struct lov_mds_md **lmm,
 285                struct lov_stripe_md *lsm);
 286 int lov_unpackmd(struct obd_export *exp, struct lov_stripe_md **lsmp,
 287                  struct lov_mds_md *lmm, int lmm_bytes);
 288 int lov_setstripe(struct obd_export *exp, int max_lmm_size,
 289                   struct lov_stripe_md **lsmp, struct lov_user_md *lump);
 290 int lov_setea(struct obd_export *exp, struct lov_stripe_md **lsmp,
 291               struct lov_user_md *lump);
 292 int lov_getstripe(struct obd_export *exp,
 293                   struct lov_stripe_md *lsm, struct lov_user_md *lump);
 294 int lov_alloc_memmd(struct lov_stripe_md **lsmp, int stripe_count,
 295                     int pattern, int magic);
 296 void lov_free_memmd(struct lov_stripe_md **lsmp);
 297
 298 void lov_dump_lmm_v1(int level, struct lov_mds_md_v1 *lmm);
 299 void lov_dump_lmm_v3(int level, struct lov_mds_md_v3 *lmm);
 300 void lov_dump_lmm(int level, void *lmm);
 301
 302 /* lov_ea.c */
 303 struct lov_stripe_md *lsm_alloc_plain(int stripe_count, int *size);
 304 void lsm_free_plain(struct lov_stripe_md *lsm);
 305
 306 int lovea_destroy_object(struct lov_obd *lov, struct lov_stripe_md *lsm,
 307                          struct obdo *oa, void *data);
 308 /* lproc_lov.c */
 309 extern struct file_operations lov_proc_target_fops;
 310 #ifdef LPROCFS
 311 void lprocfs_lov_init_vars(struct lprocfs_static_vars *lvars);
 312 #else
 313 static inline void lprocfs_lov_init_vars(struct lprocfs_static_vars *lvars)
 314 {
 315         memset(lvars, 0, sizeof(*lvars));
 316 }
 317 #endif
 318
 319 /* lov_cl.c */
 320 extern struct lu_device_type lov_device_type;
 321
 322 /* pools */
 323 extern cfs_hash_ops_t pool_hash_operations;
 324 /* ost_pool methods */
 325 int lov_ost_pool_init(struct ost_pool *op, unsigned int count);
 326 int lov_ost_pool_extend(struct ost_pool *op, unsigned int min_count);
 327 int lov_ost_pool_add(struct ost_pool *op, __u32 idx, unsigned int min_count);
 328 int lov_ost_pool_remove(struct ost_pool *op, __u32 idx);
 329 int lov_ost_pool_free(struct ost_pool *op);
 330
 331 /* high level pool methods */
 332 int lov_pool_new(struct obd_device *obd, char *poolname);
 333 int lov_pool_del(struct obd_device *obd, char *poolname);
 334 int lov_pool_add(struct obd_device *obd, char *poolname, char *ostname);
 335 int lov_pool_remove(struct obd_device *obd, char *poolname, char *ostname);
 336 void lov_dump_pool(int level, struct pool_desc *pool);
 337 struct pool_desc *lov_find_pool(struct lov_obd *lov, char *poolname);
 338 int lov_check_index_in_pool(__u32 idx, struct pool_desc *pool);
 339 void lov_pool_putref(struct pool_desc *pool);
 340
 341 #if BITS_PER_LONG == 64
 342 # define ll_do_div64(n,base) ({                                 \
 343         uint64_t __base = (base);                               \
 344         uint64_t __rem;                                         \
 345         __rem = ((uint64_t)(n)) % __base;                       \
 346         (n) = ((uint64_t)(n)) / __base;                         \
 347         __rem;                                                  \
 348   })
 349 #elif BITS_PER_LONG == 32
 350 # define ll_do_div64(n,base) ({                                 \
 351         uint64_t __rem;                                         \
 352         if ((sizeof(base) > 4) && (((base)&0xffffffff00000000ULL) != 0)) { \
 353                 int __remainder;                                \
 354                 LASSERTF(!((base) & (LOV_MIN_STRIPE_SIZE - 1)), "64 bit lov "\
 355                           "division %llu / %llu\n", (n), (base)); \
 356                 __remainder = (n) & (LOV_MIN_STRIPE_SIZE - 1);  \
 357                 (n) >>= LOV_MIN_STRIPE_BITS;                    \
 358                 (base) >>= LOV_MIN_STRIPE_BITS;                 \
 359                 __rem = do_div(n, base);                        \
 360                 __rem <<= LOV_MIN_STRIPE_BITS;                  \
 361                 __rem += __remainder;                           \
 362         } else {                                                \
 363                 __rem = do_div(n, base);                        \
 364         }                                                       \
 365         __rem;                                                  \
 366   })
 367 #else
 368 #error Unsupported architecture.
 369 #endif
 370
 371 #endif