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  2008 Sun Microsystems, Inc. All rights reserved
  30  * Use is subject to license terms.
  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 <lustre/lustre_user.h>
  41
  42 struct lov_lock_handles {
  43         struct portals_handle   llh_handle;
  44         atomic_t                llh_refcount;
  45         int                     llh_stripe_count;
  46         struct lustre_handle    llh_handles[0];
  47 };
  48
  49 struct lov_request {
  50         struct obd_info          rq_oi;
  51         struct lov_request_set  *rq_rqset;
  52
  53         struct list_head         rq_link;
  54
  55         int                      rq_idx;        /* index in lov->tgts array */
  56         int                      rq_stripe;     /* stripe number */
  57         int                      rq_complete;
  58         int                      rq_rc;
  59         int                      rq_buflen;     /* length of sub_md */
  60
  61         obd_count                rq_oabufs;
  62         obd_count                rq_pgaidx;
  63 };
  64
  65 struct lov_request_set {
  66         struct ldlm_enqueue_info*set_ei;
  67         struct obd_info         *set_oi;
  68         atomic_t                 set_refcount;
  69         struct obd_export       *set_exp;
  70         /* XXX: There is @set_exp already, however obd_statfs gets obd_device
  71            only. */
  72         struct obd_device       *set_obd;
  73         int                      set_count;
  74         int                      set_completes;
  75         int                      set_success;
  76         struct llog_cookie      *set_cookies;
  77         int                      set_cookie_sent;
  78         struct obd_trans_info   *set_oti;
  79         obd_count                set_oabufs;
  80         struct brw_page         *set_pga;
  81         struct lov_lock_handles *set_lockh;
  82         struct list_head         set_list;
  83 };
  84
  85 #define LOV_AP_MAGIC 8200
  86
  87 struct lov_async_page {
  88         int                             lap_magic;
  89         int                             lap_stripe;
  90         obd_off                         lap_sub_offset;
  91         obd_id                          lap_loi_id;
  92         void                            *lap_sub_cookie;
  93         struct obd_async_page_ops       *lap_caller_ops;
  94         void                            *lap_caller_data;
  95 };
  96
  97 #define LAP_FROM_COOKIE(c)                                                     \
  98         (LASSERT(((struct lov_async_page *)(c))->lap_magic == LOV_AP_MAGIC),   \
  99          (struct lov_async_page *)(c))
 100
 101 extern cfs_mem_cache_t *lov_oinfo_slab;
 102
 103 static inline void lov_llh_addref(void *llhp)
 104 {
 105         struct lov_lock_handles *llh = llhp;
 106         atomic_inc(&llh->llh_refcount);
 107         CDEBUG(D_INFO, "GETting llh %p : new refcount %d\n", llh,
 108                atomic_read(&llh->llh_refcount));
 109 }
 110
 111 static inline struct lov_lock_handles *lov_llh_new(struct lov_stripe_md *lsm)
 112 {
 113         struct lov_lock_handles *llh;
 114
 115         OBD_ALLOC(llh, sizeof *llh +
 116                   sizeof(*llh->llh_handles) * lsm->lsm_stripe_count);
 117         if (llh == NULL)
 118                 return NULL;
 119         atomic_set(&llh->llh_refcount, 2);
 120         llh->llh_stripe_count = lsm->lsm_stripe_count;
 121         CFS_INIT_LIST_HEAD(&llh->llh_handle.h_link);
 122         class_handle_hash(&llh->llh_handle, lov_llh_addref);
 123         return llh;
 124 }
 125
 126 static inline struct lov_lock_handles *
 127 lov_handle2llh(struct lustre_handle *handle)
 128 {
 129         LASSERT(handle != NULL);
 130         return(class_handle2object(handle->cookie));
 131 }
 132
 133 static inline void lov_llh_put(struct lov_lock_handles *llh)
 134 {
 135         CDEBUG(D_INFO, "PUTting llh %p : new refcount %d\n", llh,
 136                atomic_read(&llh->llh_refcount) - 1);
 137         LASSERT(atomic_read(&llh->llh_refcount) > 0 &&
 138                 atomic_read(&llh->llh_refcount) < 0x5a5a);
 139         if (atomic_dec_and_test(&llh->llh_refcount)) {
 140                 class_handle_unhash(&llh->llh_handle);
 141                 /* The structure may be held by other threads because RCU. -jxiong */
 142                 if (atomic_read(&llh->llh_refcount))
 143                         return;
 144
 145                 OBD_FREE_RCU(llh, sizeof *llh +
 146                          sizeof(*llh->llh_handles) * llh->llh_stripe_count, &llh->llh_handle);
 147         }
 148 }
 149
 150 #define lov_uuid2str(lv, index) \
 151         (char *)((lv)->lov_tgts[index]->ltd_uuid.uuid)
 152
 153 /* lov_merge.c */
 154 void lov_merge_attrs(struct obdo *tgt, struct obdo *src, obd_flag valid,
 155                      struct lov_stripe_md *lsm, int stripeno, int *set);
 156 int lov_merge_lvb(struct obd_export *exp, struct lov_stripe_md *lsm,
 157                   struct ost_lvb *lvb, int kms_only);
 158 int lov_adjust_kms(struct obd_export *exp, struct lov_stripe_md *lsm,
 159                    obd_off size, int shrink);
 160 int lov_update_lvb(struct obd_export *exp, struct lov_stripe_md *lsm,
 161                    struct ost_lvb *lvb, obd_flag valid);
 162
 163 /* lov_offset.c */
 164 obd_size lov_stripe_size(struct lov_stripe_md *lsm, obd_size ost_size,
 165                          int stripeno);
 166 int lov_stripe_offset(struct lov_stripe_md *lsm, obd_off lov_off,
 167                       int stripeno, obd_off *obd_off);
 168 obd_off lov_size_to_stripe(struct lov_stripe_md *lsm, obd_off file_size,
 169                            int stripeno);
 170 int lov_stripe_intersects(struct lov_stripe_md *lsm, int stripeno,
 171                           obd_off start, obd_off end,
 172                           obd_off *obd_start, obd_off *obd_end);
 173 int lov_stripe_number(struct lov_stripe_md *lsm, obd_off lov_off);
 174
 175 /* lov_qos.c */
 176 #define LOV_USES_ASSIGNED_STRIPE        0
 177 #define LOV_USES_DEFAULT_STRIPE         1
 178 int qos_add_tgt(struct obd_device *obd, __u32 index);
 179 int qos_del_tgt(struct obd_device *obd, struct lov_tgt_desc *tgt);
 180 void qos_shrink_lsm(struct lov_request_set *set);
 181 int qos_prep_create(struct obd_export *exp, struct lov_request_set *set);
 182 void qos_update(struct lov_obd *lov);
 183 int qos_remedy_create(struct lov_request_set *set, struct lov_request *req);
 184
 185 /* lov_request.c */
 186 void lov_set_add_req(struct lov_request *req, struct lov_request_set *set);
 187 void lov_update_set(struct lov_request_set *set,
 188                     struct lov_request *req, int rc);
 189 int lov_update_common_set(struct lov_request_set *set,
 190                           struct lov_request *req, int rc);
 191 int lov_prep_create_set(struct obd_export *exp, struct obd_info *oifo,
 192                         struct lov_stripe_md **ea, struct obdo *src_oa,
 193                         struct obd_trans_info *oti,
 194                         struct lov_request_set **reqset);
 195 int lov_update_create_set(struct lov_request_set *set,
 196                           struct lov_request *req, int rc);
 197 int lov_fini_create_set(struct lov_request_set *set, struct lov_stripe_md **ea);
 198 int lov_prep_brw_set(struct obd_export *exp, struct obd_info *oinfo,
 199                      obd_count oa_bufs, struct brw_page *pga,
 200                      struct obd_trans_info *oti,
 201                      struct lov_request_set **reqset);
 202 int lov_fini_brw_set(struct lov_request_set *set);
 203 int lov_prep_getattr_set(struct obd_export *exp, struct obd_info *oinfo,
 204                          struct lov_request_set **reqset);
 205 int lov_fini_getattr_set(struct lov_request_set *set);
 206 int lov_prep_destroy_set(struct obd_export *exp, struct obd_info *oinfo,
 207                          struct obdo *src_oa, struct lov_stripe_md *lsm,
 208                          struct obd_trans_info *oti,
 209                          struct lov_request_set **reqset);
 210 int lov_update_destroy_set(struct lov_request_set *set,
 211                            struct lov_request *req, int rc);
 212 int lov_fini_destroy_set(struct lov_request_set *set);
 213 int lov_prep_setattr_set(struct obd_export *exp, struct obd_info *oinfo,
 214                          struct obd_trans_info *oti,
 215                          struct lov_request_set **reqset);
 216 int lov_update_setattr_set(struct lov_request_set *set,
 217                            struct lov_request *req, int rc);
 218 int lov_fini_setattr_set(struct lov_request_set *set);
 219 int lov_prep_punch_set(struct obd_export *exp, struct obd_info *oinfo,
 220                        struct obd_trans_info *oti,
 221                        struct lov_request_set **reqset);
 222 int lov_fini_punch_set(struct lov_request_set *set);
 223 int lov_prep_sync_set(struct obd_export *exp, struct obd_info *obd_info,
 224                       obd_off start, obd_off end,
 225                       struct lov_request_set **reqset);
 226 int lov_fini_sync_set(struct lov_request_set *set);
 227 int lov_prep_enqueue_set(struct obd_export *exp, struct obd_info *oinfo,
 228                          struct ldlm_enqueue_info *einfo,
 229                          struct lov_request_set **reqset);
 230 int lov_fini_enqueue_set(struct lov_request_set *set, __u32 mode, int rc,
 231                          struct ptlrpc_request_set *rqset);
 232 int lov_prep_match_set(struct obd_export *exp, struct obd_info *oinfo,
 233                        struct lov_stripe_md *lsm,
 234                        ldlm_policy_data_t *policy, __u32 mode,
 235                        struct lustre_handle *lockh,
 236                        struct lov_request_set **reqset);
 237 int lov_update_match_set(struct lov_request_set *set, struct lov_request *req,
 238                          int rc);
 239 int lov_fini_match_set(struct lov_request_set *set, __u32 mode, int flags);
 240 int lov_prep_cancel_set(struct obd_export *exp, struct obd_info *oinfo,
 241                         struct lov_stripe_md *lsm,
 242                         __u32 mode, struct lustre_handle *lockh,
 243                         struct lov_request_set **reqset);
 244 int lov_fini_cancel_set(struct lov_request_set *set);
 245 int lov_prep_statfs_set(struct obd_device *obd, struct obd_info *oinfo,
 246                         struct lov_request_set **reqset);
 247 void lov_update_statfs(struct obd_statfs *osfs, struct obd_statfs *lov_sfs,
 248                        int success);
 249 int lov_fini_statfs(struct obd_device *obd, struct obd_statfs *osfs,
 250                     int success);
 251 int lov_fini_statfs_set(struct lov_request_set *set);
 252
 253 /* lov_obd.c */
 254 void lov_fix_desc(struct lov_desc *desc);
 255 void lov_fix_desc_stripe_size(__u64 *val);
 256 void lov_fix_desc_stripe_count(__u32 *val);
 257 void lov_fix_desc_pattern(__u32 *val);
 258 void lov_fix_desc_qos_maxage(__u32 *val);
 259 int lov_get_stripecnt(struct lov_obd *lov, __u32 stripe_count);
 260 void lov_getref(struct obd_device *obd);
 261 void lov_putref(struct obd_device *obd);
 262
 263 /* lov_log.c */
 264 int lov_llog_init(struct obd_device *obd, struct obd_device *tgt,
 265                   int count, struct llog_catid *logid, struct obd_uuid *uuid);
 266 int lov_llog_finish(struct obd_device *obd, int count);
 267
 268 /* lov_pack.c */
 269 int lov_packmd(struct obd_export *exp, struct lov_mds_md **lmm,
 270                struct lov_stripe_md *lsm);
 271 int lov_unpackmd(struct obd_export *exp, struct lov_stripe_md **lsmp,
 272                  struct lov_mds_md *lmm, int lmm_bytes);
 273 int lov_setstripe(struct obd_export *exp,
 274                   struct lov_stripe_md **lsmp, struct lov_user_md *lump);
 275 int lov_setea(struct obd_export *exp, struct lov_stripe_md **lsmp,
 276               struct lov_user_md *lump);
 277 int lov_getstripe(struct obd_export *exp,
 278                   struct lov_stripe_md *lsm, struct lov_user_md *lump);
 279 int lov_alloc_memmd(struct lov_stripe_md **lsmp, int stripe_count,
 280                       int pattern, int magic);
 281 void lov_free_memmd(struct lov_stripe_md **lsmp);
 282
 283 void lov_dump_lmm_v1(int level, struct lov_mds_md_v1 *lmm);
 284 void lov_dump_lmm_join(int level, struct lov_mds_md_join *lmmj);
 285 void lov_dump_lmm_v3(int level, struct lov_mds_md_v3 *lmm);
 286 void lov_dump_lmm(int level, void *lmm);
 287
 288 /* lov_ea.c */
 289 int lov_unpackmd_join(struct lov_obd *lov, struct lov_stripe_md *lsm,
 290                       struct lov_mds_md *lmm);
 291 struct lov_stripe_md *lsm_alloc_plain(int stripe_count, int *size);
 292 void lsm_free_plain(struct lov_stripe_md *lsm);
 293
 294 struct lov_extent *lovea_idx2le(struct lov_stripe_md *lsm, int stripe_no);
 295 struct lov_extent *lovea_off2le(struct lov_stripe_md *lsm, obd_off lov_off);
 296 int lovea_destroy_object(struct lov_obd *lov, struct lov_stripe_md *lsm,
 297                          struct obdo *oa, void *data);
 298 /* lproc_lov.c */
 299 extern struct file_operations lov_proc_target_fops;
 300 #ifdef LPROCFS
 301 void lprocfs_lov_init_vars(struct lprocfs_static_vars *lvars);
 302 #else
 303 static inline void lprocfs_lov_init_vars(struct lprocfs_static_vars *lvars)
 304 {
 305         memset(lvars, 0, sizeof(*lvars));
 306 }
 307 #endif
 308
 309 /* pools */
 310 extern lustre_hash_ops_t pool_hash_operations;
 311
 312 /* ost_pool methods */
 313 int lov_ost_pool_init(struct ost_pool *op, unsigned int count);
 314 int lov_ost_pool_extend(struct ost_pool *op, unsigned int min_count);
 315 int lov_ost_pool_add(struct ost_pool *op, __u32 idx, unsigned int min_count);
 316 int lov_ost_pool_remove(struct ost_pool *op, __u32 idx);
 317 int lov_ost_pool_free(struct ost_pool *op);
 318
 319 /* high level pool methods */
 320 int lov_pool_new(struct obd_device *obd, char *poolname);
 321 int lov_pool_del(struct obd_device *obd, char *poolname);
 322 int lov_pool_add(struct obd_device *obd, char *poolname, char *ostname);
 323 int lov_pool_remove(struct obd_device *obd, char *poolname, char *ostname);
 324 void lov_dump_pool(int level, struct pool_desc *pool);
 325 struct pool_desc *lov_find_pool(struct lov_obd *lov, char *poolname);
 326 int lov_check_index_in_pool(__u32 idx, struct pool_desc *pool);
 327 void lov_pool_putref(struct pool_desc *pool);
 328
 329 #if BITS_PER_LONG == 64
 330 # define ll_do_div64(n,base) ({                                 \
 331         uint64_t __base = (base);                               \
 332         uint64_t __rem;                                         \
 333         __rem = ((uint64_t)(n)) % __base;                       \
 334         (n) = ((uint64_t)(n)) / __base;                         \
 335         __rem;                                                  \
 336   })
 337 #elif BITS_PER_LONG == 32
 338 # define ll_do_div64(n,base) ({                                 \
 339         uint64_t __rem;                                         \
 340         if ((sizeof(base) > 4) && (((base)&0xffffffff00000000ULL) != 0)) { \
 341                 int __remainder;                                \
 342                 LASSERTF(!((base) & (LOV_MIN_STRIPE_SIZE - 1)), "64 bit lov "\
 343                           "division %llu / %llu\n", (n), (base)); \
 344                 __remainder = (n) & (LOV_MIN_STRIPE_SIZE - 1);  \
 345                 (n) >>= LOV_MIN_STRIPE_BITS;                    \
 346                 (base) >>= LOV_MIN_STRIPE_BITS;                 \
 347                 __rem = do_div(n, base);                        \
 348                 __rem <<= LOV_MIN_STRIPE_BITS;                  \
 349                 __rem += __remainder;                           \
 350         } else {                                                \
 351                 __rem = do_div(n, base);                        \
 352         }                                                       \
 353         __rem;                                                  \
 354   })
 355 #else
 356 #error Unsupported architecture.
 357 #endif
 358
 359 #endif