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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2012, 2017, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  *
  32  * lustre/osp/osp_internal.h
  33  *
  34  * Author: Alex Zhuravlev <alexey.zhuravlev@intel.com>
  35  */
  36
  37 #ifndef _OSP_INTERNAL_H
  38 #define _OSP_INTERNAL_H
  39
  40 #include <obd.h>
  41 #include <obd_class.h>
  42 #include <dt_object.h>
  43 #include <md_object.h>
  44 #include <lustre_fid.h>
  45 #include <lustre_update.h>
  46 #include <lu_target.h>
  47 #include <lustre_mdc.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         __u64                    otr_next_id;
  55         __u64                    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         struct list_head         otr_wakeup_list;
  60         struct list_head         otr_list;
  61         /* underlying shared device */
  62         struct dt_device        *otr_dev;
  63         /* how many users of this tracker */
  64         atomic_t                 otr_refcount;
  65 };
  66
  67 struct osp_precreate {
  68         /*
  69          * Precreation pool
  70          */
  71
  72         /* last fid to assign in creation */
  73         struct lu_fid                    osp_pre_used_fid;
  74         /* last created id OST reported, next-created - available id's */
  75         struct lu_fid                    osp_pre_last_created_fid;
  76         /* how many ids are reserved in declare, we shouldn't block in create */
  77         __u64                            osp_pre_reserved;
  78         /* consumers (who needs new ids) wait here */
  79         wait_queue_head_t                osp_pre_user_waitq;
  80         /* current precreation status: working, failed, stopping? */
  81         int                              osp_pre_status;
  82         /* how many objects to precreate next time */
  83         int                              osp_pre_create_count;
  84         int                              osp_pre_min_create_count;
  85         int                              osp_pre_max_create_count;
  86         /* whether to increase precreation window next time or not */
  87         int                              osp_pre_create_slow;
  88         /* cleaning up orphans or recreating missing objects */
  89         int                              osp_pre_recovering;
  90 };
  91
  92 struct osp_update_request_sub {
  93         struct object_update_request    *ours_req; /* may be vmalloc'd */
  94         size_t                          ours_req_size;
  95         /* Linked to osp_update_request->our_req_list */
  96         struct list_head                ours_list;
  97 };
  98
  99 struct osp_update_request {
 100         int                             our_flags;
 101         /* update request result */
 102         int                             our_rc;
 103
 104         /* List of osp_update_request_sub */
 105         struct list_head                our_req_list;
 106         int                             our_req_nr;
 107         int                             our_update_nr;
 108
 109         struct list_head                our_cb_items;
 110         struct list_head                our_invalidate_cb_list;
 111
 112         /* points to thandle if this update request belongs to one */
 113         struct osp_thandle              *our_th;
 114
 115         __u64                           our_version;
 116         __u64                           our_generation;
 117         /* protect our_list and flag */
 118         spinlock_t                      our_list_lock;
 119         /* linked to the list(ou_list) in osp_updates */
 120         struct list_head                our_list;
 121         __u32                           our_batchid;
 122         __u32                           our_req_ready:1;
 123
 124 };
 125
 126 struct osp_updates {
 127         struct list_head        ou_list;
 128         spinlock_t              ou_lock;
 129         wait_queue_head_t       ou_waitq;
 130
 131         /* The next rpc version which supposed to be sent in
 132          * osp_send_update_thread().*/
 133         __u64                   ou_rpc_version;
 134
 135         /* The rpc version assigned to the osp thandle during (osp_md_write()),
 136          * which will be sent by this order. Note: the osp_thandle has be sent
 137          * by this order to make sure the remote update log will follow the
 138          * llog format rule. XXX: these probably should be removed once we
 139          * invent new llog format */
 140         __u64                   ou_version;
 141
 142         /* The generation of current osp update RPC, which is used to make sure
 143          * those stale RPC(with older generation) will not be sent, otherwise it
 144          * will cause update lllog corruption */
 145         __u64                   ou_generation;
 146 };
 147
 148 struct osp_device {
 149         struct dt_device                 opd_dt_dev;
 150         /* corresponded OST index */
 151         int                              opd_index;
 152
 153         /* corrsponded MDT index, which will be used when connecting to OST
 154          * for validating the connection (see ofd_parse_connect_data) */
 155         int                              opd_group;
 156         /* device used to store persistent state (llogs, last ids) */
 157         struct obd_export               *opd_storage_exp;
 158         struct dt_device                *opd_storage;
 159         struct dt_object                *opd_last_used_oid_file;
 160         struct dt_object                *opd_last_used_seq_file;
 161
 162         /* stored persistently in LE format, updated directly to/from disk
 163          * and required le64_to_cpu() conversion before use.
 164          * Protected by opd_pre_lock */
 165         struct lu_fid                   opd_last_used_fid;
 166         struct lu_fid                   opd_gap_start_fid;
 167         int                              opd_gap_count;
 168         /* connection to OST */
 169         struct obd_device               *opd_obd;
 170         struct obd_export               *opd_exp;
 171         struct obd_uuid                  opd_cluuid;
 172         struct obd_connect_data         *opd_connect_data;
 173         int                              opd_connects;
 174         /* connection status. */
 175         unsigned int                     opd_new_connection:1,
 176                                          opd_got_disconnected:1,
 177                                          opd_imp_connected:1,
 178                                          opd_imp_active:1,
 179                                          opd_imp_seen_connected:1,
 180                                          opd_connect_mdt:1;
 181
 182         /* whether local recovery is completed:
 183          * reported via ->ldo_recovery_complete() */
 184         int                              opd_recovery_completed;
 185
 186         /* precreate structure for OSP */
 187         struct osp_precreate            *opd_pre;
 188         /* dedicate precreate thread */
 189         struct ptlrpc_thread             opd_pre_thread;
 190         spinlock_t                       opd_pre_lock;
 191         /* thread waits for signals about pool going empty */
 192         wait_queue_head_t                opd_pre_waitq;
 193
 194         /* send update thread */
 195         struct osp_updates              *opd_update;
 196         /* dedicate update thread */
 197         struct ptlrpc_thread             opd_update_thread;
 198
 199         /*
 200          * OST synchronization thread
 201          */
 202         spinlock_t                       opd_sync_lock;
 203         /* unique generation, to recognize start of new records in the llog */
 204         struct llog_gen                  opd_sync_generation;
 205         /* number of changes to sync, used to wake up sync thread */
 206         atomic_t                         opd_sync_changes;
 207         /* processing of changes from previous mount is done? */
 208         int                              opd_sync_prev_done;
 209         /* found records */
 210         struct ptlrpc_thread             opd_sync_thread;
 211         wait_queue_head_t                opd_sync_waitq;
 212         /* list of in flight rpcs */
 213         struct list_head                 opd_sync_in_flight_list;
 214         /* list of remotely committed rpc */
 215         struct list_head                 opd_sync_committed_there;
 216         /* number of RPCs in flight - flow control */
 217         atomic_t                         opd_sync_rpcs_in_flight;
 218         int                              opd_sync_max_rpcs_in_flight;
 219         /* number of RPC in processing (including non-committed by OST) */
 220         atomic_t                         opd_sync_rpcs_in_progress;
 221         int                              opd_sync_max_rpcs_in_progress;
 222         /* osd api's commit cb control structure */
 223         struct dt_txn_callback           opd_sync_txn_cb;
 224         /* last used change number -- semantically similar to transno */
 225         unsigned long                    opd_sync_last_used_id;
 226         /* last committed change number -- semantically similar to
 227          * last_committed */
 228         __u64                            opd_sync_last_committed_id;
 229         /* last processed catalog index */
 230         int                              opd_sync_last_catalog_idx;
 231         /* number of processed records */
 232         atomic64_t                       opd_sync_processed_recs;
 233         /* stop processing new requests until barrier=0 */
 234         atomic_t                         opd_sync_barrier;
 235         wait_queue_head_t                opd_sync_barrier_waitq;
 236         /* last generated id */
 237         ktime_t                          opd_sync_next_commit_cb;
 238         atomic_t                         opd_commits_registered;
 239
 240         /*
 241          * statfs related fields: OSP maintains it on its own
 242          */
 243         struct obd_statfs                opd_statfs;
 244         ktime_t                          opd_statfs_fresh_till;
 245         struct timer_list                opd_statfs_timer;
 246         int                              opd_statfs_update_in_progress;
 247         /* how often to update statfs data */
 248         time64_t                         opd_statfs_maxage;
 249
 250         struct dentry                   *opd_debugfs;
 251
 252         /* If the caller wants to do some idempotent async operations on
 253          * remote server, it can append the async remote requests on the
 254          * osp_device::opd_async_requests via declare() functions, these
 255          * requests can be packed together and sent to the remote server
 256          * via single OUT RPC later. */
 257         struct osp_update_request       *opd_async_requests;
 258         /* Protect current operations on opd_async_requests. */
 259         struct mutex                     opd_async_requests_mutex;
 260         struct list_head                 opd_async_updates;
 261         struct rw_semaphore              opd_async_updates_rwsem;
 262         atomic_t                         opd_async_updates_count;
 263
 264         /*
 265          * Limit the object allocation using ENOSPC for opd_pre_status
 266          */
 267         int                             opd_reserved_mb_high;
 268         int                             opd_reserved_mb_low;
 269 };
 270
 271 #define opd_pre_used_fid                opd_pre->osp_pre_used_fid
 272 #define opd_pre_last_created_fid        opd_pre->osp_pre_last_created_fid
 273 #define opd_pre_reserved                opd_pre->osp_pre_reserved
 274 #define opd_pre_user_waitq              opd_pre->osp_pre_user_waitq
 275 #define opd_pre_status                  opd_pre->osp_pre_status
 276 #define opd_pre_create_count            opd_pre->osp_pre_create_count
 277 #define opd_pre_min_create_count        opd_pre->osp_pre_min_create_count
 278 #define opd_pre_max_create_count        opd_pre->osp_pre_max_create_count
 279 #define opd_pre_create_slow             opd_pre->osp_pre_create_slow
 280 #define opd_pre_recovering              opd_pre->osp_pre_recovering
 281
 282 extern struct kmem_cache *osp_object_kmem;
 283
 284 /* The first part of oxe_buf is xattr name, and is '\0' terminated.
 285  * The left part is for value, binary mode. */
 286 struct osp_xattr_entry {
 287         struct list_head         oxe_list;
 288         atomic_t                 oxe_ref;
 289         void                    *oxe_value;
 290         size_t                   oxe_buflen;
 291         size_t                   oxe_namelen;
 292         size_t                   oxe_vallen;
 293         unsigned int             oxe_exist:1,
 294                                  oxe_ready:1;
 295         char                     oxe_buf[0];
 296 };
 297
 298 /* this is a top object */
 299 struct osp_object {
 300         struct lu_object_header opo_header;
 301         struct dt_object        opo_obj;
 302         unsigned int            opo_reserved:1,
 303                                 opo_non_exist:1,
 304                                 opo_stale:1;
 305
 306         /* read/write lock for md osp object */
 307         struct rw_semaphore     opo_sem;
 308         const struct lu_env     *opo_owner;
 309         struct lu_attr          opo_attr;
 310         struct list_head        opo_xattr_list;
 311         struct list_head        opo_invalidate_cb_list;
 312         /* Protect opo_ooa. */
 313         spinlock_t              opo_lock;
 314 };
 315
 316 extern struct lu_object_operations osp_lu_obj_ops;
 317 extern const struct dt_device_operations osp_dt_ops;
 318 extern struct dt_object_operations osp_md_obj_ops;
 319 extern struct dt_body_operations osp_md_body_ops;
 320
 321 struct osp_thread_info {
 322         struct lu_buf            osi_lb;
 323         struct lu_buf            osi_lb2;
 324         struct lu_fid            osi_fid;
 325         struct lu_attr           osi_attr;
 326         struct ost_id            osi_oi;
 327         struct ost_id            osi_oi2;
 328         u64                      osi_id;
 329         loff_t                   osi_off;
 330         union {
 331                 struct llog_rec_hdr             osi_hdr;
 332                 struct llog_unlink64_rec        osi_unlink;
 333                 struct llog_setattr64_rec_v2    osi_setattr;
 334                 struct llog_gen_rec             osi_gen;
 335         };
 336         struct llog_cookie       osi_cookie;
 337         struct llog_catid        osi_cid;
 338         struct lu_seq_range      osi_seq;
 339         struct ldlm_res_id       osi_resid;
 340         struct obdo              osi_obdo;
 341 };
 342
 343 /* Iterator for OSP */
 344 struct osp_it {
 345         __u32                     ooi_pos_page;
 346         __u32                     ooi_pos_lu_page;
 347         __u32                     ooi_attr;
 348         __u32                     ooi_rec_size;
 349         int                       ooi_pos_ent;
 350         int                       ooi_total_npages;
 351         int                       ooi_valid_npages;
 352         unsigned int              ooi_swab:1;
 353         __u64                     ooi_next;
 354         struct dt_object         *ooi_obj;
 355         void                     *ooi_ent;
 356         struct page              *ooi_cur_page;
 357         struct lu_idxpage        *ooi_cur_idxpage;
 358         struct page              **ooi_pages;
 359 };
 360
 361 #define OSP_THANDLE_MAGIC       0x20141214
 362 struct osp_thandle {
 363         struct thandle           ot_super;
 364
 365         /* OSP will use this thandle to update last oid*/
 366         struct thandle          *ot_storage_th;
 367         __u32                    ot_magic;
 368         struct list_head         ot_commit_dcb_list;
 369         struct list_head         ot_stop_dcb_list;
 370         struct osp_update_request *ot_our;
 371         atomic_t                 ot_refcount;
 372 };
 373
 374 static inline struct osp_thandle *
 375 thandle_to_osp_thandle(struct thandle *th)
 376 {
 377         return container_of(th, struct osp_thandle, ot_super);
 378 }
 379
 380 static inline struct osp_update_request *
 381 thandle_to_osp_update_request(struct thandle *th)
 382 {
 383         struct osp_thandle *oth;
 384
 385         oth = thandle_to_osp_thandle(th);
 386         return oth->ot_our;
 387 }
 388
 389 /* The transaction only include the updates on the remote node, and
 390  * no local updates at all */
 391 static inline bool is_only_remote_trans(struct thandle *th)
 392 {
 393         return th->th_top == NULL;
 394 }
 395
 396 static inline void osp_objid_buf_prep(struct lu_buf *buf, loff_t *off,
 397                                       __u64 *id, int index)
 398 {
 399         /* Note: through id is only 32 bits, it will also write 64 bits
 400          * for oid to keep compatibility with the previous version. */
 401         buf->lb_buf = (void *)id;
 402         buf->lb_len = sizeof(u64);
 403         *off = sizeof(u64) * index;
 404 }
 405
 406 static inline void osp_objseq_buf_prep(struct lu_buf *buf, loff_t *off,
 407                                        __u64 *seq, int index)
 408 {
 409         buf->lb_buf = (void *)seq;
 410         buf->lb_len = sizeof(u64);
 411         *off = sizeof(u64) * index;
 412 }
 413
 414 static inline void osp_buf_prep(struct lu_buf *lb, void *buf, int buf_len)
 415 {
 416         lb->lb_buf = buf;
 417         lb->lb_len = buf_len;
 418 }
 419
 420 extern struct lu_context_key osp_thread_key;
 421
 422 static inline struct osp_thread_info *osp_env_info(const struct lu_env *env)
 423 {
 424         struct osp_thread_info *info;
 425
 426         info = lu_context_key_get(&env->le_ctx, &osp_thread_key);
 427         if (info == NULL) {
 428                 lu_env_refill((struct lu_env *)env);
 429                 info = lu_context_key_get(&env->le_ctx, &osp_thread_key);
 430         }
 431         LASSERT(info);
 432         return info;
 433 }
 434
 435 struct osp_txn_info {
 436         __u64   oti_current_id;
 437 };
 438
 439 extern struct lu_context_key osp_txn_key;
 440
 441 static inline struct osp_txn_info *osp_txn_info(struct lu_context *ctx)
 442 {
 443         struct osp_txn_info *info;
 444
 445         info = lu_context_key_get(ctx, &osp_txn_key);
 446         return info;
 447 }
 448
 449 extern const struct lu_device_operations osp_lu_ops;
 450
 451 static inline int lu_device_is_osp(struct lu_device *d)
 452 {
 453         return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &osp_lu_ops);
 454 }
 455
 456 static inline struct osp_device *lu2osp_dev(struct lu_device *d)
 457 {
 458         LASSERT(lu_device_is_osp(d));
 459         return container_of0(d, struct osp_device, opd_dt_dev.dd_lu_dev);
 460 }
 461
 462 static inline struct lu_device *osp2lu_dev(struct osp_device *d)
 463 {
 464         return &d->opd_dt_dev.dd_lu_dev;
 465 }
 466
 467 static inline struct osp_device *dt2osp_dev(struct dt_device *d)
 468 {
 469         LASSERT(lu_device_is_osp(&d->dd_lu_dev));
 470         return container_of0(d, struct osp_device, opd_dt_dev);
 471 }
 472
 473 static inline struct osp_object *lu2osp_obj(struct lu_object *o)
 474 {
 475         LASSERT(ergo(o != NULL, lu_device_is_osp(o->lo_dev)));
 476         return container_of0(o, struct osp_object, opo_obj.do_lu);
 477 }
 478
 479 static inline struct lu_object *osp2lu_obj(struct osp_object *obj)
 480 {
 481         return &obj->opo_obj.do_lu;
 482 }
 483
 484 static inline struct osp_object *osp_obj(const struct lu_object *o)
 485 {
 486         LASSERT(lu_device_is_osp(o->lo_dev));
 487         return container_of0(o, struct osp_object, opo_obj.do_lu);
 488 }
 489
 490 static inline struct osp_object *dt2osp_obj(const struct dt_object *d)
 491 {
 492         return osp_obj(&d->do_lu);
 493 }
 494
 495 static inline struct dt_object *osp_object_child(struct osp_object *o)
 496 {
 497         return container_of0(lu_object_next(osp2lu_obj(o)),
 498                              struct dt_object, do_lu);
 499 }
 500
 501 static inline struct seq_server_site *osp_seq_site(struct osp_device *osp)
 502 {
 503         return osp->opd_dt_dev.dd_lu_dev.ld_site->ld_seq_site;
 504 }
 505
 506 #define osp_init_rpc_lock(lck) mdc_init_rpc_lock(lck)
 507
 508 static inline void osp_get_rpc_lock(struct osp_device *osp)
 509 {
 510         struct mdc_rpc_lock *rpc_lock = osp->opd_obd->u.cli.cl_rpc_lock;
 511
 512         mdc_get_rpc_lock(rpc_lock, NULL);
 513 }
 514
 515 static inline void osp_put_rpc_lock(struct osp_device *osp)
 516 {
 517         struct mdc_rpc_lock *rpc_lock = osp->opd_obd->u.cli.cl_rpc_lock;
 518
 519         mdc_put_rpc_lock(rpc_lock, NULL);
 520 }
 521
 522 static inline int osp_fid_diff(const struct lu_fid *fid1,
 523                                const struct lu_fid *fid2)
 524 {
 525         /* In 2.6+ ost_idx is packed into IDIF FID, while in 2.4 and 2.5 IDIF
 526          * is always FID_SEQ_IDIF(0x100000000ULL), which does not include OST
 527          * index in the seq. So we can not compare IDIF FID seq here */
 528         if (fid_is_idif(fid1) && fid_is_idif(fid2)) {
 529                 __u32 ost_idx1 = fid_idif_ost_idx(fid1);
 530                 __u32 ost_idx2 = fid_idif_ost_idx(fid2);
 531
 532                 LASSERTF(ost_idx1 == 0 || ost_idx2 == 0 || ost_idx1 == ost_idx2,
 533                          "fid1: "DFID", fid2: "DFID"\n", PFID(fid1),
 534                          PFID(fid2));
 535
 536                 return fid_idif_id(fid1->f_seq, fid1->f_oid, 0) -
 537                        fid_idif_id(fid2->f_seq, fid2->f_oid, 0);
 538         }
 539
 540         LASSERTF(fid_seq(fid1) == fid_seq(fid2), "fid1:"DFID
 541                  ", fid2:"DFID"\n", PFID(fid1), PFID(fid2));
 542
 543         return fid_oid(fid1) - fid_oid(fid2);
 544 }
 545
 546
 547 static inline void osp_update_last_fid(struct osp_device *d, struct lu_fid *fid)
 548 {
 549         int diff = osp_fid_diff(fid, &d->opd_last_used_fid);
 550         struct lu_fid *gap_start = &d->opd_gap_start_fid;
 551         /*
 552          * we might have lost precreated objects due to VBR and precreate
 553          * orphans, the gap in objid can be calculated properly only here
 554          */
 555         if (diff > 0) {
 556                 if (diff > 1) {
 557                         d->opd_gap_start_fid = d->opd_last_used_fid;
 558                         if (fid_oid(gap_start) == LUSTRE_DATA_SEQ_MAX_WIDTH) {
 559                                 gap_start->f_seq++;
 560                                 gap_start->f_oid = fid_is_idif(gap_start) ?
 561                                                                0 : 1;
 562                         } else {
 563                                 gap_start->f_oid++;
 564                         }
 565                         d->opd_gap_count = diff - 1;
 566                         CDEBUG(D_HA, "Gap in objids: start="DFID", count =%d\n",
 567                                PFID(&d->opd_gap_start_fid), d->opd_gap_count);
 568                 }
 569                 d->opd_last_used_fid = *fid;
 570         }
 571 }
 572
 573 static int osp_fid_end_seq(const struct lu_env *env, struct lu_fid *fid)
 574 {
 575         if (fid_is_idif(fid)) {
 576                 struct osp_thread_info *info = osp_env_info(env);
 577                 struct ost_id *oi = &info->osi_oi;
 578
 579                 fid_to_ostid(fid, oi);
 580                 return ostid_id(oi) == IDIF_MAX_OID;
 581         } else {
 582                 return fid_oid(fid) == LUSTRE_DATA_SEQ_MAX_WIDTH;
 583         }
 584 }
 585
 586 static inline int osp_precreate_end_seq_nolock(const struct lu_env *env,
 587                                                struct osp_device *osp)
 588 {
 589         struct lu_fid *fid = &osp->opd_pre_last_created_fid;
 590
 591         return osp_fid_end_seq(env, fid);
 592 }
 593
 594 static inline int osp_precreate_end_seq(const struct lu_env *env,
 595                                         struct osp_device *osp)
 596 {
 597         int rc;
 598
 599         spin_lock(&osp->opd_pre_lock);
 600         rc = osp_precreate_end_seq_nolock(env, osp);
 601         spin_unlock(&osp->opd_pre_lock);
 602         return rc;
 603 }
 604
 605 static inline int osp_is_fid_client(struct osp_device *osp)
 606 {
 607         struct obd_import *imp = osp->opd_obd->u.cli.cl_import;
 608
 609         return imp->imp_connect_data.ocd_connect_flags & OBD_CONNECT_FID;
 610 }
 611
 612 struct object_update *
 613 update_buffer_get_update(struct object_update_request *request,
 614                          unsigned int index);
 615
 616 int osp_extend_update_buffer(const struct lu_env *env,
 617                              struct osp_update_request *our);
 618
 619 struct osp_update_request_sub *
 620 osp_current_object_update_request(struct osp_update_request *our);
 621
 622 int osp_object_update_request_create(struct osp_update_request *our,
 623                                      size_t size);
 624
 625 #define OSP_UPDATE_RPC_PACK(env, out_something_pack, our, ...)          \
 626 ({                                                                      \
 627         struct object_update *object_update;                            \
 628         size_t max_update_length;                                       \
 629         struct osp_update_request_sub *ours;                            \
 630         int ret;                                                        \
 631                                                                         \
 632         while (1) {                                                     \
 633                 ours = osp_current_object_update_request(our);          \
 634                 LASSERT(ours != NULL);                                  \
 635                 max_update_length = ours->ours_req_size -               \
 636                             object_update_request_size(ours->ours_req); \
 637                                                                         \
 638                 object_update = update_buffer_get_update(ours->ours_req,\
 639                                          ours->ours_req->ourq_count);   \
 640                 ret = out_something_pack(env, object_update,            \
 641                                          &max_update_length,            \
 642                                          __VA_ARGS__);                  \
 643                 if (ret == -E2BIG) {                                    \
 644                         int rc1;                                        \
 645                         /* Create new object update request */          \
 646                         rc1 = osp_object_update_request_create(our,     \
 647                                 max_update_length  +                    \
 648                                 offsetof(struct object_update_request,  \
 649                                          ourq_updates[0]) + 1);         \
 650                         if (rc1 != 0) {                                 \
 651                                 ret = rc1;                              \
 652                                 break;                                  \
 653                         }                                               \
 654                         continue;                                       \
 655                 } else {                                                \
 656                         if (ret == 0) {                                 \
 657                                 ours->ours_req->ourq_count++;           \
 658                                 (our)->our_update_nr++;                 \
 659                                 object_update->ou_batchid =             \
 660                                                      (our)->our_batchid;\
 661                                 object_update->ou_flags |=              \
 662                                                      (our)->our_flags;  \
 663                         }                                               \
 664                         break;                                          \
 665                 }                                                       \
 666         }                                                               \
 667         ret;                                                            \
 668 })
 669
 670 static inline bool osp_send_update_thread_running(struct osp_device *osp)
 671 {
 672         return osp->opd_update_thread.t_flags & SVC_RUNNING;
 673 }
 674
 675 static inline bool osp_send_update_thread_stopped(struct osp_device *osp)
 676 {
 677         return osp->opd_update_thread.t_flags & SVC_STOPPED;
 678 }
 679
 680 typedef int (*osp_update_interpreter_t)(const struct lu_env *env,
 681                                         struct object_update_reply *rep,
 682                                         struct ptlrpc_request *req,
 683                                         struct osp_object *obj,
 684                                         void *data, int index, int rc);
 685
 686 /* osp_dev.c */
 687 void osp_update_last_id(struct osp_device *d, u64 objid);
 688
 689 /* osp_trans.c */
 690 int osp_insert_async_request(const struct lu_env *env, enum update_type op,
 691                              struct osp_object *obj, int count, __u16 *lens,
 692                              const void **bufs, void *data, __u32 repsize,
 693                              osp_update_interpreter_t interpreter);
 694
 695 int osp_unplug_async_request(const struct lu_env *env,
 696                              struct osp_device *osp,
 697                              struct osp_update_request *update);
 698 int osp_trans_update_request_create(struct thandle *th);
 699 struct thandle *osp_trans_create(const struct lu_env *env,
 700                                  struct dt_device *d);
 701 int osp_trans_start(const struct lu_env *env, struct dt_device *dt,
 702                     struct thandle *th);
 703 int osp_insert_update_callback(const struct lu_env *env,
 704                                struct osp_update_request *update,
 705                                struct osp_object *obj, void *data,
 706                                osp_update_interpreter_t interpreter);
 707
 708 struct osp_update_request *osp_update_request_create(struct dt_device *dt);
 709 void osp_update_request_destroy(const struct lu_env *env,
 710                                 struct osp_update_request *update);
 711
 712 int osp_send_update_thread(void *arg);
 713 int osp_check_and_set_rpc_version(struct osp_thandle *oth,
 714                                   struct osp_object *obj);
 715
 716 void osp_thandle_destroy(const struct lu_env *env, struct osp_thandle *oth);
 717 static inline void osp_thandle_get(struct osp_thandle *oth)
 718 {
 719         atomic_inc(&oth->ot_refcount);
 720 }
 721
 722 static inline void osp_thandle_put(const struct lu_env *env,
 723                                    struct osp_thandle *oth)
 724 {
 725         if (atomic_dec_and_test(&oth->ot_refcount))
 726                 osp_thandle_destroy(env, oth);
 727 }
 728
 729 int osp_prep_update_req(const struct lu_env *env, struct obd_import *imp,
 730                         struct osp_update_request *our,
 731                         struct ptlrpc_request **reqp);
 732 int osp_remote_sync(const struct lu_env *env, struct osp_device *osp,
 733                     struct osp_update_request *update,
 734                     struct ptlrpc_request **reqp);
 735
 736 struct thandle *osp_get_storage_thandle(const struct lu_env *env,
 737                                         struct thandle *th,
 738                                         struct osp_device *osp);
 739 void osp_trans_callback(const struct lu_env *env,
 740                         struct osp_thandle *oth, int rc);
 741 void osp_invalidate_request(struct osp_device *osp);
 742 /* osp_object.c */
 743 int osp_attr_get(const struct lu_env *env, struct dt_object *dt,
 744                  struct lu_attr *attr);
 745 int osp_xattr_get(const struct lu_env *env, struct dt_object *dt,
 746                   struct lu_buf *buf, const char *name);
 747 int osp_declare_xattr_set(const struct lu_env *env, struct dt_object *dt,
 748                           const struct lu_buf *buf, const char *name,
 749                           int flag, struct thandle *th);
 750 int osp_xattr_set(const struct lu_env *env, struct dt_object *dt,
 751                   const struct lu_buf *buf, const char *name, int fl,
 752                   struct thandle *th);
 753 int osp_declare_xattr_del(const struct lu_env *env, struct dt_object *dt,
 754                           const char *name, struct thandle *th);
 755 int osp_xattr_del(const struct lu_env *env, struct dt_object *dt,
 756                   const char *name, struct thandle *th);
 757 int osp_invalidate(const struct lu_env *env, struct dt_object *dt);
 758 void osp_obj_invalidate_cache(struct osp_object *obj);
 759
 760 int osp_trans_stop(const struct lu_env *env, struct dt_device *dt,
 761                    struct thandle *th);
 762 int osp_trans_cb_add(struct thandle *th, struct dt_txn_commit_cb *dcb);
 763
 764 struct dt_it *osp_it_init(const struct lu_env *env, struct dt_object *dt,
 765                           __u32 attr);
 766 void osp_it_fini(const struct lu_env *env, struct dt_it *di);
 767 int osp_it_get(const struct lu_env *env, struct dt_it *di,
 768                const struct dt_key *key);
 769 void osp_it_put(const struct lu_env *env, struct dt_it *di);
 770 __u64 osp_it_store(const struct lu_env *env, const struct dt_it *di);
 771 int osp_it_key_rec(const struct lu_env *env, const struct dt_it *di,
 772                    void *key_rec);
 773 int osp_it_next_page(const struct lu_env *env, struct dt_it *di);
 774 /* osp_md_object.c */
 775 int osp_md_declare_create(const struct lu_env *env, struct dt_object *dt,
 776                           struct lu_attr *attr, struct dt_allocation_hint *hint,
 777                           struct dt_object_format *dof, struct thandle *th);
 778 int osp_md_create(const struct lu_env *env, struct dt_object *dt,
 779                   struct lu_attr *attr, struct dt_allocation_hint *hint,
 780                   struct dt_object_format *dof, struct thandle *th);
 781 int osp_md_declare_attr_set(const struct lu_env *env, struct dt_object *dt,
 782                             const struct lu_attr *attr, struct thandle *th);
 783 int osp_md_attr_set(const struct lu_env *env, struct dt_object *dt,
 784                     const struct lu_attr *attr, struct thandle *th);
 785 extern const struct dt_index_operations osp_md_index_ops;
 786
 787 /* osp_precreate.c */
 788 int osp_init_precreate(struct osp_device *d);
 789 int osp_precreate_reserve(const struct lu_env *env, struct osp_device *d);
 790 __u64 osp_precreate_get_id(struct osp_device *d);
 791 int osp_precreate_get_fid(const struct lu_env *env, struct osp_device *d,
 792                           struct lu_fid *fid);
 793 void osp_precreate_fini(struct osp_device *d);
 794 int osp_object_truncate(const struct lu_env *env, struct dt_object *dt, __u64);
 795 void osp_pre_update_status(struct osp_device *d, int rc);
 796 void osp_statfs_need_now(struct osp_device *d);
 797 int osp_reset_last_used(const struct lu_env *env, struct osp_device *osp);
 798 int osp_write_last_oid_seq_files(struct lu_env *env, struct osp_device *osp,
 799                                  struct lu_fid *fid, int sync);
 800 int osp_init_pre_fid(struct osp_device *osp);
 801 int osp_init_statfs(struct osp_device *osp);
 802 void osp_fini_statfs(struct osp_device *osp);
 803 void osp_statfs_fini(struct osp_device *d);
 804
 805 /* lproc_osp.c */
 806 void osp_tunables_init(struct osp_device *osp);
 807 void osp_tunables_fini(struct osp_device *osp);
 808
 809 /* osp_sync.c */
 810 int osp_sync_declare_add(const struct lu_env *env, struct osp_object *o,
 811                          enum llog_op_type type, struct thandle *th);
 812 int osp_sync_add(const struct lu_env *env, struct osp_object *o,
 813                  enum llog_op_type type, struct thandle *th,
 814                  const struct lu_attr *attr);
 815 int osp_sync_init(const struct lu_env *env, struct osp_device *d);
 816 int osp_sync_fini(struct osp_device *d);
 817 void osp_sync_check_for_work(struct osp_device *osp);
 818 void osp_sync_force(const struct lu_env *env, struct osp_device *d);
 819 int osp_sync_add_commit_cb_1s(const struct lu_env *env, struct osp_device *d,
 820                               struct thandle *th);
 821
 822 /* lwp_dev.c */
 823 extern struct obd_ops lwp_obd_device_ops;
 824 extern struct lu_device_type lwp_device_type;
 825
 826 static inline struct lu_device *osp2top(const struct osp_device *osp)
 827 {
 828         return osp->opd_dt_dev.dd_lu_dev.ld_site->ls_top_dev;
 829 }
 830
 831 static inline void osp_set_req_replay(const struct osp_device *osp,
 832                                       struct ptlrpc_request *req)
 833 {
 834         struct obd_device *obd = osp2top(osp)->ld_obd;
 835
 836         /* The RPC must be recovery related for the cases:
 837          *
 838          * 1. sent during recovery, or
 839          * 2. sent before the recovery thread target_recovery_thread() start,
 840          *    such as triggered by lod_sub_recovery_thread(). */
 841         if (obd->obd_recovering || (obd->obd_replayable && obd->obd_no_conn))
 842                 req->rq_allow_replay = 1;
 843 }
 844
 845 #endif