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, 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 <lustre_fid.h>
  48
  49 /*
  50  * Infrastructure to support tracking of last committed llog record
  51  */
  52 struct osp_id_tracker {
  53         spinlock_t               otr_lock;
  54         __u32                    otr_next_id;
  55         __u32                    otr_committed_id;
  56         /* callback is register once per diskfs -- that's the whole point */
  57         struct dt_txn_callback   otr_tx_cb;
  58         /* single node can run many clusters */
  59         cfs_list_t               otr_wakeup_list;
  60         cfs_list_t               otr_list;
  61         /* underlying shared device */
  62         struct dt_device        *otr_dev;
  63         /* how many users of this tracker */
  64         cfs_atomic_t             otr_refcount;
  65 };
  66
  67 struct osp_device {
  68         struct dt_device                 opd_dt_dev;
  69         /* corresponded OST index */
  70         int                              opd_index;
  71         /* device used to store persistent state (llogs, last ids) */
  72         struct obd_export               *opd_storage_exp;
  73         struct dt_device                *opd_storage;
  74         struct dt_object                *opd_last_used_file;
  75
  76         /* stored persistently in LE format, updated directly to/from disk
  77          * and required le64_to_cpu() conversion before use.
  78          * Protected by opd_pre_lock */
  79         volatile obd_id                  opd_last_used_id;
  80
  81         obd_id                           opd_gap_start;
  82         int                              opd_gap_count;
  83         /* connection to OST */
  84         struct obd_device               *opd_obd;
  85         struct obd_export               *opd_exp;
  86         struct obd_uuid                  opd_cluuid;
  87         struct obd_connect_data         *opd_connect_data;
  88         int                              opd_connects;
  89         cfs_proc_dir_entry_t            *opd_proc_entry;
  90         struct lprocfs_stats            *opd_stats;
  91         /* connection status. */
  92         int                              opd_new_connection;
  93         int                              opd_got_disconnected;
  94         int                              opd_imp_connected;
  95         int                              opd_imp_active;
  96         int                              opd_imp_seen_connected:1;
  97
  98         /* whether local recovery is completed:
  99          * reported via ->ldo_recovery_complete() */
 100         int                              opd_recovery_completed;
 101
 102         /*
 103          * Precreation pool
 104          */
 105         spinlock_t                       opd_pre_lock;
 106         /* last id assigned in creation */
 107         __u64                            opd_pre_used_id;
 108         /* last created id OST reported, next-created - available id's */
 109         __u64                            opd_pre_last_created;
 110         /* how many ids are reserved in declare, we shouldn't block in create */
 111         __u64                            opd_pre_reserved;
 112         /* dedicate precreate thread */
 113         struct ptlrpc_thread             opd_pre_thread;
 114         /* thread waits for signals about pool going empty */
 115         cfs_waitq_t                      opd_pre_waitq;
 116         /* consumers (who needs new ids) wait here */
 117         cfs_waitq_t                      opd_pre_user_waitq;
 118         /* current precreation status: working, failed, stopping? */
 119         int                              opd_pre_status;
 120         /* how many to precreate next time */
 121         int                              opd_pre_grow_count;
 122         int                              opd_pre_min_grow_count;
 123         int                              opd_pre_max_grow_count;
 124         /* whether to grow precreation window next time or not */
 125         int                              opd_pre_grow_slow;
 126         /* cleaning up orphans or recreating missing objects */
 127         int                              opd_pre_recovering;
 128
 129         /*
 130          * OST synchronization
 131          */
 132         spinlock_t                       opd_syn_lock;
 133         /* unique generation, to recognize start of new records in the llog */
 134         struct llog_gen                  opd_syn_generation;
 135         /* number of changes to sync, used to wake up sync thread */
 136         unsigned long                    opd_syn_changes;
 137         /* processing of changes from previous mount is done? */
 138         int                              opd_syn_prev_done;
 139         /* found records */
 140         struct ptlrpc_thread             opd_syn_thread;
 141         cfs_waitq_t                      opd_syn_waitq;
 142         /* list of remotely committed rpc */
 143         cfs_list_t                       opd_syn_committed_there;
 144         /* number of changes being under sync */
 145         int                              opd_syn_sync_in_progress;
 146         /* number of RPCs in flight - flow control */
 147         int                              opd_syn_rpc_in_flight;
 148         int                              opd_syn_max_rpc_in_flight;
 149         /* number of RPC in processing (including non-committed by OST) */
 150         int                              opd_syn_rpc_in_progress;
 151         int                              opd_syn_max_rpc_in_progress;
 152         /* osd api's commit cb control structure */
 153         struct dt_txn_callback           opd_syn_txn_cb;
 154         /* last used change number -- semantically similar to transno */
 155         unsigned long                    opd_syn_last_used_id;
 156         /* last committed change number -- semantically similar to
 157          * last_committed */
 158         unsigned long                    opd_syn_last_committed_id;
 159         /* last processed (taken from llog) id */
 160         unsigned long                    opd_syn_last_processed_id;
 161         struct osp_id_tracker           *opd_syn_tracker;
 162         cfs_list_t                       opd_syn_ontrack;
 163
 164         /*
 165          * statfs related fields: OSP maintains it on its own
 166          */
 167         struct obd_statfs                opd_statfs;
 168         cfs_time_t                       opd_statfs_fresh_till;
 169         cfs_timer_t                      opd_statfs_timer;
 170         int                              opd_statfs_update_in_progress;
 171         /* how often to update statfs data */
 172         int                              opd_statfs_maxage;
 173
 174         cfs_proc_dir_entry_t            *opd_symlink;
 175 };
 176
 177 extern cfs_mem_cache_t *osp_object_kmem;
 178
 179 /* this is a top object */
 180 struct osp_object {
 181         struct lu_object_header  opo_header;
 182         struct dt_object         opo_obj;
 183         int                      opo_reserved:1,
 184                                  opo_new:1;
 185 };
 186
 187 extern struct lu_object_operations osp_lu_obj_ops;
 188 extern const struct dt_device_operations osp_dt_ops;
 189
 190 struct osp_thread_info {
 191         struct lu_buf            osi_lb;
 192         struct lu_fid            osi_fid;
 193         struct lu_attr           osi_attr;
 194         struct ost_id            osi_oi;
 195         obd_id                   osi_id;
 196         loff_t                   osi_off;
 197         union {
 198                 struct llog_rec_hdr             osi_hdr;
 199                 struct llog_unlink64_rec        osi_unlink;
 200                 struct llog_setattr64_rec       osi_setattr;
 201                 struct llog_gen_rec             osi_gen;
 202         };
 203         struct llog_cookie       osi_cookie;
 204         struct llog_catid        osi_cid;
 205 };
 206
 207 static inline void osp_objid_buf_prep(struct osp_thread_info *osi,
 208                                       struct osp_device *d, int index)
 209 {
 210         osi->osi_lb.lb_buf = (void *)&d->opd_last_used_id;
 211         osi->osi_lb.lb_len = sizeof(d->opd_last_used_id);
 212         osi->osi_off = sizeof(d->opd_last_used_id) * index;
 213 }
 214
 215 extern struct lu_context_key osp_thread_key;
 216
 217 static inline struct osp_thread_info *osp_env_info(const struct lu_env *env)
 218 {
 219         struct osp_thread_info *info;
 220
 221         info = lu_context_key_get(&env->le_ctx, &osp_thread_key);
 222         if (info == NULL) {
 223                 lu_env_refill((struct lu_env *)env);
 224                 info = lu_context_key_get(&env->le_ctx, &osp_thread_key);
 225         }
 226         LASSERT(info);
 227         return info;
 228 }
 229
 230 struct osp_txn_info {
 231         __u32   oti_current_id;
 232 };
 233
 234 extern struct lu_context_key osp_txn_key;
 235
 236 static inline struct osp_txn_info *osp_txn_info(struct lu_context *ctx)
 237 {
 238         struct osp_txn_info *info;
 239
 240         info = lu_context_key_get(ctx, &osp_txn_key);
 241         return info;
 242 }
 243
 244 extern const struct lu_device_operations osp_lu_ops;
 245
 246 static inline int lu_device_is_osp(struct lu_device *d)
 247 {
 248         return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &osp_lu_ops);
 249 }
 250
 251 static inline struct osp_device *lu2osp_dev(struct lu_device *d)
 252 {
 253         LASSERT(lu_device_is_osp(d));
 254         return container_of0(d, struct osp_device, opd_dt_dev.dd_lu_dev);
 255 }
 256
 257 static inline struct lu_device *osp2lu_dev(struct osp_device *d)
 258 {
 259         return &d->opd_dt_dev.dd_lu_dev;
 260 }
 261
 262 static inline struct osp_device *dt2osp_dev(struct dt_device *d)
 263 {
 264         LASSERT(lu_device_is_osp(&d->dd_lu_dev));
 265         return container_of0(d, struct osp_device, opd_dt_dev);
 266 }
 267
 268 static inline struct osp_object *lu2osp_obj(struct lu_object *o)
 269 {
 270         LASSERT(ergo(o != NULL, lu_device_is_osp(o->lo_dev)));
 271         return container_of0(o, struct osp_object, opo_obj.do_lu);
 272 }
 273
 274 static inline struct lu_object *osp2lu_obj(struct osp_object *obj)
 275 {
 276         return &obj->opo_obj.do_lu;
 277 }
 278
 279 static inline struct osp_object *osp_obj(const struct lu_object *o)
 280 {
 281         LASSERT(lu_device_is_osp(o->lo_dev));
 282         return container_of0(o, struct osp_object, opo_obj.do_lu);
 283 }
 284
 285 static inline struct osp_object *dt2osp_obj(const struct dt_object *d)
 286 {
 287         return osp_obj(&d->do_lu);
 288 }
 289
 290 static inline struct dt_object *osp_object_child(struct osp_object *o)
 291 {
 292         return container_of0(lu_object_next(osp2lu_obj(o)),
 293                              struct dt_object, do_lu);
 294 }
 295
 296 /* osp_dev.c */
 297 void osp_update_last_id(struct osp_device *d, obd_id objid);
 298
 299 /* osp_precreate.c */
 300 int osp_init_precreate(struct osp_device *d);
 301 int osp_precreate_reserve(const struct lu_env *env, struct osp_device *d);
 302 __u64 osp_precreate_get_id(struct osp_device *d);
 303 void osp_precreate_fini(struct osp_device *d);
 304 int osp_object_truncate(const struct lu_env *env, struct dt_object *dt, __u64);
 305 void osp_pre_update_status(struct osp_device *d, int rc);
 306 void osp_statfs_need_now(struct osp_device *d);
 307
 308 /* lproc_osp.c */
 309 void lprocfs_osp_init_vars(struct lprocfs_static_vars *lvars);
 310 void osp_lprocfs_init(struct osp_device *osp);
 311
 312 /* osp_sync.c */
 313 int osp_sync_declare_add(const struct lu_env *env, struct osp_object *o,
 314                          llog_op_type type, struct thandle *th);
 315 int osp_sync_add(const struct lu_env *env, struct osp_object *o,
 316                  llog_op_type type, struct thandle *th,
 317                  const struct lu_attr *attr);
 318 int osp_sync_init(const struct lu_env *env, struct osp_device *d);
 319 int osp_sync_fini(struct osp_device *d);
 320 void __osp_sync_check_for_work(struct osp_device *d);
 321
 322 /* osp_ost.c */
 323 int osp_init_for_ost(const struct lu_env *env, struct osp_device *m,
 324                      struct lu_device_type *ldt, struct lustre_cfg *cfg);
 325 int osp_disconnect(struct osp_device *d);
 326 int osp_fini_for_ost(struct osp_device *osp);
 327
 328 #endif