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 #include <lustre_update.h>
  50 #include <lu_target.h>
  51
  52 /*
  53  * Infrastructure to support tracking of last committed llog record
  54  */
  55 struct osp_id_tracker {
  56         spinlock_t               otr_lock;
  57         __u32                    otr_next_id;
  58         __u32                    otr_committed_id;
  59         /* callback is register once per diskfs -- that's the whole point */
  60         struct dt_txn_callback   otr_tx_cb;
  61         /* single node can run many clusters */
  62         cfs_list_t               otr_wakeup_list;
  63         cfs_list_t               otr_list;
  64         /* underlying shared device */
  65         struct dt_device        *otr_dev;
  66         /* how many users of this tracker */
  67         cfs_atomic_t             otr_refcount;
  68 };
  69
  70 struct osp_precreate {
  71         /*
  72          * Precreation pool
  73          */
  74         spinlock_t                       osp_pre_lock;
  75
  76         /* last fid to assign in creation */
  77         struct lu_fid                    osp_pre_used_fid;
  78         /* last created id OST reported, next-created - available id's */
  79         struct lu_fid                    osp_pre_last_created_fid;
  80         /* how many ids are reserved in declare, we shouldn't block in create */
  81         __u64                            osp_pre_reserved;
  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         unsigned int                     opd_new_connection:1,
 126                                          opd_got_disconnected:1,
 127                                          opd_imp_connected:1,
 128                                          opd_imp_active:1,
 129                                          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         /* thread waits for signals about pool going empty */
 141         wait_queue_head_t                opd_pre_waitq;
 142
 143         /*
 144          * OST synchronization
 145          */
 146         spinlock_t                       opd_syn_lock;
 147         /* unique generation, to recognize start of new records in the llog */
 148         struct llog_gen                  opd_syn_generation;
 149         /* number of changes to sync, used to wake up sync thread */
 150         unsigned long                    opd_syn_changes;
 151         /* processing of changes from previous mount is done? */
 152         int                              opd_syn_prev_done;
 153         /* found records */
 154         struct ptlrpc_thread             opd_syn_thread;
 155         wait_queue_head_t                opd_syn_waitq;
 156         /* list of remotely committed rpc */
 157         cfs_list_t                       opd_syn_committed_there;
 158         /* number of changes being under sync */
 159         int                              opd_syn_sync_in_progress;
 160         /* number of RPCs in flight - flow control */
 161         int                              opd_syn_rpc_in_flight;
 162         int                              opd_syn_max_rpc_in_flight;
 163         /* number of RPC in processing (including non-committed by OST) */
 164         int                              opd_syn_rpc_in_progress;
 165         int                              opd_syn_max_rpc_in_progress;
 166         /* osd api's commit cb control structure */
 167         struct dt_txn_callback           opd_syn_txn_cb;
 168         /* last used change number -- semantically similar to transno */
 169         unsigned long                    opd_syn_last_used_id;
 170         /* last committed change number -- semantically similar to
 171          * last_committed */
 172         unsigned long                    opd_syn_last_committed_id;
 173         /* last processed (taken from llog) id */
 174         unsigned long                    opd_syn_last_processed_id;
 175         struct osp_id_tracker           *opd_syn_tracker;
 176         cfs_list_t                       opd_syn_ontrack;
 177
 178         /*
 179          * statfs related fields: OSP maintains it on its own
 180          */
 181         struct obd_statfs                opd_statfs;
 182         cfs_time_t                       opd_statfs_fresh_till;
 183         struct timer_list                        opd_statfs_timer;
 184         int                              opd_statfs_update_in_progress;
 185         /* how often to update statfs data */
 186         int                              opd_statfs_maxage;
 187
 188         cfs_proc_dir_entry_t            *opd_symlink;
 189
 190         /* If the caller wants to do some idempotent async operations on
 191          * remote server, it can append the async remote requests on the
 192          * osp_device::opd_async_requests via declare() functions, these
 193          * requests can be packed together and sent to the remote server
 194          * via single OUT RPC later. */
 195         struct update_request           *opd_async_requests;
 196         /* Protect current operations on opd_async_requests. */
 197         struct mutex                     opd_async_requests_mutex;
 198         struct semaphore                 opd_async_fc_sem;
 199 };
 200
 201 #define opd_pre_lock                    opd_pre->osp_pre_lock
 202 #define opd_pre_used_fid                opd_pre->osp_pre_used_fid
 203 #define opd_pre_last_created_fid        opd_pre->osp_pre_last_created_fid
 204 #define opd_pre_reserved                opd_pre->osp_pre_reserved
 205 #define opd_pre_user_waitq              opd_pre->osp_pre_user_waitq
 206 #define opd_pre_status                  opd_pre->osp_pre_status
 207 #define opd_pre_grow_count              opd_pre->osp_pre_grow_count
 208 #define opd_pre_min_grow_count          opd_pre->osp_pre_min_grow_count
 209 #define opd_pre_max_grow_count          opd_pre->osp_pre_max_grow_count
 210 #define opd_pre_grow_slow               opd_pre->osp_pre_grow_slow
 211 #define opd_pre_recovering              opd_pre->osp_pre_recovering
 212
 213 extern struct kmem_cache *osp_object_kmem;
 214
 215 /* The first part of oxe_buf is xattr name, and is '\0' terminated.
 216  * The left part is for value, binary mode. */
 217 struct osp_xattr_entry {
 218         struct list_head         oxe_list;
 219         atomic_t                 oxe_ref;
 220         void                    *oxe_value;
 221         int                      oxe_buflen;
 222         int                      oxe_namelen;
 223         int                      oxe_vallen;
 224         unsigned int             oxe_exist:1,
 225                                  oxe_ready:1;
 226         char                     oxe_buf[0];
 227 };
 228
 229 struct osp_object_attr {
 230         struct lu_attr          ooa_attr;
 231         struct list_head        ooa_xattr_list;
 232 };
 233
 234 /* this is a top object */
 235 struct osp_object {
 236         struct lu_object_header opo_header;
 237         struct dt_object        opo_obj;
 238         unsigned int            opo_reserved:1,
 239                                 opo_new:1,
 240                                 opo_empty:1,
 241                                 opo_non_exist:1;
 242
 243         /* read/write lock for md osp object */
 244         struct rw_semaphore     opo_sem;
 245         const struct lu_env     *opo_owner;
 246         struct osp_object_attr *opo_ooa;
 247         /* Protect opo_ooa. */
 248         spinlock_t              opo_lock;
 249 };
 250
 251 extern struct lu_object_operations osp_lu_obj_ops;
 252 extern const struct dt_device_operations osp_dt_ops;
 253 extern struct dt_object_operations osp_md_obj_ops;
 254
 255 struct osp_thread_info {
 256         struct lu_buf            osi_lb;
 257         struct lu_buf            osi_lb2;
 258         struct lu_fid            osi_fid;
 259         struct lu_attr           osi_attr;
 260         struct ost_id            osi_oi;
 261         struct ost_id            osi_oi2;
 262         obd_id                   osi_id;
 263         loff_t                   osi_off;
 264         union {
 265                 struct llog_rec_hdr             osi_hdr;
 266                 struct llog_unlink64_rec        osi_unlink;
 267                 struct llog_setattr64_rec       osi_setattr;
 268                 struct llog_gen_rec             osi_gen;
 269         };
 270         struct llog_cookie       osi_cookie;
 271         struct llog_catid        osi_cid;
 272         struct lu_seq_range      osi_seq;
 273         struct ldlm_res_id       osi_resid;
 274         struct obdo              osi_obdo;
 275 };
 276
 277 /* The transaction only include the updates on the remote node, and
 278  * no local updates at all */
 279 static inline bool is_only_remote_trans(struct thandle *th)
 280 {
 281         return th->th_dev != NULL && th->th_dev->dd_ops == &osp_dt_ops;
 282 }
 283
 284 static inline void osp_objid_buf_prep(struct lu_buf *buf, loff_t *off,
 285                                       __u32 *id, int index)
 286 {
 287         buf->lb_buf = (void *)id;
 288         buf->lb_len = sizeof(obd_id);
 289         *off = sizeof(obd_id) * index;
 290 }
 291
 292 static inline void osp_objseq_buf_prep(struct lu_buf *buf, loff_t *off,
 293                                        __u64 *seq, int index)
 294 {
 295         buf->lb_buf = (void *)seq;
 296         buf->lb_len = sizeof(obd_id);
 297         *off = sizeof(obd_id) * index;
 298 }
 299
 300 static inline void osp_buf_prep(struct lu_buf *lb, void *buf, int buf_len)
 301 {
 302         lb->lb_buf = buf;
 303         lb->lb_len = buf_len;
 304 }
 305
 306 extern struct lu_context_key osp_thread_key;
 307
 308 static inline struct osp_thread_info *osp_env_info(const struct lu_env *env)
 309 {
 310         struct osp_thread_info *info;
 311
 312         info = lu_context_key_get(&env->le_ctx, &osp_thread_key);
 313         if (info == NULL) {
 314                 lu_env_refill((struct lu_env *)env);
 315                 info = lu_context_key_get(&env->le_ctx, &osp_thread_key);
 316         }
 317         LASSERT(info);
 318         return info;
 319 }
 320
 321 struct osp_txn_info {
 322         __u32   oti_current_id;
 323 };
 324
 325 extern struct lu_context_key osp_txn_key;
 326
 327 static inline struct osp_txn_info *osp_txn_info(struct lu_context *ctx)
 328 {
 329         struct osp_txn_info *info;
 330
 331         info = lu_context_key_get(ctx, &osp_txn_key);
 332         return info;
 333 }
 334
 335 extern const struct lu_device_operations osp_lu_ops;
 336
 337 static inline int lu_device_is_osp(struct lu_device *d)
 338 {
 339         return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &osp_lu_ops);
 340 }
 341
 342 static inline struct osp_device *lu2osp_dev(struct lu_device *d)
 343 {
 344         LASSERT(lu_device_is_osp(d));
 345         return container_of0(d, struct osp_device, opd_dt_dev.dd_lu_dev);
 346 }
 347
 348 static inline struct lu_device *osp2lu_dev(struct osp_device *d)
 349 {
 350         return &d->opd_dt_dev.dd_lu_dev;
 351 }
 352
 353 static inline struct osp_device *dt2osp_dev(struct dt_device *d)
 354 {
 355         LASSERT(lu_device_is_osp(&d->dd_lu_dev));
 356         return container_of0(d, struct osp_device, opd_dt_dev);
 357 }
 358
 359 static inline struct osp_object *lu2osp_obj(struct lu_object *o)
 360 {
 361         LASSERT(ergo(o != NULL, lu_device_is_osp(o->lo_dev)));
 362         return container_of0(o, struct osp_object, opo_obj.do_lu);
 363 }
 364
 365 static inline struct lu_object *osp2lu_obj(struct osp_object *obj)
 366 {
 367         return &obj->opo_obj.do_lu;
 368 }
 369
 370 static inline struct osp_object *osp_obj(const struct lu_object *o)
 371 {
 372         LASSERT(lu_device_is_osp(o->lo_dev));
 373         return container_of0(o, struct osp_object, opo_obj.do_lu);
 374 }
 375
 376 static inline struct osp_object *dt2osp_obj(const struct dt_object *d)
 377 {
 378         return osp_obj(&d->do_lu);
 379 }
 380
 381 static inline struct dt_object *osp_object_child(struct osp_object *o)
 382 {
 383         return container_of0(lu_object_next(osp2lu_obj(o)),
 384                              struct dt_object, do_lu);
 385 }
 386
 387 static inline struct seq_server_site *osp_seq_site(struct osp_device *osp)
 388 {
 389         return osp->opd_dt_dev.dd_lu_dev.ld_site->ld_seq_site;
 390 }
 391
 392 #define osp_init_rpc_lock(lck) mdc_init_rpc_lock(lck)
 393 #define osp_get_rpc_lock(lck, it)  mdc_get_rpc_lock(lck, it)
 394 #define osp_put_rpc_lock(lck, it) mdc_put_rpc_lock(lck, it)
 395
 396 static inline void osp_update_last_fid(struct osp_device *d, struct lu_fid *fid)
 397 {
 398         int diff = lu_fid_diff(fid, &d->opd_last_used_fid);
 399         /*
 400          * we might have lost precreated objects due to VBR and precreate
 401          * orphans, the gap in objid can be calculated properly only here
 402          */
 403         if (diff > 0) {
 404                 if (diff > 1) {
 405                         d->opd_gap_start_fid = d->opd_last_used_fid;
 406                         d->opd_gap_start_fid.f_oid++;
 407                         d->opd_gap_count = diff - 1;
 408                         CDEBUG(D_HA, "Gap in objids: start="DFID", count =%d\n",
 409                                PFID(&d->opd_gap_start_fid), d->opd_gap_count);
 410                 }
 411                 d->opd_last_used_fid = *fid;
 412         }
 413 }
 414
 415 static int osp_fid_end_seq(const struct lu_env *env, struct lu_fid *fid)
 416 {
 417         if (fid_is_idif(fid)) {
 418                 struct osp_thread_info *info = osp_env_info(env);
 419                 struct ost_id *oi = &info->osi_oi;
 420
 421                 fid_to_ostid(fid, oi);
 422                 return ostid_id(oi) == IDIF_MAX_OID;
 423         } else {
 424                 return fid_oid(fid) == LUSTRE_DATA_SEQ_MAX_WIDTH;
 425         }
 426 }
 427
 428 static inline int osp_precreate_end_seq_nolock(const struct lu_env *env,
 429                                                struct osp_device *osp)
 430 {
 431         struct lu_fid *fid = &osp->opd_pre_last_created_fid;
 432
 433         return osp_fid_end_seq(env, fid);
 434 }
 435
 436 static inline int osp_precreate_end_seq(const struct lu_env *env,
 437                                         struct osp_device *osp)
 438 {
 439         int rc;
 440
 441         spin_lock(&osp->opd_pre_lock);
 442         rc = osp_precreate_end_seq_nolock(env, osp);
 443         spin_unlock(&osp->opd_pre_lock);
 444         return rc;
 445 }
 446
 447 static inline int osp_is_fid_client(struct osp_device *osp)
 448 {
 449         struct obd_import *imp = osp->opd_obd->u.cli.cl_import;
 450
 451         return imp->imp_connect_data.ocd_connect_flags & OBD_CONNECT_FID;
 452 }
 453
 454 typedef int (*osp_async_update_interpterer_t)(const struct lu_env *env,
 455                                               struct update_reply *reply,
 456                                               struct osp_object *obj,
 457                                               void *data, int index, int rc);
 458
 459 /* osp_dev.c */
 460 void osp_update_last_id(struct osp_device *d, obd_id objid);
 461 extern struct llog_operations osp_mds_ost_orig_logops;
 462
 463 /* osp_trans.c */
 464 struct update_request *
 465 osp_find_or_create_async_update_request(struct osp_device *osp);
 466 int osp_insert_async_update(const struct lu_env *env,
 467                             struct update_request *update, int op,
 468                             struct osp_object *obj, int count,
 469                             int *lens, const char **bufs, void *data,
 470                             osp_async_update_interpterer_t interpterer);
 471 int osp_unplug_async_update(const struct lu_env *env,
 472                             struct osp_device *osp,
 473                             struct update_request *update);
 474 struct thandle *osp_trans_create(const struct lu_env *env,
 475                                  struct dt_device *d);
 476 int osp_trans_start(const struct lu_env *env, struct dt_device *dt,
 477                     struct thandle *th);
 478
 479 /* osp_object.c */
 480 int osp_attr_get(const struct lu_env *env, struct dt_object *dt,
 481                  struct lu_attr *attr, struct lustre_capa *capa);
 482 int osp_xattr_get(const struct lu_env *env, struct dt_object *dt,
 483                   struct lu_buf *buf, const char *name,
 484                   struct lustre_capa *capa);
 485 int osp_declare_xattr_set(const struct lu_env *env, struct dt_object *dt,
 486                           const struct lu_buf *buf, const char *name,
 487                           int flag, struct thandle *th);
 488 int osp_xattr_set(const struct lu_env *env, struct dt_object *dt,
 489                   const struct lu_buf *buf, const char *name, int fl,
 490                   struct thandle *th, struct lustre_capa *capa);
 491 int osp_declare_object_destroy(const struct lu_env *env,
 492                                struct dt_object *dt, struct thandle *th);
 493 int osp_object_destroy(const struct lu_env *env, struct dt_object *dt,
 494                        struct thandle *th);
 495
 496 int osp_trans_stop(const struct lu_env *env, struct dt_device *dt,
 497                    struct thandle *th);
 498
 499 /* osp_md_object.c */
 500 int osp_md_declare_object_create(const struct lu_env *env,
 501                                  struct dt_object *dt,
 502                                  struct lu_attr *attr,
 503                                  struct dt_allocation_hint *hint,
 504                                  struct dt_object_format *dof,
 505                                  struct thandle *th);
 506 int osp_md_object_create(const struct lu_env *env, struct dt_object *dt,
 507                          struct lu_attr *attr, struct dt_allocation_hint *hint,
 508                          struct dt_object_format *dof, struct thandle *th);
 509 int osp_md_declare_attr_set(const struct lu_env *env, struct dt_object *dt,
 510                             const struct lu_attr *attr, struct thandle *th);
 511 int osp_md_attr_set(const struct lu_env *env, struct dt_object *dt,
 512                     const struct lu_attr *attr, struct thandle *th,
 513                     struct lustre_capa *capa);
 514 /* osp_precreate.c */
 515 int osp_init_precreate(struct osp_device *d);
 516 int osp_precreate_reserve(const struct lu_env *env, struct osp_device *d);
 517 __u64 osp_precreate_get_id(struct osp_device *d);
 518 int osp_precreate_get_fid(const struct lu_env *env, struct osp_device *d,
 519                           struct lu_fid *fid);
 520 void osp_precreate_fini(struct osp_device *d);
 521 int osp_object_truncate(const struct lu_env *env, struct dt_object *dt, __u64);
 522 void osp_pre_update_status(struct osp_device *d, int rc);
 523 void osp_statfs_need_now(struct osp_device *d);
 524 int osp_reset_last_used(const struct lu_env *env, struct osp_device *osp);
 525 int osp_write_last_oid_seq_files(struct lu_env *env, struct osp_device *osp,
 526                                  struct lu_fid *fid, int sync);
 527 int osp_init_pre_fid(struct osp_device *osp);
 528
 529 /* lproc_osp.c */
 530 void lprocfs_osp_init_vars(struct lprocfs_static_vars *lvars);
 531 void osp_lprocfs_init(struct osp_device *osp);
 532
 533 /* osp_sync.c */
 534 int osp_sync_declare_add(const struct lu_env *env, struct osp_object *o,
 535                          llog_op_type type, struct thandle *th);
 536 int osp_sync_add(const struct lu_env *env, struct osp_object *o,
 537                  llog_op_type type, struct thandle *th,
 538                  const struct lu_attr *attr);
 539 int osp_sync_init(const struct lu_env *env, struct osp_device *d);
 540 int osp_sync_fini(struct osp_device *d);
 541 void __osp_sync_check_for_work(struct osp_device *d);
 542
 543 /* lwp_dev.c */
 544 void lprocfs_lwp_init_vars(struct lprocfs_static_vars *lvars);
 545 extern struct obd_ops lwp_obd_device_ops;
 546 extern struct lu_device_type lwp_device_type;
 547
 548 #endif