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.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2012, 2016, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
33 * lustre/include/lustre_osc.h
35 * OSC layer structures and methods common for both OSC and MDC.
37 * This file contains OSC interfaces used by OSC and MDC. Most of them
38 * were just moved from lustre/osc/osc_cl_internal.h for Data-on-MDT
41 * Author: Nikita Danilov <nikita.danilov@sun.com>
42 * Author: Jinshan Xiong <jinshan.xiong@whamcloud.com>
43 * Author: Mikhail Pershin <mike.pershin@intel.com>
49 #include <libcfs/libcfs.h>
51 #include <cl_object.h>
57 struct osc_quota_info {
58 /** linkage for quota hash table */
59 struct hlist_node oqi_hash;
64 ASYNC_READY = 0x1, /* ap_make_ready will not be called before this
65 page is added to an rpc */
66 ASYNC_URGENT = 0x2, /* page must be put into an RPC before return */
67 ASYNC_COUNT_STABLE = 0x4, /* ap_refresh_count will not be called
68 to give the caller a chance to update
69 or cancel the size of the io */
73 struct osc_async_page {
75 unsigned short oap_cmd;
76 unsigned short oap_interrupted:1;
78 struct list_head oap_pending_item;
79 struct list_head oap_rpc_item;
82 unsigned oap_page_off;
83 enum async_flags oap_async_flags;
85 struct brw_page oap_brw_page;
87 struct ptlrpc_request *oap_request;
88 struct client_obd *oap_cli;
89 struct osc_object *oap_obj;
94 #define oap_page oap_brw_page.pg
95 #define oap_count oap_brw_page.count
96 #define oap_brw_flags oap_brw_page.flag
98 static inline struct osc_async_page *brw_page2oap(struct brw_page *pga)
100 return container_of(pga, struct osc_async_page, oap_brw_page);
103 struct osc_cache_waiter {
104 struct list_head ocw_entry;
105 wait_queue_head_t ocw_waitq;
106 struct osc_async_page *ocw_oap;
112 struct cl_device od_cl;
113 struct obd_export *od_exp;
115 /* Write stats is actually protected by client_obd's lock. */
117 uint64_t os_lockless_writes; /* by bytes */
118 uint64_t os_lockless_reads; /* by bytes */
119 uint64_t os_lockless_truncates; /* by times */
122 /* configuration item(s) */
123 int od_contention_time;
124 int od_lockless_truncate;
130 * State maintained by osc layer for each IO context.
134 struct cl_io_slice oi_cl;
135 /** true if this io is lockless. */
136 unsigned int oi_lockless:1,
137 /** true if this io is counted as active IO */
139 /** how many LRU pages are reserved for this IO */
140 unsigned long oi_lru_reserved;
142 /** active extents, we know how many bytes is going to be written,
143 * so having an active extent will prevent it from being fragmented */
144 struct osc_extent *oi_active;
145 /** partially truncated extent, we need to hold this extent to prevent
146 * page writeback from happening. */
147 struct osc_extent *oi_trunc;
148 /** write osc_lock for this IO, used by osc_extent_find(). */
149 struct osc_lock *oi_write_osclock;
151 struct osc_async_cbargs {
154 struct completion opc_sync;
159 * State maintained by osc layer for the duration of a system call.
165 #define OTI_PVEC_SIZE 256
166 struct osc_thread_info {
167 struct ldlm_res_id oti_resname;
168 union ldlm_policy_data oti_policy;
169 struct cl_lock_descr oti_descr;
170 struct cl_attr oti_attr;
171 struct lustre_handle oti_handle;
172 struct cl_page_list oti_plist;
174 void *oti_pvec[OTI_PVEC_SIZE];
176 * Fields used by cl_lock_discard_pages().
178 pgoff_t oti_next_index;
179 pgoff_t oti_fn_index; /* first non-overlapped index */
180 struct cl_sync_io oti_anchor;
181 struct cl_req_attr oti_req_attr;
182 struct lu_buf oti_ladvise_buf;
185 static inline __u64 osc_enq2ldlm_flags(__u32 enqflags)
189 CDEBUG(D_DLMTRACE, "flags: %x\n", enqflags);
191 LASSERT((enqflags & ~CEF_MASK) == 0);
193 if (enqflags & CEF_NONBLOCK)
194 result |= LDLM_FL_BLOCK_NOWAIT;
195 if (enqflags & CEF_GLIMPSE)
196 result |= LDLM_FL_HAS_INTENT;
197 if (enqflags & CEF_DISCARD_DATA)
198 result |= LDLM_FL_AST_DISCARD_DATA;
199 if (enqflags & CEF_PEEK)
200 result |= LDLM_FL_TEST_LOCK;
201 if (enqflags & CEF_LOCK_MATCH)
202 result |= LDLM_FL_MATCH_LOCK;
203 if (enqflags & CEF_LOCK_NO_EXPAND)
204 result |= LDLM_FL_NO_EXPANSION;
205 if (enqflags & CEF_SPECULATIVE)
206 result |= LDLM_FL_SPECULATIVE;
210 typedef int (*osc_enqueue_upcall_f)(void *cookie, struct lustre_handle *lockh,
213 struct osc_enqueue_args {
214 struct obd_export *oa_exp;
215 enum ldlm_type oa_type;
216 enum ldlm_mode oa_mode;
218 osc_enqueue_upcall_f oa_upcall;
220 struct ost_lvb *oa_lvb;
221 struct lustre_handle oa_lockh;
226 * Bit flags for osc_dlm_lock_at_pageoff().
230 * Just check if the desired lock exists, it won't hold reference
233 OSC_DAP_FL_TEST_LOCK = 1 << 0,
235 * Return the lock even if it is being canceled.
237 OSC_DAP_FL_CANCELING = 1 << 1
241 * The set of operations which are different for MDC and OSC objects
243 struct osc_object_operations {
244 void (*oto_build_res_name)(struct osc_object *osc,
245 struct ldlm_res_id *resname);
246 struct ldlm_lock* (*oto_dlmlock_at_pgoff)(const struct lu_env *env,
247 struct osc_object *obj,
249 enum osc_dap_flags dap_flags);
253 struct cl_object oo_cl;
254 struct lov_oinfo *oo_oinfo;
256 * True if locking against this stripe got -EUSERS.
259 cfs_time_t oo_contention_time;
260 #ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
262 * IO context used for invariant checks in osc_lock_has_pages().
264 struct cl_io oo_debug_io;
265 /** Serialization object for osc_object::oo_debug_io. */
266 struct mutex oo_debug_mutex;
269 * used by the osc to keep track of what objects to build into rpcs.
270 * Protected by client_obd->cli_loi_list_lock.
272 struct list_head oo_ready_item;
273 struct list_head oo_hp_ready_item;
274 struct list_head oo_write_item;
275 struct list_head oo_read_item;
278 * extent is a red black tree to manage (async) dirty pages.
280 struct rb_root oo_root;
282 * Manage write(dirty) extents.
284 struct list_head oo_hp_exts; /* list of hp extents */
285 struct list_head oo_urgent_exts; /* list of writeback extents */
286 struct list_head oo_full_exts;
288 struct list_head oo_reading_exts;
290 atomic_t oo_nr_reads;
291 atomic_t oo_nr_writes;
293 /** Protect extent tree. Will be used to protect
294 * oo_{read|write}_pages soon. */
298 * Radix tree for caching pages
300 spinlock_t oo_tree_lock;
301 struct radix_tree_root oo_tree;
302 unsigned long oo_npages;
304 /* Protect osc_lock this osc_object has */
305 struct list_head oo_ol_list;
306 spinlock_t oo_ol_spin;
308 /** number of active IOs of this object */
310 wait_queue_head_t oo_io_waitq;
312 const struct osc_object_operations *oo_obj_ops;
316 static inline void osc_build_res_name(struct osc_object *osc,
317 struct ldlm_res_id *resname)
319 return osc->oo_obj_ops->oto_build_res_name(osc, resname);
322 static inline struct ldlm_lock *osc_dlmlock_at_pgoff(const struct lu_env *env,
323 struct osc_object *obj,
325 enum osc_dap_flags flags)
327 return obj->oo_obj_ops->oto_dlmlock_at_pgoff(env, obj, index, flags);
330 static inline void osc_object_lock(struct osc_object *obj)
332 spin_lock(&obj->oo_lock);
335 static inline int osc_object_trylock(struct osc_object *obj)
337 return spin_trylock(&obj->oo_lock);
340 static inline void osc_object_unlock(struct osc_object *obj)
342 spin_unlock(&obj->oo_lock);
345 static inline int osc_object_is_locked(struct osc_object *obj)
347 #if defined(CONFIG_SMP) || defined(CONFIG_DEBUG_SPINLOCK)
348 return spin_is_locked(&obj->oo_lock);
351 * It is not perfect to return true all the time.
352 * But since this function is only used for assertion
353 * and checking, it seems OK.
359 static inline void osc_object_set_contended(struct osc_object *obj)
361 obj->oo_contention_time = cfs_time_current();
363 obj->oo_contended = 1;
366 static inline void osc_object_clear_contended(struct osc_object *obj)
368 obj->oo_contended = 0;
372 * Lock "micro-states" for osc layer.
374 enum osc_lock_state {
383 * osc-private state of cl_lock.
385 * Interaction with DLM.
387 * Once receive upcall is invoked, osc_lock remembers a handle of DLM lock in
388 * osc_lock::ols_handle and a pointer to that lock in osc_lock::ols_dlmlock.
390 * This pointer is protected through a reference, acquired by
391 * osc_lock_upcall0(). Also, an additional reference is acquired by
392 * ldlm_lock_addref() call protecting the lock from cancellation, until
393 * osc_lock_unuse() releases it.
395 * Below is a description of how lock references are acquired and released
398 * - When new lock is created and enqueued to the server (ldlm_cli_enqueue())
399 * - ldlm_lock_create()
400 * - ldlm_lock_new(): initializes a lock with 2 references. One for
401 * the caller (released when reply from the server is received, or on
402 * error), and another for the hash table.
403 * - ldlm_lock_addref_internal(): protects the lock from cancellation.
405 * - When reply is received from the server (osc_enqueue_interpret())
406 * - ldlm_cli_enqueue_fini()
407 * - LDLM_LOCK_PUT(): releases caller reference acquired by
410 * ldlm_lock_decref(): error case: matches ldlm_cli_enqueue().
411 * - ldlm_lock_decref(): for async locks, matches ldlm_cli_enqueue().
413 * - When lock is being cancelled (ldlm_lock_cancel())
414 * - ldlm_lock_destroy()
415 * - LDLM_LOCK_PUT(): releases hash-table reference acquired by
418 * osc_lock is detached from ldlm_lock by osc_lock_detach() that is called
419 * either when lock is cancelled (osc_lock_blocking()), or when locks is
420 * deleted without cancellation (e.g., from cl_locks_prune()). In the latter
421 * case ldlm lock remains in memory, and can be re-attached to osc_lock in the
425 struct cl_lock_slice ols_cl;
426 /** Internal lock to protect states, etc. */
428 /** Owner sleeps on this channel for state change */
429 struct cl_sync_io *ols_owner;
430 /** waiting list for this lock to be cancelled */
431 struct list_head ols_waiting_list;
432 /** wait entry of ols_waiting_list */
433 struct list_head ols_wait_entry;
434 /** list entry for osc_object::oo_ol_list */
435 struct list_head ols_nextlock_oscobj;
437 /** underlying DLM lock */
438 struct ldlm_lock *ols_dlmlock;
439 /** DLM flags with which osc_lock::ols_lock was enqueued */
441 /** osc_lock::ols_lock handle */
442 struct lustre_handle ols_handle;
443 struct ldlm_enqueue_info ols_einfo;
444 enum osc_lock_state ols_state;
445 /** lock value block */
446 struct ost_lvb ols_lvb;
447 /** Lockless operations to be used by lockless lock */
448 const struct cl_lock_operations *ols_lockless_ops;
450 * true, if ldlm_lock_addref() was called against
451 * osc_lock::ols_lock. This is used for sanity checking.
453 * \see osc_lock::ols_has_ref
455 unsigned ols_hold :1,
457 * this is much like osc_lock::ols_hold, except that this bit is
458 * cleared _after_ reference in released in osc_lock_unuse(). This
459 * fine distinction is needed because:
461 * - if ldlm lock still has a reference, osc_ast_data_get() needs
462 * to return associated cl_lock (so that a flag is needed that is
463 * cleared after ldlm_lock_decref() returned), and
465 * - ldlm_lock_decref() can invoke blocking ast (for a
466 * LDLM_FL_CBPENDING lock), and osc_lock functions like
467 * osc_lock_cancel() called from there need to know whether to
468 * release lock reference (so that a flag is needed that is
469 * cleared before ldlm_lock_decref() is called).
473 * inherit the lockless attribute from top level cl_io.
474 * If true, osc_lock_enqueue is able to tolerate the -EUSERS error.
478 * if set, the osc_lock is a glimpse lock. For glimpse locks, we treat
479 * the EVAVAIL error as torerable, this will make upper logic happy
480 * to wait all glimpse locks to each OSTs to be completed.
481 * Glimpse lock converts to normal lock if the server lock is granted.
482 * Glimpse lock should be destroyed immediately after use.
486 * For async glimpse lock.
490 * for speculative locks - asynchronous glimpse locks and ladvise
491 * lockahead manual lock requests
493 * Used to tell osc layer to not wait for the ldlm reply from the
494 * server, so the osc lock will be short lived - It only exists to
495 * create the ldlm request and is not updated on request completion.
500 static inline int osc_lock_is_lockless(const struct osc_lock *ols)
502 return (ols->ols_cl.cls_ops == ols->ols_lockless_ops);
506 * Page state private for osc layer.
509 struct cl_page_slice ops_cl;
511 * Page queues used by osc to detect when RPC can be formed.
513 struct osc_async_page ops_oap;
515 * An offset within page from which next transfer starts. This is used
516 * by cl_page_clip() to submit partial page transfers.
520 * An offset within page at which next transfer ends.
522 * \see osc_page::ops_from.
526 * Boolean, true iff page is under transfer. Used for sanity checking.
528 unsigned ops_transfer_pinned:1,
534 * Set if the page must be transferred with OBD_BRW_SRVLOCK.
538 * lru page list. See osc_lru_{del|use}() in osc_page.c for usage.
540 struct list_head ops_lru;
542 * Submit time - the time when the page is starting RPC. For debugging.
544 cfs_time_t ops_submit_time;
547 struct osc_brw_async_args {
549 int aa_requested_nob;
553 struct brw_page **aa_ppga;
554 struct client_obd *aa_cli;
555 struct list_head aa_oaps;
556 struct list_head aa_exts;
559 extern struct kmem_cache *osc_lock_kmem;
560 extern struct kmem_cache *osc_object_kmem;
561 extern struct kmem_cache *osc_thread_kmem;
562 extern struct kmem_cache *osc_session_kmem;
563 extern struct kmem_cache *osc_extent_kmem;
564 extern struct kmem_cache *osc_quota_kmem;
566 extern struct lu_context_key osc_key;
567 extern struct lu_context_key osc_session_key;
569 #define OSC_FLAGS (ASYNC_URGENT|ASYNC_READY)
572 int osc_page_init(const struct lu_env *env, struct cl_object *obj,
573 struct cl_page *page, pgoff_t ind);
574 void osc_index2policy(union ldlm_policy_data *policy, const struct cl_object *obj,
575 pgoff_t start, pgoff_t end);
576 void osc_lru_add_batch(struct client_obd *cli, struct list_head *list);
577 void osc_page_submit(const struct lu_env *env, struct osc_page *opg,
578 enum cl_req_type crt, int brw_flags);
579 int lru_queue_work(const struct lu_env *env, void *data);
580 long osc_lru_shrink(const struct lu_env *env, struct client_obd *cli,
581 long target, bool force);
584 int osc_cancel_async_page(const struct lu_env *env, struct osc_page *ops);
585 int osc_set_async_flags(struct osc_object *obj, struct osc_page *opg,
587 int osc_prep_async_page(struct osc_object *osc, struct osc_page *ops,
588 struct page *page, loff_t offset);
589 int osc_queue_async_io(const struct lu_env *env, struct cl_io *io,
590 struct osc_page *ops);
591 int osc_page_cache_add(const struct lu_env *env,
592 const struct cl_page_slice *slice, struct cl_io *io);
593 int osc_teardown_async_page(const struct lu_env *env, struct osc_object *obj,
594 struct osc_page *ops);
595 int osc_flush_async_page(const struct lu_env *env, struct cl_io *io,
596 struct osc_page *ops);
597 int osc_queue_sync_pages(const struct lu_env *env, struct osc_object *obj,
598 struct list_head *list, int cmd, int brw_flags);
599 int osc_cache_truncate_start(const struct lu_env *env, struct osc_object *obj,
600 __u64 size, struct osc_extent **extp);
601 void osc_cache_truncate_end(const struct lu_env *env, struct osc_extent *ext);
602 int osc_cache_writeback_range(const struct lu_env *env, struct osc_object *obj,
603 pgoff_t start, pgoff_t end, int hp, int discard);
604 int osc_cache_wait_range(const struct lu_env *env, struct osc_object *obj,
605 pgoff_t start, pgoff_t end);
606 int osc_io_unplug0(const struct lu_env *env, struct client_obd *cli,
607 struct osc_object *osc, int async);
608 void osc_wake_cache_waiters(struct client_obd *cli);
610 static inline int osc_io_unplug_async(const struct lu_env *env,
611 struct client_obd *cli,
612 struct osc_object *osc)
614 return osc_io_unplug0(env, cli, osc, 1);
617 static inline void osc_io_unplug(const struct lu_env *env,
618 struct client_obd *cli,
619 struct osc_object *osc)
621 (void)osc_io_unplug0(env, cli, osc, 0);
624 typedef int (*osc_page_gang_cbt)(const struct lu_env *, struct cl_io *,
625 struct osc_page *, void *);
626 int osc_page_gang_lookup(const struct lu_env *env, struct cl_io *io,
627 struct osc_object *osc, pgoff_t start, pgoff_t end,
628 osc_page_gang_cbt cb, void *cbdata);
629 int osc_discard_cb(const struct lu_env *env, struct cl_io *io,
630 struct osc_page *ops, void *cbdata);
633 int osc_device_init(const struct lu_env *env, struct lu_device *d,
634 const char *name, struct lu_device *next);
635 struct lu_device *osc_device_fini(const struct lu_env *env,
636 struct lu_device *d);
637 struct lu_device *osc_device_free(const struct lu_env *env,
638 struct lu_device *d);
641 int osc_object_init(const struct lu_env *env, struct lu_object *obj,
642 const struct lu_object_conf *conf);
643 void osc_object_free(const struct lu_env *env, struct lu_object *obj);
644 int osc_lvb_print(const struct lu_env *env, void *cookie,
645 lu_printer_t p, const struct ost_lvb *lvb);
646 int osc_object_print(const struct lu_env *env, void *cookie,
647 lu_printer_t p, const struct lu_object *obj);
648 int osc_attr_get(const struct lu_env *env, struct cl_object *obj,
649 struct cl_attr *attr);
650 int osc_attr_update(const struct lu_env *env, struct cl_object *obj,
651 const struct cl_attr *attr, unsigned valid);
652 int osc_object_glimpse(const struct lu_env *env, const struct cl_object *obj,
653 struct ost_lvb *lvb);
654 int osc_object_invalidate(const struct lu_env *env, struct osc_object *osc);
655 int osc_object_is_contended(struct osc_object *obj);
656 int osc_object_find_cbdata(const struct lu_env *env, struct cl_object *obj,
657 ldlm_iterator_t iter, void *data);
658 int osc_object_prune(const struct lu_env *env, struct cl_object *obj);
661 void osc_init_grant(struct client_obd *cli, struct obd_connect_data *ocd);
662 int osc_setup_common(struct obd_device *obd, struct lustre_cfg *lcfg);
663 int osc_precleanup_common(struct obd_device *obd);
664 int osc_cleanup_common(struct obd_device *obd);
665 int osc_set_info_async(const struct lu_env *env, struct obd_export *exp,
666 u32 keylen, void *key, u32 vallen, void *val,
667 struct ptlrpc_request_set *set);
668 int osc_ldlm_resource_invalidate(struct cfs_hash *hs, struct cfs_hash_bd *bd,
669 struct hlist_node *hnode, void *arg);
670 int osc_reconnect(const struct lu_env *env, struct obd_export *exp,
671 struct obd_device *obd, struct obd_uuid *cluuid,
672 struct obd_connect_data *data, void *localdata);
673 int osc_disconnect(struct obd_export *exp);
674 int osc_punch_send(struct obd_export *exp, struct obdo *oa,
675 obd_enqueue_update_f upcall, void *cookie);
678 int osc_io_submit(const struct lu_env *env, const struct cl_io_slice *ios,
679 enum cl_req_type crt, struct cl_2queue *queue);
680 int osc_io_commit_async(const struct lu_env *env,
681 const struct cl_io_slice *ios,
682 struct cl_page_list *qin, int from, int to,
684 int osc_io_iter_init(const struct lu_env *env, const struct cl_io_slice *ios);
685 void osc_io_iter_fini(const struct lu_env *env,
686 const struct cl_io_slice *ios);
687 int osc_io_write_iter_init(const struct lu_env *env,
688 const struct cl_io_slice *ios);
689 void osc_io_write_iter_fini(const struct lu_env *env,
690 const struct cl_io_slice *ios);
691 int osc_io_fault_start(const struct lu_env *env, const struct cl_io_slice *ios);
692 void osc_io_setattr_end(const struct lu_env *env,
693 const struct cl_io_slice *slice);
694 int osc_io_read_start(const struct lu_env *env,
695 const struct cl_io_slice *slice);
696 int osc_io_write_start(const struct lu_env *env,
697 const struct cl_io_slice *slice);
698 void osc_io_end(const struct lu_env *env, const struct cl_io_slice *slice);
699 int osc_fsync_ost(const struct lu_env *env, struct osc_object *obj,
700 struct cl_fsync_io *fio);
701 void osc_io_fsync_end(const struct lu_env *env,
702 const struct cl_io_slice *slice);
703 void osc_read_ahead_release(const struct lu_env *env, void *cbdata);
706 void osc_lock_to_lockless(const struct lu_env *env, struct osc_lock *ols,
708 void osc_lock_wake_waiters(const struct lu_env *env, struct osc_object *osc,
709 struct osc_lock *oscl);
710 int osc_lock_enqueue_wait(const struct lu_env *env, struct osc_object *obj,
711 struct osc_lock *oscl);
712 void osc_lock_set_writer(const struct lu_env *env, const struct cl_io *io,
713 struct cl_object *obj, struct osc_lock *oscl);
714 int osc_lock_print(const struct lu_env *env, void *cookie,
715 lu_printer_t p, const struct cl_lock_slice *slice);
716 void osc_lock_cancel(const struct lu_env *env,
717 const struct cl_lock_slice *slice);
718 void osc_lock_fini(const struct lu_env *env, struct cl_lock_slice *slice);
719 int osc_ldlm_glimpse_ast(struct ldlm_lock *dlmlock, void *data);
721 /*****************************************************************************
723 * Accessors and type conversions.
726 static inline struct osc_thread_info *osc_env_info(const struct lu_env *env)
728 struct osc_thread_info *info;
730 info = lu_context_key_get(&env->le_ctx, &osc_key);
731 LASSERT(info != NULL);
735 static inline struct osc_session *osc_env_session(const struct lu_env *env)
737 struct osc_session *ses;
739 ses = lu_context_key_get(env->le_ses, &osc_session_key);
740 LASSERT(ses != NULL);
744 static inline struct osc_io *osc_env_io(const struct lu_env *env)
746 return &osc_env_session(env)->os_io;
749 static inline struct osc_device *lu2osc_dev(const struct lu_device *d)
751 return container_of0(d, struct osc_device, od_cl.cd_lu_dev);
754 static inline struct obd_export *osc_export(const struct osc_object *obj)
756 return lu2osc_dev(obj->oo_cl.co_lu.lo_dev)->od_exp;
759 static inline struct client_obd *osc_cli(const struct osc_object *obj)
761 return &osc_export(obj)->exp_obd->u.cli;
764 static inline struct osc_object *cl2osc(const struct cl_object *obj)
766 return container_of0(obj, struct osc_object, oo_cl);
769 static inline struct cl_object *osc2cl(const struct osc_object *obj)
771 return (struct cl_object *)&obj->oo_cl;
774 static inline struct osc_device *obd2osc_dev(const struct obd_device *d)
776 return container_of0(d->obd_lu_dev, struct osc_device,
780 static inline struct lu_device *osc2lu_dev(struct osc_device *osc)
782 return &osc->od_cl.cd_lu_dev;
785 static inline struct lu_object *osc2lu(struct osc_object *osc)
787 return &osc->oo_cl.co_lu;
790 static inline struct osc_object *lu2osc(const struct lu_object *obj)
792 return container_of0(obj, struct osc_object, oo_cl.co_lu);
795 static inline struct osc_io *cl2osc_io(const struct lu_env *env,
796 const struct cl_io_slice *slice)
798 struct osc_io *oio = container_of0(slice, struct osc_io, oi_cl);
800 LINVRNT(oio == osc_env_io(env));
804 static inline enum ldlm_mode osc_cl_lock2ldlm(enum cl_lock_mode mode)
806 LASSERT(mode == CLM_READ || mode == CLM_WRITE || mode == CLM_GROUP);
807 if (mode == CLM_READ)
809 if (mode == CLM_WRITE)
814 static inline enum cl_lock_mode osc_ldlm2cl_lock(enum ldlm_mode mode)
816 LASSERT(mode == LCK_PR || mode == LCK_PW || mode == LCK_GROUP);
824 static inline struct osc_page *cl2osc_page(const struct cl_page_slice *slice)
826 return container_of0(slice, struct osc_page, ops_cl);
829 static inline struct osc_page *oap2osc(struct osc_async_page *oap)
831 return container_of0(oap, struct osc_page, ops_oap);
834 static inline pgoff_t osc_index(struct osc_page *opg)
836 return opg->ops_cl.cpl_index;
839 static inline struct cl_page *oap2cl_page(struct osc_async_page *oap)
841 return oap2osc(oap)->ops_cl.cpl_page;
844 static inline struct osc_page *oap2osc_page(struct osc_async_page *oap)
846 return (struct osc_page *)container_of(oap, struct osc_page, ops_oap);
849 static inline struct osc_page *
850 osc_cl_page_osc(struct cl_page *page, struct osc_object *osc)
852 const struct cl_page_slice *slice;
854 LASSERT(osc != NULL);
855 slice = cl_object_page_slice(&osc->oo_cl, page);
856 return cl2osc_page(slice);
859 static inline struct osc_lock *cl2osc_lock(const struct cl_lock_slice *slice)
861 return container_of0(slice, struct osc_lock, ols_cl);
864 static inline int osc_io_srvlock(struct osc_io *oio)
866 return (oio->oi_lockless && !oio->oi_cl.cis_io->ci_no_srvlock);
869 enum osc_extent_state {
870 OES_INV = 0, /** extent is just initialized or destroyed */
871 OES_ACTIVE = 1, /** process is using this extent */
872 OES_CACHE = 2, /** extent is ready for IO */
873 OES_LOCKING = 3, /** locking page to prepare IO */
874 OES_LOCK_DONE = 4, /** locking finished, ready to send */
875 OES_RPC = 5, /** in RPC */
876 OES_TRUNC = 6, /** being truncated */
881 * osc_extent data to manage dirty pages.
882 * osc_extent has the following attributes:
883 * 1. all pages in the same must be in one RPC in write back;
884 * 2. # of pages must be less than max_pages_per_rpc - implied by 1;
885 * 3. must be covered by only 1 osc_lock;
886 * 4. exclusive. It's impossible to have overlapped osc_extent.
888 * The lifetime of an extent is from when the 1st page is dirtied to when
889 * all pages inside it are written out.
893 * page lock -> client_obd_list_lock -> object lock(osc_object::oo_lock)
896 /** red-black tree node */
897 struct rb_node oe_node;
898 /** osc_object of this extent */
899 struct osc_object *oe_obj;
900 /** refcount, removed from red-black tree if reaches zero. */
902 /** busy if non-zero */
904 /** link list of osc_object's oo_{hp|urgent|locking}_exts. */
905 struct list_head oe_link;
906 /** state of this extent */
907 enum osc_extent_state oe_state;
908 /** flags for this extent. */
909 unsigned int oe_intree:1,
910 /** 0 is write, 1 is read */
912 /** sync extent, queued by osc_queue_sync_pages() */
914 /** set if this extent has partial, sync pages.
915 * Extents with partial page(s) can't merge with others in RPC */
919 /** an ACTIVE extent is going to be truncated, so when this extent
920 * is released, it will turn into TRUNC state instead of CACHE. */
922 /** this extent should be written asap and someone may wait for the
923 * write to finish. This bit is usually set along with urgent if
924 * the extent was CACHE state.
925 * fsync_wait extent can't be merged because new extent region may
926 * exceed fsync range. */
928 /** covering lock is being canceled */
930 /** this extent should be written back asap. set if one of pages is
931 * called by page WB daemon, or sync write or reading requests. */
933 /** how many grants allocated for this extent.
934 * Grant allocated for this extent. There is no grant allocated
935 * for reading extents and sync write extents. */
936 unsigned int oe_grants;
937 /** # of dirty pages in this extent */
938 unsigned int oe_nr_pages;
939 /** list of pending oap pages. Pages in this list are NOT sorted. */
940 struct list_head oe_pages;
941 /** Since an extent has to be written out in atomic, this is used to
942 * remember the next page need to be locked to write this extent out.
943 * Not used right now.
945 struct osc_page *oe_next_page;
946 /** start and end index of this extent, include start and end
947 * themselves. Page offset here is the page index of osc_pages.
948 * oe_start is used as keyword for red-black tree. */
951 /** maximum ending index of this extent, this is limited by
952 * max_pages_per_rpc, lock extent and chunk size. */
954 /** waitqueue - for those who want to be notified if this extent's
955 * state has changed. */
956 wait_queue_head_t oe_waitq;
957 /** lock covering this extent */
958 struct ldlm_lock *oe_dlmlock;
959 /** terminator of this extent. Must be true if this extent is in IO. */
960 struct task_struct *oe_owner;
961 /** return value of writeback. If somebody is waiting for this extent,
962 * this value can be known by outside world. */
964 /** max pages per rpc when this extent was created */
965 unsigned int oe_mppr;
970 #endif /* LUSTRE_OSC_H */