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