4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
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
27 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2012, Whamcloud, Inc.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
37 #ifndef __LUSTRE_DT_OBJECT_H
38 #define __LUSTRE_DT_OBJECT_H
41 * Sub-class of lu_object with methods common for "data" objects in OST stack.
43 * Data objects behave like regular files: you can read/write them, get and
44 * set their attributes. Implementation of dt interface is supposed to
45 * implement some form of garbage collection, normally reference counting
48 * Examples: osd (lustre/osd) is an implementation of dt interface.
54 * super-class definitions.
56 #include <lu_object.h>
58 #include <libcfs/libcfs.h>
61 struct proc_dir_entry;
67 struct dt_index_features;
73 MNTOPT_USERXATTR = 0x00000001,
74 MNTOPT_ACL = 0x00000002,
77 struct dt_device_param {
78 unsigned ddp_max_name_len;
79 unsigned ddp_max_nlink;
80 unsigned ddp_block_shift;
82 unsigned ddp_max_ea_size;
83 void *ddp_mnt; /* XXX: old code can retrieve mnt -bzzz */
85 unsigned long long ddp_maxbytes;
86 /* percentage of available space to reserve for grant error margin */
87 int ddp_grant_reserved;
88 /* per-inode space consumption */
90 /* per-fragment grant overhead to be used by client for grant
96 * Per-transaction commit callback function
98 struct dt_txn_commit_cb;
99 typedef void (*dt_cb_t)(struct lu_env *env, struct thandle *th,
100 struct dt_txn_commit_cb *cb, int err);
102 * Special per-transaction callback for cases when just commit callback
103 * is needed and per-device callback are not convenient to use
105 #define TRANS_COMMIT_CB_MAGIC 0xa0a00a0a
106 #define MAX_COMMIT_CB_STR_LEN 32
108 struct dt_txn_commit_cb {
109 cfs_list_t dcb_linkage;
112 char dcb_name[MAX_COMMIT_CB_STR_LEN];
116 * Operations on dt device.
118 struct dt_device_operations {
120 * Return device-wide statistics.
122 int (*dt_statfs)(const struct lu_env *env,
123 struct dt_device *dev, struct obd_statfs *osfs);
125 * Create transaction, described by \a param.
127 struct thandle *(*dt_trans_create)(const struct lu_env *env,
128 struct dt_device *dev);
130 * Start transaction, described by \a param.
132 int (*dt_trans_start)(const struct lu_env *env,
133 struct dt_device *dev, struct thandle *th);
135 * Finish previously started transaction.
137 int (*dt_trans_stop)(const struct lu_env *env,
140 * Add commit callback to the transaction.
142 int (*dt_trans_cb_add)(struct thandle *th,
143 struct dt_txn_commit_cb *dcb);
145 * Return fid of root index object.
147 int (*dt_root_get)(const struct lu_env *env,
148 struct dt_device *dev, struct lu_fid *f);
150 * Return device configuration data.
152 void (*dt_conf_get)(const struct lu_env *env,
153 const struct dt_device *dev,
154 struct dt_device_param *param);
156 * handling device state, mostly for tests
158 int (*dt_sync)(const struct lu_env *env, struct dt_device *dev);
159 int (*dt_ro)(const struct lu_env *env, struct dt_device *dev);
161 * Start a transaction commit asynchronously
163 * \param env environment
164 * \param dev dt_device to start commit on
166 * \return 0 success, negative value if error
168 int (*dt_commit_async)(const struct lu_env *env,
169 struct dt_device *dev);
171 * Initialize capability context.
173 int (*dt_init_capa_ctxt)(const struct lu_env *env,
174 struct dt_device *dev,
175 int mode, unsigned long timeout,
176 __u32 alg, struct lustre_capa_key *keys);
178 * Initialize quota context.
180 void (*dt_init_quota_ctxt)(const struct lu_env *env,
181 struct dt_device *dev,
182 struct dt_quota_ctxt *ctxt, void *data);
185 struct dt_index_features {
186 /** required feature flags from enum dt_index_flags */
188 /** minimal required key size */
189 size_t dif_keysize_min;
190 /** maximal required key size, 0 if no limit */
191 size_t dif_keysize_max;
192 /** minimal required record size */
193 size_t dif_recsize_min;
194 /** maximal required record size, 0 if no limit */
195 size_t dif_recsize_max;
196 /** pointer size for record */
200 enum dt_index_flags {
201 /** index supports variable sized keys */
202 DT_IND_VARKEY = 1 << 0,
203 /** index supports variable sized records */
204 DT_IND_VARREC = 1 << 1,
205 /** index can be modified */
206 DT_IND_UPDATE = 1 << 2,
207 /** index supports records with non-unique (duplicate) keys */
208 DT_IND_NONUNQ = 1 << 3,
210 * index support fixed-size keys sorted with natural numerical way
211 * and is able to return left-side value if no exact value found
213 DT_IND_RANGE = 1 << 4,
217 * Features, required from index to support file system directories (mapping
220 extern const struct dt_index_features dt_directory_features;
221 extern const struct dt_index_features dt_otable_features;
223 /* index features supported by the accounting objects */
224 extern const struct dt_index_features dt_acct_features;
226 /* index features supported by the quota global indexes */
227 extern const struct dt_index_features dt_quota_glb_features;
229 /* index features supported by the quota slave indexes */
230 extern const struct dt_index_features dt_quota_slv_features;
233 * This is a general purpose dt allocation hint.
234 * It now contains the parent object.
235 * It can contain any allocation hint in the future.
237 struct dt_allocation_hint {
238 struct dt_object *dah_parent;
243 * object type specifier.
246 enum dt_format_type {
251 /** for special index */
253 /** for symbolic link */
258 * object format specifier.
260 struct dt_object_format {
261 /** type for dt object */
262 enum dt_format_type dof_type;
271 * special index need feature as parameter to create
275 const struct dt_index_features *di_feat;
280 enum dt_format_type dt_mode_to_dft(__u32 mode);
282 typedef __u64 dt_obj_version_t;
285 * Per-dt-object operations.
287 struct dt_object_operations {
288 void (*do_read_lock)(const struct lu_env *env,
289 struct dt_object *dt, unsigned role);
290 void (*do_write_lock)(const struct lu_env *env,
291 struct dt_object *dt, unsigned role);
292 void (*do_read_unlock)(const struct lu_env *env,
293 struct dt_object *dt);
294 void (*do_write_unlock)(const struct lu_env *env,
295 struct dt_object *dt);
296 int (*do_write_locked)(const struct lu_env *env,
297 struct dt_object *dt);
299 * Note: following ->do_{x,}attr_{set,get}() operations are very
300 * similar to ->moo_{x,}attr_{set,get}() operations in struct
301 * md_object_operations (see md_object.h). These operations are not in
302 * lu_object_operations, because ->do_{x,}attr_set() versions take
303 * transaction handle as an argument (this transaction is started by
304 * caller). We might factor ->do_{x,}attr_get() into
305 * lu_object_operations, but that would break existing symmetry.
309 * Return standard attributes.
311 * precondition: lu_object_exists(&dt->do_lu);
313 int (*do_attr_get)(const struct lu_env *env,
314 struct dt_object *dt, struct lu_attr *attr,
315 struct lustre_capa *capa);
317 * Set standard attributes.
319 * precondition: dt_object_exists(dt);
321 int (*do_declare_attr_set)(const struct lu_env *env,
322 struct dt_object *dt,
323 const struct lu_attr *attr,
324 struct thandle *handle);
325 int (*do_attr_set)(const struct lu_env *env,
326 struct dt_object *dt,
327 const struct lu_attr *attr,
328 struct thandle *handle,
329 struct lustre_capa *capa);
331 * Return a value of an extended attribute.
333 * precondition: dt_object_exists(dt);
335 int (*do_xattr_get)(const struct lu_env *env, struct dt_object *dt,
336 struct lu_buf *buf, const char *name,
337 struct lustre_capa *capa);
339 * Set value of an extended attribute.
341 * \a fl - flags from enum lu_xattr_flags
343 * precondition: dt_object_exists(dt);
345 int (*do_declare_xattr_set)(const struct lu_env *env,
346 struct dt_object *dt,
347 const struct lu_buf *buf,
348 const char *name, int fl,
349 struct thandle *handle);
350 int (*do_xattr_set)(const struct lu_env *env,
351 struct dt_object *dt, const struct lu_buf *buf,
352 const char *name, int fl, struct thandle *handle,
353 struct lustre_capa *capa);
355 * Delete existing extended attribute.
357 * precondition: dt_object_exists(dt);
359 int (*do_declare_xattr_del)(const struct lu_env *env,
360 struct dt_object *dt,
361 const char *name, struct thandle *handle);
362 int (*do_xattr_del)(const struct lu_env *env,
363 struct dt_object *dt,
364 const char *name, struct thandle *handle,
365 struct lustre_capa *capa);
367 * Place list of existing extended attributes into \a buf (which has
370 * precondition: dt_object_exists(dt);
372 int (*do_xattr_list)(const struct lu_env *env,
373 struct dt_object *dt, struct lu_buf *buf,
374 struct lustre_capa *capa);
376 * Init allocation hint using parent object and child mode.
377 * (1) The \a parent might be NULL if this is a partial creation for
379 * (2) The type of child is in \a child_mode.
380 * (3) The result hint is stored in \a ah;
382 void (*do_ah_init)(const struct lu_env *env,
383 struct dt_allocation_hint *ah,
384 struct dt_object *parent,
385 cfs_umode_t child_mode);
387 * Create new object on this device.
389 * precondition: !dt_object_exists(dt);
390 * postcondition: ergo(result == 0, dt_object_exists(dt));
392 int (*do_declare_create)(const struct lu_env *env,
393 struct dt_object *dt,
394 struct lu_attr *attr,
395 struct dt_allocation_hint *hint,
396 struct dt_object_format *dof,
398 int (*do_create)(const struct lu_env *env, struct dt_object *dt,
399 struct lu_attr *attr,
400 struct dt_allocation_hint *hint,
401 struct dt_object_format *dof,
405 Destroy object on this device
406 * precondition: !dt_object_exists(dt);
407 * postcondition: ergo(result == 0, dt_object_exists(dt));
409 int (*do_declare_destroy)(const struct lu_env *env,
410 struct dt_object *dt,
412 int (*do_destroy)(const struct lu_env *env, struct dt_object *dt,
416 * Announce that this object is going to be used as an index. This
417 * operation check that object supports indexing operations and
418 * installs appropriate dt_index_operations vector on success.
420 * Also probes for features. Operation is successful if all required
421 * features are supported.
423 int (*do_index_try)(const struct lu_env *env,
424 struct dt_object *dt,
425 const struct dt_index_features *feat);
427 * Add nlink of the object
428 * precondition: dt_object_exists(dt);
430 int (*do_declare_ref_add)(const struct lu_env *env,
431 struct dt_object *dt, struct thandle *th);
432 int (*do_ref_add)(const struct lu_env *env,
433 struct dt_object *dt, struct thandle *th);
435 * Del nlink of the object
436 * precondition: dt_object_exists(dt);
438 int (*do_declare_ref_del)(const struct lu_env *env,
439 struct dt_object *dt, struct thandle *th);
440 int (*do_ref_del)(const struct lu_env *env,
441 struct dt_object *dt, struct thandle *th);
443 struct obd_capa *(*do_capa_get)(const struct lu_env *env,
444 struct dt_object *dt,
445 struct lustre_capa *old,
447 int (*do_object_sync)(const struct lu_env *, struct dt_object *);
449 * Get object info of next level. Currently, only get inode from osd.
450 * This is only used by quota b=16542
451 * precondition: dt_object_exists(dt);
453 int (*do_data_get)(const struct lu_env *env, struct dt_object *dt,
458 * Per-dt-object operations on "file body".
460 struct dt_body_operations {
462 * precondition: dt_object_exists(dt);
464 ssize_t (*dbo_read)(const struct lu_env *env, struct dt_object *dt,
465 struct lu_buf *buf, loff_t *pos,
466 struct lustre_capa *capa);
468 * precondition: dt_object_exists(dt);
470 ssize_t (*dbo_declare_write)(const struct lu_env *env,
471 struct dt_object *dt,
472 const loff_t size, loff_t pos,
473 struct thandle *handle);
474 ssize_t (*dbo_write)(const struct lu_env *env, struct dt_object *dt,
475 const struct lu_buf *buf, loff_t *pos,
476 struct thandle *handle, struct lustre_capa *capa,
479 * methods for zero-copy IO
483 * precondition: dt_object_exists(dt);
487 * > 0 - number of local buffers prepared
489 int (*dbo_bufs_get)(const struct lu_env *env, struct dt_object *dt,
490 loff_t pos, ssize_t len, struct niobuf_local *lb,
491 int rw, struct lustre_capa *capa);
493 * precondition: dt_object_exists(dt);
495 int (*dbo_bufs_put)(const struct lu_env *env, struct dt_object *dt,
496 struct niobuf_local *lb, int nr);
498 * precondition: dt_object_exists(dt);
500 int (*dbo_write_prep)(const struct lu_env *env, struct dt_object *dt,
501 struct niobuf_local *lb, int nr);
503 * precondition: dt_object_exists(dt);
505 int (*dbo_declare_write_commit)(const struct lu_env *env,
506 struct dt_object *dt,
507 struct niobuf_local *,
508 int, struct thandle *);
510 * precondition: dt_object_exists(dt);
512 int (*dbo_write_commit)(const struct lu_env *env, struct dt_object *dt,
513 struct niobuf_local *, int, struct thandle *);
515 * precondition: dt_object_exists(dt);
517 int (*dbo_read_prep)(const struct lu_env *env, struct dt_object *dt,
518 struct niobuf_local *lnb, int nr);
519 int (*dbo_fiemap_get)(const struct lu_env *env, struct dt_object *dt,
520 struct ll_user_fiemap *fm);
522 * Punch object's content
523 * precondition: regular object, not index
525 int (*do_declare_punch)(const struct lu_env *, struct dt_object *,
526 __u64, __u64, struct thandle *th);
527 int (*do_punch)(const struct lu_env *env, struct dt_object *dt,
528 __u64 start, __u64 end, struct thandle *th,
529 struct lustre_capa *capa);
533 * Incomplete type of index record.
538 * Incomplete type of index key.
543 * Incomplete type of dt iterator.
548 * Per-dt-object operations on object as index.
550 struct dt_index_operations {
552 * precondition: dt_object_exists(dt);
554 int (*dio_lookup)(const struct lu_env *env, struct dt_object *dt,
555 struct dt_rec *rec, const struct dt_key *key,
556 struct lustre_capa *capa);
558 * precondition: dt_object_exists(dt);
560 int (*dio_declare_insert)(const struct lu_env *env,
561 struct dt_object *dt,
562 const struct dt_rec *rec,
563 const struct dt_key *key,
564 struct thandle *handle);
565 int (*dio_insert)(const struct lu_env *env, struct dt_object *dt,
566 const struct dt_rec *rec, const struct dt_key *key,
567 struct thandle *handle, struct lustre_capa *capa,
570 * precondition: dt_object_exists(dt);
572 int (*dio_declare_delete)(const struct lu_env *env,
573 struct dt_object *dt,
574 const struct dt_key *key,
575 struct thandle *handle);
576 int (*dio_delete)(const struct lu_env *env, struct dt_object *dt,
577 const struct dt_key *key, struct thandle *handle,
578 struct lustre_capa *capa);
584 * Allocate and initialize new iterator.
586 * precondition: dt_object_exists(dt);
588 struct dt_it *(*init)(const struct lu_env *env,
589 struct dt_object *dt,
591 struct lustre_capa *capa);
592 void (*fini)(const struct lu_env *env,
594 int (*get)(const struct lu_env *env,
596 const struct dt_key *key);
597 void (*put)(const struct lu_env *env,
599 int (*next)(const struct lu_env *env,
601 struct dt_key *(*key)(const struct lu_env *env,
602 const struct dt_it *di);
603 int (*key_size)(const struct lu_env *env,
604 const struct dt_it *di);
605 int (*rec)(const struct lu_env *env,
606 const struct dt_it *di,
609 __u64 (*store)(const struct lu_env *env,
610 const struct dt_it *di);
611 int (*load)(const struct lu_env *env,
612 const struct dt_it *di, __u64 hash);
613 int (*key_rec)(const struct lu_env *env,
614 const struct dt_it *di, void* key_rec);
618 enum dt_otable_it_valid {
619 DOIV_ERROR_HANDLE = 0x0001,
622 enum dt_otable_it_flags {
623 /* Exit when fail. */
624 DOIF_FAILOUT = 0x0001,
626 /* Reset iteration position to the device beginning. */
629 /* There is up layer component uses the iteration. */
630 DOIF_OUTUSED = 0x0004,
633 /* otable based iteration needs to use the common DT interation APIs.
634 * To initialize the iteration, it needs call dio_it::init() firstly.
635 * Here is how the otable based iteration should prepare arguments to
636 * call dt_it_ops::init().
638 * For otable based iteration, the 32-bits 'attr' for dt_it_ops::init()
639 * is composed of two parts:
640 * low 16-bits is for valid bits, high 16-bits is for flags bits. */
641 #define DT_OTABLE_IT_FLAGS_SHIFT 16
642 #define DT_OTABLE_IT_FLAGS_MASK 0xffff0000
645 struct lu_device dd_lu_dev;
646 const struct dt_device_operations *dd_ops;
649 * List of dt_txn_callback (see below). This is not protected in any
650 * way, because callbacks are supposed to be added/deleted only during
651 * single-threaded start-up shut-down procedures.
653 cfs_list_t dd_txn_callbacks;
656 int dt_device_init(struct dt_device *dev, struct lu_device_type *t);
657 void dt_device_fini(struct dt_device *dev);
659 static inline int lu_device_is_dt(const struct lu_device *d)
661 return ergo(d != NULL, d->ld_type->ldt_tags & LU_DEVICE_DT);
664 static inline struct dt_device * lu2dt_dev(struct lu_device *l)
666 LASSERT(lu_device_is_dt(l));
667 return container_of0(l, struct dt_device, dd_lu_dev);
671 struct lu_object do_lu;
672 const struct dt_object_operations *do_ops;
673 const struct dt_body_operations *do_body_ops;
674 const struct dt_index_operations *do_index_ops;
678 * In-core representation of per-device local object OID storage
680 struct local_oid_storage {
681 /* all initialized llog systems on this node linked by this */
684 /* how many handle's reference this los has */
685 cfs_atomic_t los_refcount;
686 struct dt_device *los_dev;
687 struct dt_object *los_obj;
689 /* data used to generate new fids */
690 cfs_mutex_t los_id_lock;
695 static inline struct dt_object *lu2dt(struct lu_object *l)
697 LASSERT(l == NULL || IS_ERR(l) || lu_device_is_dt(l->lo_dev));
698 return container_of0(l, struct dt_object, do_lu);
701 int dt_object_init(struct dt_object *obj,
702 struct lu_object_header *h, struct lu_device *d);
704 void dt_object_fini(struct dt_object *obj);
706 static inline int dt_object_exists(const struct dt_object *dt)
708 return lu_object_exists(&dt->do_lu);
712 * This is the general purpose transaction handle.
713 * 1. Transaction Life Cycle
714 * This transaction handle is allocated upon starting a new transaction,
715 * and deallocated after this transaction is committed.
716 * 2. Transaction Nesting
717 * We do _NOT_ support nested transaction. So, every thread should only
718 * have one active transaction, and a transaction only belongs to one
719 * thread. Due to this, transaction handle need no reference count.
720 * 3. Transaction & dt_object locking
721 * dt_object locks should be taken inside transaction.
722 * 4. Transaction & RPC
723 * No RPC request should be issued inside transaction.
726 /** the dt device on which the transactions are executed */
727 struct dt_device *th_dev;
729 /** additional tags (layers can add in declare) */
732 /** context for this transaction, tag is LCT_TX_HANDLE */
733 struct lu_context th_ctx;
735 /** the last operation result in this transaction.
736 * this value is used in recovery */
739 /** whether we need sync commit */
742 /* local transation, no need to inform other layers */
747 * Transaction call-backs.
749 * These are invoked by osd (or underlying transaction engine) when
750 * transaction changes state.
752 * Call-backs are used by upper layers to modify transaction parameters and to
753 * perform some actions on for each transaction state transition. Typical
754 * example is mdt registering call-back to write into last-received file
755 * before each transaction commit.
757 struct dt_txn_callback {
758 int (*dtc_txn_start)(const struct lu_env *env,
759 struct thandle *txn, void *cookie);
760 int (*dtc_txn_stop)(const struct lu_env *env,
761 struct thandle *txn, void *cookie);
762 void (*dtc_txn_commit)(struct thandle *txn, void *cookie);
765 cfs_list_t dtc_linkage;
768 void dt_txn_callback_add(struct dt_device *dev, struct dt_txn_callback *cb);
769 void dt_txn_callback_del(struct dt_device *dev, struct dt_txn_callback *cb);
771 int dt_txn_hook_start(const struct lu_env *env,
772 struct dt_device *dev, struct thandle *txn);
773 int dt_txn_hook_stop(const struct lu_env *env, struct thandle *txn);
774 void dt_txn_hook_commit(struct thandle *txn);
776 int dt_try_as_dir(const struct lu_env *env, struct dt_object *obj);
779 * Callback function used for parsing path.
780 * \see llo_store_resolve
782 typedef int (*dt_entry_func_t)(const struct lu_env *env,
786 #define DT_MAX_PATH 1024
788 int dt_path_parser(const struct lu_env *env,
789 char *local, dt_entry_func_t entry_func,
792 struct dt_object *dt_store_open(const struct lu_env *env,
793 struct dt_device *dt,
795 const char *filename,
798 struct dt_object *dt_find_or_create(const struct lu_env *env,
799 struct dt_device *dt,
800 const struct lu_fid *fid,
801 struct dt_object_format *dof,
802 struct lu_attr *attr);
804 struct dt_object *dt_locate_at(const struct lu_env *env,
805 struct dt_device *dev,
806 const struct lu_fid *fid,
807 struct lu_device *top_dev);
808 static inline struct dt_object *
809 dt_locate(const struct lu_env *env, struct dt_device *dev,
810 const struct lu_fid *fid)
812 return dt_locate_at(env, dev, fid, dev->dd_lu_dev.ld_site->ls_top_dev);
816 int local_oid_storage_init(const struct lu_env *env, struct dt_device *dev,
817 const struct lu_fid *first_fid,
818 struct local_oid_storage **los);
819 void local_oid_storage_fini(const struct lu_env *env,
820 struct local_oid_storage *los);
821 int local_object_fid_generate(const struct lu_env *env,
822 struct local_oid_storage *los,
824 int local_object_declare_create(const struct lu_env *env,
825 struct local_oid_storage *los,
827 struct lu_attr *attr,
828 struct dt_object_format *dof,
830 int local_object_create(const struct lu_env *env,
831 struct local_oid_storage *los,
833 struct lu_attr *attr, struct dt_object_format *dof,
835 struct dt_object *local_file_find_or_create(const struct lu_env *env,
836 struct local_oid_storage *los,
837 struct dt_object *parent,
838 const char *name, __u32 mode);
839 struct dt_object *local_file_find_or_create_with_fid(const struct lu_env *env,
840 struct dt_device *dt,
841 const struct lu_fid *fid,
842 struct dt_object *parent,
846 int dt_lookup_dir(const struct lu_env *env, struct dt_object *dir,
847 const char *name, struct lu_fid *fid);
849 static inline int dt_object_sync(const struct lu_env *env,
854 LASSERT(o->do_ops->do_object_sync);
855 return o->do_ops->do_object_sync(env, o);
858 int dt_declare_version_set(const struct lu_env *env, struct dt_object *o,
860 void dt_version_set(const struct lu_env *env, struct dt_object *o,
861 dt_obj_version_t version, struct thandle *th);
862 dt_obj_version_t dt_version_get(const struct lu_env *env, struct dt_object *o);
865 int dt_read(const struct lu_env *env, struct dt_object *dt,
866 struct lu_buf *buf, loff_t *pos);
867 int dt_record_read(const struct lu_env *env, struct dt_object *dt,
868 struct lu_buf *buf, loff_t *pos);
869 int dt_record_write(const struct lu_env *env, struct dt_object *dt,
870 const struct lu_buf *buf, loff_t *pos, struct thandle *th);
872 static inline struct thandle *dt_trans_create(const struct lu_env *env,
875 LASSERT(d->dd_ops->dt_trans_create);
876 return d->dd_ops->dt_trans_create(env, d);
879 static inline int dt_trans_start(const struct lu_env *env,
880 struct dt_device *d, struct thandle *th)
882 LASSERT(d->dd_ops->dt_trans_start);
883 return d->dd_ops->dt_trans_start(env, d, th);
886 /* for this transaction hooks shouldn't be called */
887 static inline int dt_trans_start_local(const struct lu_env *env,
888 struct dt_device *d, struct thandle *th)
890 LASSERT(d->dd_ops->dt_trans_start);
892 return d->dd_ops->dt_trans_start(env, d, th);
895 static inline int dt_trans_stop(const struct lu_env *env,
896 struct dt_device *d, struct thandle *th)
898 LASSERT(d->dd_ops->dt_trans_stop);
899 return d->dd_ops->dt_trans_stop(env, th);
902 static inline int dt_trans_cb_add(struct thandle *th,
903 struct dt_txn_commit_cb *dcb)
905 LASSERT(th->th_dev->dd_ops->dt_trans_cb_add);
906 dcb->dcb_magic = TRANS_COMMIT_CB_MAGIC;
907 return th->th_dev->dd_ops->dt_trans_cb_add(th, dcb);
912 static inline int dt_declare_record_write(const struct lu_env *env,
913 struct dt_object *dt,
914 int size, loff_t pos,
919 LASSERTF(dt != NULL, "dt is NULL when we want to write record\n");
921 LASSERT(dt->do_body_ops);
922 LASSERT(dt->do_body_ops->dbo_declare_write);
923 rc = dt->do_body_ops->dbo_declare_write(env, dt, size, pos, th);
927 static inline int dt_declare_create(const struct lu_env *env,
928 struct dt_object *dt,
929 struct lu_attr *attr,
930 struct dt_allocation_hint *hint,
931 struct dt_object_format *dof,
936 LASSERT(dt->do_ops->do_declare_create);
937 return dt->do_ops->do_declare_create(env, dt, attr, hint, dof, th);
940 static inline int dt_create(const struct lu_env *env,
941 struct dt_object *dt,
942 struct lu_attr *attr,
943 struct dt_allocation_hint *hint,
944 struct dt_object_format *dof,
949 LASSERT(dt->do_ops->do_create);
950 return dt->do_ops->do_create(env, dt, attr, hint, dof, th);
953 static inline int dt_declare_destroy(const struct lu_env *env,
954 struct dt_object *dt,
959 LASSERT(dt->do_ops->do_declare_destroy);
960 return dt->do_ops->do_declare_destroy(env, dt, th);
963 static inline int dt_destroy(const struct lu_env *env,
964 struct dt_object *dt,
969 LASSERT(dt->do_ops->do_destroy);
970 return dt->do_ops->do_destroy(env, dt, th);
973 static inline void dt_read_lock(const struct lu_env *env,
974 struct dt_object *dt,
979 LASSERT(dt->do_ops->do_read_lock);
980 dt->do_ops->do_read_lock(env, dt, role);
983 static inline void dt_write_lock(const struct lu_env *env,
984 struct dt_object *dt,
989 LASSERT(dt->do_ops->do_write_lock);
990 dt->do_ops->do_write_lock(env, dt, role);
993 static inline void dt_read_unlock(const struct lu_env *env,
994 struct dt_object *dt)
998 LASSERT(dt->do_ops->do_read_unlock);
999 dt->do_ops->do_read_unlock(env, dt);
1002 static inline void dt_write_unlock(const struct lu_env *env,
1003 struct dt_object *dt)
1006 LASSERT(dt->do_ops);
1007 LASSERT(dt->do_ops->do_write_unlock);
1008 dt->do_ops->do_write_unlock(env, dt);
1011 static inline int dt_write_locked(const struct lu_env *env,
1012 struct dt_object *dt)
1015 LASSERT(dt->do_ops);
1016 LASSERT(dt->do_ops->do_write_locked);
1017 return dt->do_ops->do_write_locked(env, dt);
1020 static inline int dt_attr_get(const struct lu_env *env, struct dt_object *dt,
1021 struct lu_attr *la, void *arg)
1024 LASSERT(dt->do_ops);
1025 LASSERT(dt->do_ops->do_attr_get);
1026 return dt->do_ops->do_attr_get(env, dt, la, arg);
1029 static inline int dt_declare_attr_set(const struct lu_env *env,
1030 struct dt_object *dt,
1031 const struct lu_attr *la,
1035 LASSERT(dt->do_ops);
1036 LASSERT(dt->do_ops->do_declare_attr_set);
1037 return dt->do_ops->do_declare_attr_set(env, dt, la, th);
1040 static inline int dt_attr_set(const struct lu_env *env, struct dt_object *dt,
1041 const struct lu_attr *la, struct thandle *th,
1042 struct lustre_capa *capa)
1045 LASSERT(dt->do_ops);
1046 LASSERT(dt->do_ops->do_attr_set);
1047 return dt->do_ops->do_attr_set(env, dt, la, th, capa);
1050 static inline int dt_declare_ref_add(const struct lu_env *env,
1051 struct dt_object *dt, struct thandle *th)
1054 LASSERT(dt->do_ops);
1055 LASSERT(dt->do_ops->do_declare_ref_add);
1056 return dt->do_ops->do_declare_ref_add(env, dt, th);
1059 static inline int dt_ref_add(const struct lu_env *env,
1060 struct dt_object *dt, struct thandle *th)
1063 LASSERT(dt->do_ops);
1064 LASSERT(dt->do_ops->do_ref_add);
1065 return dt->do_ops->do_ref_add(env, dt, th);
1068 static inline int dt_declare_ref_del(const struct lu_env *env,
1069 struct dt_object *dt, struct thandle *th)
1072 LASSERT(dt->do_ops);
1073 LASSERT(dt->do_ops->do_declare_ref_del);
1074 return dt->do_ops->do_declare_ref_del(env, dt, th);
1077 static inline int dt_ref_del(const struct lu_env *env,
1078 struct dt_object *dt, struct thandle *th)
1081 LASSERT(dt->do_ops);
1082 LASSERT(dt->do_ops->do_ref_del);
1083 return dt->do_ops->do_ref_del(env, dt, th);
1086 static inline struct obd_capa *dt_capa_get(const struct lu_env *env,
1087 struct dt_object *dt,
1088 struct lustre_capa *old, __u64 opc)
1091 LASSERT(dt->do_ops);
1092 LASSERT(dt->do_ops->do_ref_del);
1093 return dt->do_ops->do_capa_get(env, dt, old, opc);
1096 static inline int dt_bufs_get(const struct lu_env *env, struct dt_object *d,
1097 struct niobuf_remote *rnb,
1098 struct niobuf_local *lnb, int rw,
1099 struct lustre_capa *capa)
1102 LASSERT(d->do_body_ops);
1103 LASSERT(d->do_body_ops->dbo_bufs_get);
1104 return d->do_body_ops->dbo_bufs_get(env, d, rnb->offset,
1105 rnb->len, lnb, rw, capa);
1108 static inline int dt_bufs_put(const struct lu_env *env, struct dt_object *d,
1109 struct niobuf_local *lnb, int n)
1112 LASSERT(d->do_body_ops);
1113 LASSERT(d->do_body_ops->dbo_bufs_put);
1114 return d->do_body_ops->dbo_bufs_put(env, d, lnb, n);
1117 static inline int dt_write_prep(const struct lu_env *env, struct dt_object *d,
1118 struct niobuf_local *lnb, int n)
1121 LASSERT(d->do_body_ops);
1122 LASSERT(d->do_body_ops->dbo_write_prep);
1123 return d->do_body_ops->dbo_write_prep(env, d, lnb, n);
1126 static inline int dt_declare_write_commit(const struct lu_env *env,
1127 struct dt_object *d,
1128 struct niobuf_local *lnb,
1129 int n, struct thandle *th)
1131 LASSERTF(d != NULL, "dt is NULL when we want to declare write\n");
1132 LASSERT(th != NULL);
1133 return d->do_body_ops->dbo_declare_write_commit(env, d, lnb, n, th);
1137 static inline int dt_write_commit(const struct lu_env *env,
1138 struct dt_object *d, struct niobuf_local *lnb,
1139 int n, struct thandle *th)
1142 LASSERT(d->do_body_ops);
1143 LASSERT(d->do_body_ops->dbo_write_commit);
1144 return d->do_body_ops->dbo_write_commit(env, d, lnb, n, th);
1147 static inline int dt_read_prep(const struct lu_env *env, struct dt_object *d,
1148 struct niobuf_local *lnb, int n)
1151 LASSERT(d->do_body_ops);
1152 LASSERT(d->do_body_ops->dbo_read_prep);
1153 return d->do_body_ops->dbo_read_prep(env, d, lnb, n);
1156 static inline int dt_declare_punch(const struct lu_env *env,
1157 struct dt_object *dt, __u64 start,
1158 __u64 end, struct thandle *th)
1161 LASSERT(dt->do_body_ops);
1162 LASSERT(dt->do_body_ops->do_declare_punch);
1163 return dt->do_body_ops->do_declare_punch(env, dt, start, end, th);
1166 static inline int dt_punch(const struct lu_env *env, struct dt_object *dt,
1167 __u64 start, __u64 end, struct thandle *th,
1168 struct lustre_capa *capa)
1171 LASSERT(dt->do_body_ops);
1172 LASSERT(dt->do_body_ops->do_punch);
1173 return dt->do_body_ops->do_punch(env, dt, start, end, th, capa);
1176 static inline int dt_fiemap_get(const struct lu_env *env, struct dt_object *d,
1177 struct ll_user_fiemap *fm)
1180 if (d->do_body_ops == NULL)
1182 if (d->do_body_ops->dbo_fiemap_get == NULL)
1184 return d->do_body_ops->dbo_fiemap_get(env, d, fm);
1187 static inline int dt_statfs(const struct lu_env *env, struct dt_device *dev,
1188 struct obd_statfs *osfs)
1191 LASSERT(dev->dd_ops);
1192 LASSERT(dev->dd_ops->dt_statfs);
1193 return dev->dd_ops->dt_statfs(env, dev, osfs);
1196 static inline int dt_root_get(const struct lu_env *env, struct dt_device *dev,
1200 LASSERT(dev->dd_ops);
1201 LASSERT(dev->dd_ops->dt_root_get);
1202 return dev->dd_ops->dt_root_get(env, dev, f);
1205 static inline void dt_conf_get(const struct lu_env *env,
1206 const struct dt_device *dev,
1207 struct dt_device_param *param)
1210 LASSERT(dev->dd_ops);
1211 LASSERT(dev->dd_ops->dt_conf_get);
1212 return dev->dd_ops->dt_conf_get(env, dev, param);
1215 static inline int dt_sync(const struct lu_env *env, struct dt_device *dev)
1218 LASSERT(dev->dd_ops);
1219 LASSERT(dev->dd_ops->dt_sync);
1220 return dev->dd_ops->dt_sync(env, dev);
1223 static inline int dt_ro(const struct lu_env *env, struct dt_device *dev)
1226 LASSERT(dev->dd_ops);
1227 LASSERT(dev->dd_ops->dt_ro);
1228 return dev->dd_ops->dt_ro(env, dev);
1231 static inline int dt_declare_insert(const struct lu_env *env,
1232 struct dt_object *dt,
1233 const struct dt_rec *rec,
1234 const struct dt_key *key,
1238 LASSERT(dt->do_index_ops);
1239 LASSERT(dt->do_index_ops->dio_declare_insert);
1240 return dt->do_index_ops->dio_declare_insert(env, dt, rec, key, th);
1243 static inline int dt_insert(const struct lu_env *env,
1244 struct dt_object *dt,
1245 const struct dt_rec *rec,
1246 const struct dt_key *key,
1248 struct lustre_capa *capa,
1252 LASSERT(dt->do_index_ops);
1253 LASSERT(dt->do_index_ops->dio_insert);
1254 return dt->do_index_ops->dio_insert(env, dt, rec, key, th,
1258 static inline int dt_declare_xattr_del(const struct lu_env *env,
1259 struct dt_object *dt,
1264 LASSERT(dt->do_ops);
1265 LASSERT(dt->do_ops->do_declare_xattr_del);
1266 return dt->do_ops->do_declare_xattr_del(env, dt, name, th);
1269 static inline int dt_xattr_del(const struct lu_env *env,
1270 struct dt_object *dt, const char *name,
1272 struct lustre_capa *capa)
1275 LASSERT(dt->do_ops);
1276 LASSERT(dt->do_ops->do_xattr_del);
1277 return dt->do_ops->do_xattr_del(env, dt, name, th, capa);
1280 static inline int dt_declare_xattr_set(const struct lu_env *env,
1281 struct dt_object *dt,
1282 const struct lu_buf *buf,
1283 const char *name, int fl,
1287 LASSERT(dt->do_ops);
1288 LASSERT(dt->do_ops->do_declare_xattr_set);
1289 return dt->do_ops->do_declare_xattr_set(env, dt, buf, name, fl, th);
1292 static inline int dt_xattr_set(const struct lu_env *env,
1293 struct dt_object *dt, const struct lu_buf *buf,
1294 const char *name, int fl, struct thandle *th,
1295 struct lustre_capa *capa)
1298 LASSERT(dt->do_ops);
1299 LASSERT(dt->do_ops->do_xattr_set);
1300 return dt->do_ops->do_xattr_set(env, dt, buf, name, fl, th, capa);
1303 static inline int dt_xattr_get(const struct lu_env *env,
1304 struct dt_object *dt, struct lu_buf *buf,
1305 const char *name, struct lustre_capa *capa)
1308 LASSERT(dt->do_ops);
1309 LASSERT(dt->do_ops->do_xattr_get);
1310 return dt->do_ops->do_xattr_get(env, dt, buf, name, capa);
1313 static inline int dt_xattr_list(const struct lu_env *env,
1314 struct dt_object *dt, struct lu_buf *buf,
1315 struct lustre_capa *capa)
1318 LASSERT(dt->do_ops);
1319 LASSERT(dt->do_ops->do_xattr_list);
1320 return dt->do_ops->do_xattr_list(env, dt, buf, capa);
1323 static inline int dt_declare_delete(const struct lu_env *env,
1324 struct dt_object *dt,
1325 const struct dt_key *key,
1329 LASSERT(dt->do_index_ops);
1330 LASSERT(dt->do_index_ops->dio_declare_delete);
1331 return dt->do_index_ops->dio_declare_delete(env, dt, key, th);
1334 static inline int dt_delete(const struct lu_env *env,
1335 struct dt_object *dt,
1336 const struct dt_key *key,
1338 struct lustre_capa *capa)
1341 LASSERT(dt->do_index_ops);
1342 LASSERT(dt->do_index_ops->dio_delete);
1343 return dt->do_index_ops->dio_delete(env, dt, key, th, capa);
1346 static inline int dt_commit_async(const struct lu_env *env,
1347 struct dt_device *dev)
1350 LASSERT(dev->dd_ops);
1351 LASSERT(dev->dd_ops->dt_commit_async);
1352 return dev->dd_ops->dt_commit_async(env, dev);
1355 static inline int dt_lookup(const struct lu_env *env,
1356 struct dt_object *dt,
1358 const struct dt_key *key,
1359 struct lustre_capa *capa)
1364 LASSERT(dt->do_index_ops);
1365 LASSERT(dt->do_index_ops->dio_lookup);
1367 ret = dt->do_index_ops->dio_lookup(env, dt, rec, key, capa);
1375 #define LU221_BAD_TIME (0x80000000U + 24 * 3600)
1377 struct dt_find_hint {
1378 struct lu_fid *dfh_fid;
1379 struct dt_device *dfh_dt;
1380 struct dt_object *dfh_o;
1383 struct dt_thread_info {
1384 char dti_buf[DT_MAX_PATH];
1385 struct dt_find_hint dti_dfh;
1386 struct lu_attr dti_attr;
1387 struct lu_fid dti_fid;
1388 struct dt_object_format dti_dof;
1389 struct lustre_mdt_attrs dti_lma;
1390 struct lu_buf dti_lb;
1394 extern struct lu_context_key dt_key;
1396 static inline struct dt_thread_info *dt_info(const struct lu_env *env)
1398 struct dt_thread_info *dti;
1400 dti = lu_context_key_get(&env->le_ctx, &dt_key);
1405 #endif /* __LUSTRE_DT_OBJECT_H */