lustre/osp/osp_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) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2012, 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  * lustre/osp/osp_internal.h
  37  *
  38  * Author: Alex Zhuravlev <alexey.zhuravlev@intel.com>
  39  */
  40
  41 #ifndef _OSP_INTERNAL_H
  42 #define _OSP_INTERNAL_H
  43
  44 #include <obd.h>
  45 #include <obd_class.h>
  46 #include <dt_object.h>
  47 #include <md_object.h>
  48 #include <lustre_fid.h>
  49
  50 /*
  51  * Infrastructure to support tracking of last committed llog record
  52  */
  53 struct osp_id_tracker {
  54         spinlock_t               otr_lock;
  55         __u32                    otr_next_id;
  56         __u32                    otr_committed_id;
  57         /* callback is register once per diskfs -- that's the whole point */
  58         struct dt_txn_callback   otr_tx_cb;
  59         /* single node can run many clusters */
  60         cfs_list_t               otr_wakeup_list;
  61         cfs_list_t               otr_list;
  62         /* underlying shared device */
  63         struct dt_device        *otr_dev;
  64         /* how many users of this tracker */
  65         cfs_atomic_t             otr_refcount;
  66 };
  67
  68 struct osp_precreate {
  69         /*
  70          * Precreation pool
  71          */
  72         spinlock_t                       osp_pre_lock;
  73
  74         /* last fid to assign in creation */
  75         struct lu_fid                    osp_pre_used_fid;
  76         /* last created id OST reported, next-created - available id's */
  77         struct lu_fid                    osp_pre_last_created_fid;
  78         /* how many ids are reserved in declare, we shouldn't block in create */
  79         __u64                            osp_pre_reserved;
  80         /* thread waits for signals about pool going empty */
  81         wait_queue_head_t                osp_pre_waitq;
  82         /* consumers (who needs new ids) wait here */
  83         wait_queue_head_t                osp_pre_user_waitq;
  84         /* current precreation status: working, failed, stopping? */
  85         int                              osp_pre_status;
  86         /* how many to precreate next time */
  87         int                              osp_pre_grow_count;
  88         int                              osp_pre_min_grow_count;
  89         int                              osp_pre_max_grow_count;
  90         /* whether to grow precreation window next time or not */
  91         int                              osp_pre_grow_slow;
  92         /* cleaning up orphans or recreating missing objects */
  93         int                              osp_pre_recovering;
  94 };
  95
  96 struct osp_device {
  97         struct dt_device                 opd_dt_dev;
  98         /* corresponded OST index */
  99         int                              opd_index;
 100
 101         /* corrsponded MDT index, which will be used when connecting to OST
 102          * for validating the connection (see ofd_parse_connect_data) */
 103         int                              opd_group;
 104         /* device used to store persistent state (llogs, last ids) */
 105         struct obd_export               *opd_storage_exp;
 106         struct dt_device                *opd_storage;
 107         struct dt_object                *opd_last_used_oid_file;
 108         struct dt_object                *opd_last_used_seq_file;
 109
 110         /* stored persistently in LE format, updated directly to/from disk
 111          * and required le64_to_cpu() conversion before use.
 112          * Protected by opd_pre_lock */
 113         struct lu_fid                   opd_last_used_fid;
 114         struct lu_fid                   opd_gap_start_fid;
 115         int                              opd_gap_count;
 116         /* connection to OST */
 117         struct obd_device               *opd_obd;
 118         struct obd_export               *opd_exp;
 119         struct obd_uuid                  opd_cluuid;
 120         struct obd_connect_data         *opd_connect_data;
 121         int                              opd_connects;
 122         cfs_proc_dir_entry_t            *opd_proc_entry;
 123         struct lprocfs_stats            *opd_stats;
 124         /* connection status. */
 125         int                              opd_new_connection;
 126         int                              opd_got_disconnected;
 127         int                              opd_imp_connected;
 128         int                              opd_imp_active;
 129         unsigned int                     opd_imp_seen_connected:1,
 130                                          opd_connect_mdt:1;
 131
 132         /* whether local recovery is completed:
 133          * reported via ->ldo_recovery_complete() */
 134         int                              opd_recovery_completed;
 135
 136         /* precreate structure for OSP */
 137         struct osp_precreate            *opd_pre;
 138         /* dedicate precreate thread */
 139         struct ptlrpc_thread             opd_pre_thread;
 140
 141         /*
 142          * OST synchronization
 143          */
 144         spinlock_t                       opd_syn_lock;
 145         /* unique generation, to recognize start of new records in the llog */
 146         struct llog_gen                  opd_syn_generation;
 147         /* number of changes to sync, used to wake up sync thread */
 148         unsigned long                    opd_syn_changes;
 149         /* processing of changes from previous mount is done? */
 150         int                              opd_syn_prev_done;
 151         /* found records */
 152         struct ptlrpc_thread             opd_syn_thread;
 153         wait_queue_head_t                opd_syn_waitq;
 154         /* list of remotely committed rpc */
 155         cfs_list_t                       opd_syn_committed_there;
 156         /* number of changes being under sync */
 157         int                              opd_syn_sync_in_progress;
 158         /* number of RPCs in flight - flow control */
 159         int                              opd_syn_rpc_in_flight;
 160         int                              opd_syn_max_rpc_in_flight;
 161         /* number of RPC in processing (including non-committed by OST) */
 162         int                              opd_syn_rpc_in_progress;
 163         int                              opd_syn_max_rpc_in_progress;
 164         /* osd api's commit cb control structure */
 165         struct dt_txn_callback           opd_syn_txn_cb;
 166         /* last used change number -- semantically similar to transno */
 167         unsigned long                    opd_syn_last_used_id;
 168         /* last committed change number -- semantically similar to
 169          * last_committed */
 170         unsigned long                    opd_syn_last_committed_id;
 171         /* last processed (taken from llog) id */
 172         unsigned long                    opd_syn_last_processed_id;
 173         struct osp_id_tracker           *opd_syn_tracker;
 174         cfs_list_t                       opd_syn_ontrack;
 175
 176         /*
 177          * statfs related fields: OSP maintains it on its own
 178          */
 179         struct obd_statfs                opd_statfs;
 180         cfs_time_t                       opd_statfs_fresh_till;
 181         struct timer_list                        opd_statfs_timer;
 182         int                              opd_statfs_update_in_progress;
 183         /* how often to update statfs data */
 184         int                              opd_statfs_maxage;
 185
 186         cfs_proc_dir_entry_t            *opd_symlink;
 187 };
 188
 189 #define opd_pre_lock                    opd_pre->osp_pre_lock
 190 #define opd_pre_used_fid                opd_pre->osp_pre_used_fid
 191 #define opd_pre_last_created_fid        opd_pre->osp_pre_last_created_fid
 192 #define opd_pre_reserved                opd_pre->osp_pre_reserved
 193 #define opd_pre_waitq                   opd_pre->osp_pre_waitq
 194 #define opd_pre_user_waitq              opd_pre->osp_pre_user_waitq
 195 #define opd_pre_status                  opd_pre->osp_pre_status
 196 #define opd_pre_grow_count              opd_pre->osp_pre_grow_count
 197 #define opd_pre_min_grow_count          opd_pre->osp_pre_min_grow_count
 198 #define opd_pre_max_grow_count          opd_pre->osp_pre_max_grow_count
 199 #define opd_pre_grow_slow               opd_pre->osp_pre_grow_slow
 200 #define opd_pre_recovering              opd_pre->osp_pre_recovering
 201
 202 extern struct kmem_cache *osp_object_kmem;
 203
 204 /* this is a top object */
 205 struct osp_object {
 206         struct lu_object_header opo_header;
 207         struct dt_object        opo_obj;
 208         unsigned int            opo_reserved:1,
 209                                 opo_new:1,
 210                                 opo_empty:1;
 211
 212         /* read/write lock for md osp object */
 213         struct rw_semaphore     opo_sem;
 214         const struct lu_env     *opo_owner;
 215 };
 216
 217 extern struct lu_object_operations osp_lu_obj_ops;
 218 extern const struct dt_device_operations osp_dt_ops;
 219 extern struct dt_object_operations osp_md_obj_ops;
 220
 221 struct osp_thread_info {
 222         struct lu_buf            osi_lb;
 223         struct lu_buf            osi_lb2;
 224         struct lu_fid            osi_fid;
 225         struct lu_attr           osi_attr;
 226         struct ost_id            osi_oi;
 227         struct ost_id            osi_oi2;
 228         obd_id                   osi_id;
 229         loff_t                   osi_off;
 230         union {
 231                 struct llog_rec_hdr             osi_hdr;
 232                 struct llog_unlink64_rec        osi_unlink;
 233                 struct llog_setattr64_rec       osi_setattr;
 234                 struct llog_gen_rec             osi_gen;
 235         };
 236         struct llog_cookie       osi_cookie;
 237         struct llog_catid        osi_cid;
 238         struct lu_seq_range      osi_seq;
 239         struct ldlm_res_id       osi_resid;
 240         struct obdo              osi_obdo;
 241 };
 242
 243 static inline void osp_objid_buf_prep(struct lu_buf *buf, loff_t *off,
 244                                       __u32 *id, int index)
 245 {
 246         buf->lb_buf = (void *)id;
 247         buf->lb_len = sizeof(obd_id);
 248         *off = sizeof(obd_id) * index;
 249 }
 250
 251 static inline void osp_objseq_buf_prep(struct lu_buf *buf, loff_t *off,
 252                                        __u64 *seq, int index)
 253 {
 254         buf->lb_buf = (void *)seq;
 255         buf->lb_len = sizeof(obd_id);
 256         *off = sizeof(obd_id) * index;
 257 }
 258
 259 static inline void osp_buf_prep(struct lu_buf *lb, void *buf, int buf_len)
 260 {
 261         lb->lb_buf = buf;
 262         lb->lb_len = buf_len;
 263 }
 264
 265 extern struct lu_context_key osp_thread_key;
 266
 267 static inline struct osp_thread_info *osp_env_info(const struct lu_env *env)
 268 {
 269         struct osp_thread_info *info;
 270
 271         info = lu_context_key_get(&env->le_ctx, &osp_thread_key);
 272         if (info == NULL) {
 273                 lu_env_refill((struct lu_env *)env);
 274                 info = lu_context_key_get(&env->le_ctx, &osp_thread_key);
 275         }
 276         LASSERT(info);
 277         return info;
 278 }
 279
 280 struct osp_txn_info {
 281         __u32   oti_current_id;
 282 };
 283
 284 extern struct lu_context_key osp_txn_key;
 285
 286 static inline struct osp_txn_info *osp_txn_info(struct lu_context *ctx)
 287 {
 288         struct osp_txn_info *info;
 289
 290         info = lu_context_key_get(ctx, &osp_txn_key);
 291         return info;
 292 }
 293
 294 extern const struct lu_device_operations osp_lu_ops;
 295
 296 static inline int lu_device_is_osp(struct lu_device *d)
 297 {
 298         return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &osp_lu_ops);
 299 }
 300
 301 static inline struct osp_device *lu2osp_dev(struct lu_device *d)
 302 {
 303         LASSERT(lu_device_is_osp(d));
 304         return container_of0(d, struct osp_device, opd_dt_dev.dd_lu_dev);
 305 }
 306
 307 static inline struct lu_device *osp2lu_dev(struct osp_device *d)
 308 {
 309         return &d->opd_dt_dev.dd_lu_dev;
 310 }
 311
 312 static inline struct osp_device *dt2osp_dev(struct dt_device *d)
 313 {
 314         LASSERT(lu_device_is_osp(&d->dd_lu_dev));
 315         return container_of0(d, struct osp_device, opd_dt_dev);
 316 }
 317
 318 static inline struct osp_object *lu2osp_obj(struct lu_object *o)
 319 {
 320         LASSERT(ergo(o != NULL, lu_device_is_osp(o->lo_dev)));
 321         return container_of0(o, struct osp_object, opo_obj.do_lu);
 322 }
 323
 324 static inline struct lu_object *osp2lu_obj(struct osp_object *obj)
 325 {
 326         return &obj->opo_obj.do_lu;
 327 }
 328
 329 static inline struct osp_object *osp_obj(const struct lu_object *o)
 330 {
 331         LASSERT(lu_device_is_osp(o->lo_dev));
 332         return container_of0(o, struct osp_object, opo_obj.do_lu);
 333 }
 334
 335 static inline struct osp_object *dt2osp_obj(const struct dt_object *d)
 336 {
 337         return osp_obj(&d->do_lu);
 338 }
 339
 340 static inline struct dt_object *osp_object_child(struct osp_object *o)
 341 {
 342         return container_of0(lu_object_next(osp2lu_obj(o)),
 343                              struct dt_object, do_lu);
 344 }
 345
 346 static inline struct seq_server_site *osp_seq_site(struct osp_device *osp)
 347 {
 348         return osp->opd_dt_dev.dd_lu_dev.ld_site->ld_seq_site;
 349 }
 350
 351 #define osp_init_rpc_lock(lck) mdc_init_rpc_lock(lck)
 352 #define osp_get_rpc_lock(lck, it)  mdc_get_rpc_lock(lck, it)
 353 #define osp_put_rpc_lock(lck, it) mdc_put_rpc_lock(lck, it)
 354
 355 static inline void osp_update_last_fid(struct osp_device *d, struct lu_fid *fid)
 356 {
 357         int diff = lu_fid_diff(fid, &d->opd_last_used_fid);
 358         /*
 359          * we might have lost precreated objects due to VBR and precreate
 360          * orphans, the gap in objid can be calculated properly only here
 361          */
 362         if (diff > 0) {
 363                 if (diff > 1) {
 364                         d->opd_gap_start_fid = d->opd_last_used_fid;
 365                         d->opd_gap_start_fid.f_oid++;
 366                         d->opd_gap_count = diff - 1;
 367                         CDEBUG(D_HA, "Gap in objids: start="DFID", count =%d\n",
 368                                PFID(&d->opd_gap_start_fid), d->opd_gap_count);
 369                 }
 370                 d->opd_last_used_fid = *fid;
 371         }
 372 }
 373
 374 static int osp_fid_end_seq(const struct lu_env *env, struct lu_fid *fid)
 375 {
 376         if (fid_is_idif(fid)) {
 377                 struct osp_thread_info *info = osp_env_info(env);
 378                 struct ost_id *oi = &info->osi_oi;
 379
 380                 fid_to_ostid(fid, oi);
 381                 return ostid_id(oi) == IDIF_MAX_OID;
 382         } else {
 383                 return fid_oid(fid) == LUSTRE_DATA_SEQ_MAX_WIDTH;
 384         }
 385 }
 386
 387 static inline int osp_precreate_end_seq_nolock(const struct lu_env *env,
 388                                                struct osp_device *osp)
 389 {
 390         struct lu_fid *fid = &osp->opd_pre_last_created_fid;
 391
 392         return osp_fid_end_seq(env, fid);
 393 }
 394
 395 static inline int osp_precreate_end_seq(const struct lu_env *env,
 396                                         struct osp_device *osp)
 397 {
 398         int rc;
 399
 400         spin_lock(&osp->opd_pre_lock);
 401         rc = osp_precreate_end_seq_nolock(env, osp);
 402         spin_unlock(&osp->opd_pre_lock);
 403         return rc;
 404 }
 405
 406 static inline int osp_is_fid_client(struct osp_device *osp)
 407 {
 408         struct obd_import *imp = osp->opd_obd->u.cli.cl_import;
 409
 410         return imp->imp_connect_data.ocd_connect_flags & OBD_CONNECT_FID;
 411 }
 412
 413 /* osp_dev.c */
 414 void osp_update_last_id(struct osp_device *d, obd_id objid);
 415 extern struct llog_operations osp_mds_ost_orig_logops;
 416
 417 /* osp_md_object.c */
 418 int osp_trans_start(const struct lu_env *env, struct dt_device *dt,
 419                     struct thandle *th);
 420 int osp_trans_stop(const struct lu_env *env, struct thandle *th);
 421 /* osp_precreate.c */
 422 int osp_init_precreate(struct osp_device *d);
 423 int osp_precreate_reserve(const struct lu_env *env, struct osp_device *d);
 424 __u64 osp_precreate_get_id(struct osp_device *d);
 425 int osp_precreate_get_fid(const struct lu_env *env, struct osp_device *d,
 426                           struct lu_fid *fid);
 427 void osp_precreate_fini(struct osp_device *d);
 428 int osp_object_truncate(const struct lu_env *env, struct dt_object *dt, __u64);
 429 void osp_pre_update_status(struct osp_device *d, int rc);
 430 void osp_statfs_need_now(struct osp_device *d);
 431 int osp_reset_last_used(const struct lu_env *env, struct osp_device *osp);
 432 int osp_write_last_oid_seq_files(struct lu_env *env, struct osp_device *osp,
 433                                  struct lu_fid *fid, int sync);
 434 int osp_init_pre_fid(struct osp_device *osp);
 435
 436 /* lproc_osp.c */
 437 void lprocfs_osp_init_vars(struct lprocfs_static_vars *lvars);
 438 void osp_lprocfs_init(struct osp_device *osp);
 439
 440 /* osp_sync.c */
 441 int osp_sync_declare_add(const struct lu_env *env, struct osp_object *o,
 442                          llog_op_type type, struct thandle *th);
 443 int osp_sync_add(const struct lu_env *env, struct osp_object *o,
 444                  llog_op_type type, struct thandle *th,
 445                  const struct lu_attr *attr);
 446 int osp_sync_init(const struct lu_env *env, struct osp_device *d);
 447 int osp_sync_fini(struct osp_device *d);
 448 void __osp_sync_check_for_work(struct osp_device *d);
 449
 450 /* lwp_dev.c */
 451 void lprocfs_lwp_init_vars(struct lprocfs_static_vars *lvars);
 452 extern struct obd_ops lwp_obd_device_ops;
 453 extern struct lu_device_type lwp_device_type;
 454
 455 #endif