Whamcloud - gitweb
331e02fe5952d492c98f392edef3e35a2f57103a
[fs/lustre-release.git] / lustre / include / lustre_osc.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) 2008, 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 /*
33  * lustre/include/lustre_osc.h
34  *
35  * OSC layer structures and methods common for both OSC and MDC.
36  *
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
39  * purposes.
40  *
41  *   Author: Nikita Danilov <nikita.danilov@sun.com>
42  *   Author: Jinshan Xiong <jinshan.xiong@whamcloud.com>
43  *   Author: Mikhail Pershin <mike.pershin@intel.com>
44  */
45
46 #ifndef LUSTRE_OSC_H
47 #define LUSTRE_OSC_H
48
49 #include <libcfs/libcfs.h>
50 #include <obd.h>
51 #include <cl_object.h>
52
53 /** \defgroup osc osc
54  *  @{
55  */
56
57 struct osc_quota_info {
58         /** linkage for quota hash table */
59         struct hlist_node oqi_hash;
60         __u32             oqi_id;
61 };
62
63 enum async_flags {
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 */
70         ASYNC_HP = 0x10,
71 };
72
73 struct osc_async_page {
74         int                     oap_magic;
75         unsigned short          oap_cmd;
76         unsigned short          oap_interrupted:1;
77
78         struct list_head        oap_pending_item;
79         struct list_head        oap_rpc_item;
80
81         loff_t                  oap_obj_off;
82         unsigned                oap_page_off;
83         enum async_flags        oap_async_flags;
84
85         struct brw_page         oap_brw_page;
86
87         struct ptlrpc_request   *oap_request;
88         struct client_obd       *oap_cli;
89         struct osc_object       *oap_obj;
90
91         spinlock_t               oap_lock;
92 };
93
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
97
98 static inline struct osc_async_page *brw_page2oap(struct brw_page *pga)
99 {
100         return container_of(pga, struct osc_async_page, oap_brw_page);
101 }
102
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;
107         int                     ocw_grant;
108         int                     ocw_rc;
109 };
110
111 struct osc_device {
112         struct cl_device        od_cl;
113         struct obd_export       *od_exp;
114
115         /* Write stats is actually protected by client_obd's lock. */
116         struct osc_stats {
117                 uint64_t        os_lockless_writes;    /* by bytes */
118                 uint64_t        os_lockless_reads;     /* by bytes */
119                 uint64_t        os_lockless_truncates; /* by times */
120         } od_stats;
121
122         /* configuration item(s) */
123         int                     od_contention_time;
124         int                     od_lockless_truncate;
125 };
126
127 struct osc_extent;
128
129 /**
130  * State maintained by osc layer for each IO context.
131  */
132 struct osc_io {
133         /** super class */
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 */
138                            oi_is_active:1;
139         /** how many LRU pages are reserved for this IO */
140         unsigned long      oi_lru_reserved;
141
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;
150         struct obdo        oi_oa;
151         struct osc_async_cbargs {
152                 bool              opc_rpc_sent;
153                 int               opc_rc;
154                 struct completion opc_sync;
155         } oi_cbarg;
156 };
157
158 /**
159  * State maintained by osc layer for the duration of a system call.
160  */
161 struct osc_session {
162         struct osc_io os_io;
163 };
164
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;
173         struct cl_io            oti_io;
174         void                    *oti_pvec[OTI_PVEC_SIZE];
175         /**
176          * Fields used by cl_lock_discard_pages().
177          */
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;
183 };
184
185 static inline __u64 osc_enq2ldlm_flags(__u32 enqflags)
186 {
187         __u64 result = 0;
188
189         CDEBUG(D_DLMTRACE, "flags: %x\n", enqflags);
190
191         LASSERT((enqflags & ~CEF_MASK) == 0);
192
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;
207         return result;
208 }
209
210 typedef int (*osc_enqueue_upcall_f)(void *cookie, struct lustre_handle *lockh,
211                                     int rc);
212
213 struct osc_enqueue_args {
214         struct obd_export       *oa_exp;
215         enum ldlm_type          oa_type;
216         enum ldlm_mode          oa_mode;
217         __u64                   *oa_flags;
218         osc_enqueue_upcall_f    oa_upcall;
219         void                    *oa_cookie;
220         struct ost_lvb          *oa_lvb;
221         struct lustre_handle    oa_lockh;
222         bool                    oa_speculative;
223 };
224
225 /**
226  * Bit flags for osc_dlm_lock_at_pageoff().
227  */
228 enum osc_dap_flags {
229         /**
230          * Just check if the desired lock exists, it won't hold reference
231          * count on lock.
232          */
233         OSC_DAP_FL_TEST_LOCK = 1 << 0,
234         /**
235          * Return the lock even if it is being canceled.
236          */
237         OSC_DAP_FL_CANCELING = 1 << 1
238 };
239
240 /*
241  * The set of operations which are different for MDC and OSC objects
242  */
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,
248                                                 pgoff_t index,
249                                                 enum osc_dap_flags dap_flags);
250 };
251
252 struct osc_object {
253         struct cl_object        oo_cl;
254         struct lov_oinfo        *oo_oinfo;
255         /**
256          * True if locking against this stripe got -EUSERS.
257          */
258         int                     oo_contended;
259         cfs_time_t              oo_contention_time;
260 #ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
261         /**
262          * IO context used for invariant checks in osc_lock_has_pages().
263          */
264         struct cl_io            oo_debug_io;
265         /** Serialization object for osc_object::oo_debug_io. */
266         struct mutex            oo_debug_mutex;
267 #endif
268         /**
269          * used by the osc to keep track of what objects to build into rpcs.
270          * Protected by client_obd->cli_loi_list_lock.
271          */
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;
276
277         /**
278          * extent is a red black tree to manage (async) dirty pages.
279          */
280         struct rb_root          oo_root;
281         /**
282          * Manage write(dirty) extents.
283          */
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;
287
288         struct list_head        oo_reading_exts;
289
290         atomic_t                oo_nr_reads;
291         atomic_t                oo_nr_writes;
292
293         /** Protect extent tree. Will be used to protect
294          * oo_{read|write}_pages soon. */
295         spinlock_t              oo_lock;
296
297         /**
298          * Radix tree for caching pages
299          */
300         spinlock_t              oo_tree_lock;
301         struct radix_tree_root  oo_tree;
302         unsigned long           oo_npages;
303
304         /* Protect osc_lock this osc_object has */
305         struct list_head        oo_ol_list;
306         spinlock_t              oo_ol_spin;
307
308         /** number of active IOs of this object */
309         atomic_t                oo_nr_ios;
310         wait_queue_head_t       oo_io_waitq;
311
312         const struct osc_object_operations *oo_obj_ops;
313         bool                    oo_initialized;
314 };
315
316 static inline void osc_build_res_name(struct osc_object *osc,
317                                       struct ldlm_res_id *resname)
318 {
319         return osc->oo_obj_ops->oto_build_res_name(osc, resname);
320 }
321
322 static inline struct ldlm_lock *osc_dlmlock_at_pgoff(const struct lu_env *env,
323                                                     struct osc_object *obj,
324                                                     pgoff_t index,
325                                                     enum osc_dap_flags flags)
326 {
327         return obj->oo_obj_ops->oto_dlmlock_at_pgoff(env, obj, index, flags);
328 }
329
330 static inline void osc_object_lock(struct osc_object *obj)
331 {
332         spin_lock(&obj->oo_lock);
333 }
334
335 static inline int osc_object_trylock(struct osc_object *obj)
336 {
337         return spin_trylock(&obj->oo_lock);
338 }
339
340 static inline void osc_object_unlock(struct osc_object *obj)
341 {
342         spin_unlock(&obj->oo_lock);
343 }
344
345 static inline int osc_object_is_locked(struct osc_object *obj)
346 {
347 #if defined(CONFIG_SMP) || defined(CONFIG_DEBUG_SPINLOCK)
348         return spin_is_locked(&obj->oo_lock);
349 #else
350         /*
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.
354          */
355         return 1;
356 #endif
357 }
358
359 static inline void osc_object_set_contended(struct osc_object *obj)
360 {
361         obj->oo_contention_time = cfs_time_current();
362         /* mb(); */
363         obj->oo_contended = 1;
364 }
365
366 static inline void osc_object_clear_contended(struct osc_object *obj)
367 {
368         obj->oo_contended = 0;
369 }
370
371 /*
372  * Lock "micro-states" for osc layer.
373  */
374 enum osc_lock_state {
375         OLS_NEW,
376         OLS_ENQUEUED,
377         OLS_UPCALL_RECEIVED,
378         OLS_GRANTED,
379         OLS_CANCELLED
380 };
381
382 /**
383  * osc-private state of cl_lock.
384  *
385  * Interaction with DLM.
386  *
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.
389  *
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.
394  *
395  * Below is a description of how lock references are acquired and released
396  * inside of DLM.
397  *
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.
404  *
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
408  *            ldlm_lock_new().
409  *          - if (rc != 0)
410  *                ldlm_lock_decref(): error case: matches ldlm_cli_enqueue().
411  *      - ldlm_lock_decref(): for async locks, matches ldlm_cli_enqueue().
412  *
413  * - When lock is being cancelled (ldlm_lock_cancel())
414  *      - ldlm_lock_destroy()
415  *          - LDLM_LOCK_PUT(): releases hash-table reference acquired by
416  *            ldlm_lock_new().
417  *
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
422  * future.
423  */
424 struct osc_lock {
425         struct cl_lock_slice    ols_cl;
426         /** Internal lock to protect states, etc. */
427         spinlock_t              ols_lock;
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;
436
437         /** underlying DLM lock */
438         struct ldlm_lock        *ols_dlmlock;
439         /** DLM flags with which osc_lock::ols_lock was enqueued */
440         __u64                   ols_flags;
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;
449         /**
450          * true, if ldlm_lock_addref() was called against
451          * osc_lock::ols_lock. This is used for sanity checking.
452          *
453          * \see osc_lock::ols_has_ref
454          */
455         unsigned                ols_hold :1,
456         /**
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:
460          *
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
464          *
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).
470          */
471                                 ols_has_ref:1,
472         /**
473          * inherit the lockless attribute from top level cl_io.
474          * If true, osc_lock_enqueue is able to tolerate the -EUSERS error.
475          */
476                                 ols_locklessable:1,
477         /**
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.
483          */
484                                 ols_glimpse:1,
485         /**
486          * For async glimpse lock.
487          */
488                                 ols_agl:1,
489         /**
490          * for speculative locks - asynchronous glimpse locks and ladvise
491          * lockahead manual lock requests
492          *
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.
496          */
497                                 ols_speculative:1;
498 };
499
500 static inline int osc_lock_is_lockless(const struct osc_lock *ols)
501 {
502         return (ols->ols_cl.cls_ops == ols->ols_lockless_ops);
503 }
504
505 /**
506  * Page state private for osc layer.
507  */
508 struct osc_page {
509         struct cl_page_slice  ops_cl;
510         /**
511          * Page queues used by osc to detect when RPC can be formed.
512          */
513         struct osc_async_page ops_oap;
514         /**
515          * An offset within page from which next transfer starts. This is used
516          * by cl_page_clip() to submit partial page transfers.
517          */
518         int                   ops_from;
519         /**
520          * An offset within page at which next transfer ends.
521          *
522          * \see osc_page::ops_from.
523          */
524         int                   ops_to;
525         /**
526          * Boolean, true iff page is under transfer. Used for sanity checking.
527          */
528         unsigned              ops_transfer_pinned:1,
529         /**
530          * in LRU?
531          */
532                                 ops_in_lru:1,
533         /**
534          * Set if the page must be transferred with OBD_BRW_SRVLOCK.
535          */
536                                 ops_srvlock:1;
537         /**
538          * lru page list. See osc_lru_{del|use}() in osc_page.c for usage.
539          */
540         struct list_head        ops_lru;
541         /**
542          * Submit time - the time when the page is starting RPC. For debugging.
543          */
544         cfs_time_t              ops_submit_time;
545 };
546
547 struct osc_brw_async_args {
548         struct obdo             *aa_oa;
549         int                      aa_requested_nob;
550         int                      aa_nio_count;
551         u32                      aa_page_count;
552         int                      aa_resends;
553         struct brw_page         **aa_ppga;
554         struct client_obd       *aa_cli;
555         struct list_head         aa_oaps;
556         struct list_head         aa_exts;
557 };
558
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;
565
566 extern struct lu_context_key osc_key;
567 extern struct lu_context_key osc_session_key;
568
569 #define OSC_FLAGS (ASYNC_URGENT|ASYNC_READY)
570
571 /* osc_page.c */
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);
582
583 /* osc_cache.c */
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,
586                         u32 async_flags);
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, const struct cl_io *io,
598                          struct osc_object *obj, struct list_head *list,
599                          int brw_flags);
600 int osc_cache_truncate_start(const struct lu_env *env, struct osc_object *obj,
601                              __u64 size, struct osc_extent **extp);
602 void osc_cache_truncate_end(const struct lu_env *env, struct osc_extent *ext);
603 int osc_cache_writeback_range(const struct lu_env *env, struct osc_object *obj,
604                               pgoff_t start, pgoff_t end, int hp, int discard);
605 int osc_cache_wait_range(const struct lu_env *env, struct osc_object *obj,
606                          pgoff_t start, pgoff_t end);
607 int osc_io_unplug0(const struct lu_env *env, struct client_obd *cli,
608                    struct osc_object *osc, int async);
609 void osc_wake_cache_waiters(struct client_obd *cli);
610
611 static inline int osc_io_unplug_async(const struct lu_env *env,
612                                       struct client_obd *cli,
613                                       struct osc_object *osc)
614 {
615         return osc_io_unplug0(env, cli, osc, 1);
616 }
617
618 static inline void osc_io_unplug(const struct lu_env *env,
619                                  struct client_obd *cli,
620                                  struct osc_object *osc)
621 {
622         (void)osc_io_unplug0(env, cli, osc, 0);
623 }
624
625 typedef int (*osc_page_gang_cbt)(const struct lu_env *, struct cl_io *,
626                                  struct osc_page *, void *);
627 int osc_page_gang_lookup(const struct lu_env *env, struct cl_io *io,
628                         struct osc_object *osc, pgoff_t start, pgoff_t end,
629                         osc_page_gang_cbt cb, void *cbdata);
630 int osc_discard_cb(const struct lu_env *env, struct cl_io *io,
631                    struct osc_page *ops, void *cbdata);
632
633 /* osc_dev.c */
634 int osc_device_init(const struct lu_env *env, struct lu_device *d,
635                     const char *name, struct lu_device *next);
636 struct lu_device *osc_device_fini(const struct lu_env *env,
637                                   struct lu_device *d);
638 struct lu_device *osc_device_free(const struct lu_env *env,
639                                   struct lu_device *d);
640
641 /* osc_object.c */
642 int osc_object_init(const struct lu_env *env, struct lu_object *obj,
643                     const struct lu_object_conf *conf);
644 void osc_object_free(const struct lu_env *env, struct lu_object *obj);
645 int osc_lvb_print(const struct lu_env *env, void *cookie,
646                   lu_printer_t p, const struct ost_lvb *lvb);
647 int osc_object_print(const struct lu_env *env, void *cookie,
648                      lu_printer_t p, const struct lu_object *obj);
649 int osc_attr_get(const struct lu_env *env, struct cl_object *obj,
650                  struct cl_attr *attr);
651 int osc_attr_update(const struct lu_env *env, struct cl_object *obj,
652                     const struct cl_attr *attr, unsigned valid);
653 int osc_object_glimpse(const struct lu_env *env, const struct cl_object *obj,
654                        struct ost_lvb *lvb);
655 int osc_object_invalidate(const struct lu_env *env, struct osc_object *osc);
656 int osc_object_is_contended(struct osc_object *obj);
657 int osc_object_find_cbdata(const struct lu_env *env, struct cl_object *obj,
658                            ldlm_iterator_t iter, void *data);
659 int osc_object_prune(const struct lu_env *env, struct cl_object *obj);
660
661 /* osc_request.c */
662 void osc_init_grant(struct client_obd *cli, struct obd_connect_data *ocd);
663 int osc_setup_common(struct obd_device *obd, struct lustre_cfg *lcfg);
664 int osc_precleanup_common(struct obd_device *obd);
665 int osc_cleanup_common(struct obd_device *obd);
666 int osc_set_info_async(const struct lu_env *env, struct obd_export *exp,
667                        u32 keylen, void *key, u32 vallen, void *val,
668                        struct ptlrpc_request_set *set);
669 int osc_ldlm_resource_invalidate(struct cfs_hash *hs, struct cfs_hash_bd *bd,
670                                  struct hlist_node *hnode, void *arg);
671 int osc_reconnect(const struct lu_env *env, struct obd_export *exp,
672                   struct obd_device *obd, struct obd_uuid *cluuid,
673                   struct obd_connect_data *data, void *localdata);
674 int osc_disconnect(struct obd_export *exp);
675 int osc_punch_send(struct obd_export *exp, struct obdo *oa,
676                    obd_enqueue_update_f upcall, void *cookie);
677
678 /* osc_io.c */
679 int osc_io_submit(const struct lu_env *env, const struct cl_io_slice *ios,
680                   enum cl_req_type crt, struct cl_2queue *queue);
681 int osc_io_commit_async(const struct lu_env *env,
682                         const struct cl_io_slice *ios,
683                         struct cl_page_list *qin, int from, int to,
684                         cl_commit_cbt cb);
685 int osc_io_iter_init(const struct lu_env *env, const struct cl_io_slice *ios);
686 void osc_io_iter_fini(const struct lu_env *env,
687                       const struct cl_io_slice *ios);
688 int osc_io_write_iter_init(const struct lu_env *env,
689                            const struct cl_io_slice *ios);
690 void osc_io_write_iter_fini(const struct lu_env *env,
691                             const struct cl_io_slice *ios);
692 int osc_io_fault_start(const struct lu_env *env, const struct cl_io_slice *ios);
693 void osc_io_setattr_end(const struct lu_env *env,
694                         const struct cl_io_slice *slice);
695 int osc_io_read_start(const struct lu_env *env,
696                       const struct cl_io_slice *slice);
697 int osc_io_write_start(const struct lu_env *env,
698                        const struct cl_io_slice *slice);
699 void osc_io_end(const struct lu_env *env, const struct cl_io_slice *slice);
700 int osc_fsync_ost(const struct lu_env *env, struct osc_object *obj,
701                   struct cl_fsync_io *fio);
702 void osc_io_fsync_end(const struct lu_env *env,
703                       const struct cl_io_slice *slice);
704 void osc_read_ahead_release(const struct lu_env *env, void *cbdata);
705
706 /* osc_lock.c */
707 void osc_lock_to_lockless(const struct lu_env *env, struct osc_lock *ols,
708                           int force);
709 void osc_lock_wake_waiters(const struct lu_env *env, struct osc_object *osc,
710                            struct osc_lock *oscl);
711 int osc_lock_enqueue_wait(const struct lu_env *env, struct osc_object *obj,
712                           struct osc_lock *oscl);
713 void osc_lock_set_writer(const struct lu_env *env, const struct cl_io *io,
714                          struct cl_object *obj, struct osc_lock *oscl);
715 int osc_lock_print(const struct lu_env *env, void *cookie,
716                    lu_printer_t p, const struct cl_lock_slice *slice);
717 void osc_lock_cancel(const struct lu_env *env,
718                      const struct cl_lock_slice *slice);
719 void osc_lock_fini(const struct lu_env *env, struct cl_lock_slice *slice);
720 int osc_ldlm_glimpse_ast(struct ldlm_lock *dlmlock, void *data);
721
722 /*****************************************************************************
723  *
724  * Accessors and type conversions.
725  *
726  */
727 static inline struct osc_thread_info *osc_env_info(const struct lu_env *env)
728 {
729         struct osc_thread_info *info;
730
731         info = lu_context_key_get(&env->le_ctx, &osc_key);
732         LASSERT(info != NULL);
733         return info;
734 }
735
736 static inline struct osc_session *osc_env_session(const struct lu_env *env)
737 {
738         struct osc_session *ses;
739
740         ses = lu_context_key_get(env->le_ses, &osc_session_key);
741         LASSERT(ses != NULL);
742         return ses;
743 }
744
745 static inline struct osc_io *osc_env_io(const struct lu_env *env)
746 {
747         return &osc_env_session(env)->os_io;
748 }
749
750 static inline struct osc_device *lu2osc_dev(const struct lu_device *d)
751 {
752         return container_of0(d, struct osc_device, od_cl.cd_lu_dev);
753 }
754
755 static inline struct obd_export *osc_export(const struct osc_object *obj)
756 {
757         return lu2osc_dev(obj->oo_cl.co_lu.lo_dev)->od_exp;
758 }
759
760 static inline struct client_obd *osc_cli(const struct osc_object *obj)
761 {
762         return &osc_export(obj)->exp_obd->u.cli;
763 }
764
765 static inline struct osc_object *cl2osc(const struct cl_object *obj)
766 {
767         return container_of0(obj, struct osc_object, oo_cl);
768 }
769
770 static inline struct cl_object *osc2cl(const struct osc_object *obj)
771 {
772         return (struct cl_object *)&obj->oo_cl;
773 }
774
775 static inline struct osc_device *obd2osc_dev(const struct obd_device *d)
776 {
777         return container_of0(d->obd_lu_dev, struct osc_device,
778                              od_cl.cd_lu_dev);
779 }
780
781 static inline struct lu_device *osc2lu_dev(struct osc_device *osc)
782 {
783         return &osc->od_cl.cd_lu_dev;
784 }
785
786 static inline struct lu_object *osc2lu(struct osc_object *osc)
787 {
788         return &osc->oo_cl.co_lu;
789 }
790
791 static inline struct osc_object *lu2osc(const struct lu_object *obj)
792 {
793         return container_of0(obj, struct osc_object, oo_cl.co_lu);
794 }
795
796 static inline struct osc_io *cl2osc_io(const struct lu_env *env,
797                                        const struct cl_io_slice *slice)
798 {
799         struct osc_io *oio = container_of0(slice, struct osc_io, oi_cl);
800
801         LINVRNT(oio == osc_env_io(env));
802         return oio;
803 }
804
805 static inline enum ldlm_mode osc_cl_lock2ldlm(enum cl_lock_mode mode)
806 {
807         LASSERT(mode == CLM_READ || mode == CLM_WRITE || mode == CLM_GROUP);
808         if (mode == CLM_READ)
809                 return LCK_PR;
810         if (mode == CLM_WRITE)
811                 return LCK_PW;
812         return LCK_GROUP;
813 }
814
815 static inline enum cl_lock_mode osc_ldlm2cl_lock(enum ldlm_mode mode)
816 {
817         LASSERT(mode == LCK_PR || mode == LCK_PW || mode == LCK_GROUP);
818         if (mode == LCK_PR)
819                 return CLM_READ;
820         if (mode == LCK_PW)
821                 return CLM_WRITE;
822         return CLM_GROUP;
823 }
824
825 static inline struct osc_page *cl2osc_page(const struct cl_page_slice *slice)
826 {
827         return container_of0(slice, struct osc_page, ops_cl);
828 }
829
830 static inline struct osc_page *oap2osc(struct osc_async_page *oap)
831 {
832         return container_of0(oap, struct osc_page, ops_oap);
833 }
834
835 static inline pgoff_t osc_index(struct osc_page *opg)
836 {
837         return opg->ops_cl.cpl_index;
838 }
839
840 static inline struct cl_page *oap2cl_page(struct osc_async_page *oap)
841 {
842         return oap2osc(oap)->ops_cl.cpl_page;
843 }
844
845 static inline struct osc_page *oap2osc_page(struct osc_async_page *oap)
846 {
847         return (struct osc_page *)container_of(oap, struct osc_page, ops_oap);
848 }
849
850 static inline struct osc_page *
851 osc_cl_page_osc(struct cl_page *page, struct osc_object *osc)
852 {
853         const struct cl_page_slice *slice;
854
855         LASSERT(osc != NULL);
856         slice = cl_object_page_slice(&osc->oo_cl, page);
857         return cl2osc_page(slice);
858 }
859
860 static inline struct osc_lock *cl2osc_lock(const struct cl_lock_slice *slice)
861 {
862         return container_of0(slice, struct osc_lock, ols_cl);
863 }
864
865 static inline int osc_io_srvlock(struct osc_io *oio)
866 {
867         return (oio->oi_lockless && !oio->oi_cl.cis_io->ci_no_srvlock);
868 }
869
870 enum osc_extent_state {
871         OES_INV       = 0, /** extent is just initialized or destroyed */
872         OES_ACTIVE    = 1, /** process is using this extent */
873         OES_CACHE     = 2, /** extent is ready for IO */
874         OES_LOCKING   = 3, /** locking page to prepare IO */
875         OES_LOCK_DONE = 4, /** locking finished, ready to send */
876         OES_RPC       = 5, /** in RPC */
877         OES_TRUNC     = 6, /** being truncated */
878         OES_STATE_MAX
879 };
880
881 /**
882  * osc_extent data to manage dirty pages.
883  * osc_extent has the following attributes:
884  * 1. all pages in the same must be in one RPC in write back;
885  * 2. # of pages must be less than max_pages_per_rpc - implied by 1;
886  * 3. must be covered by only 1 osc_lock;
887  * 4. exclusive. It's impossible to have overlapped osc_extent.
888  *
889  * The lifetime of an extent is from when the 1st page is dirtied to when
890  * all pages inside it are written out.
891  *
892  * LOCKING ORDER
893  * =============
894  * page lock -> client_obd_list_lock -> object lock(osc_object::oo_lock)
895  */
896 struct osc_extent {
897         /** red-black tree node */
898         struct rb_node          oe_node;
899         /** osc_object of this extent */
900         struct osc_object       *oe_obj;
901         /** refcount, removed from red-black tree if reaches zero. */
902         atomic_t                oe_refc;
903         /** busy if non-zero */
904         atomic_t                oe_users;
905         /** link list of osc_object's oo_{hp|urgent|locking}_exts. */
906         struct list_head        oe_link;
907         /** state of this extent */
908         enum osc_extent_state   oe_state;
909         /** flags for this extent. */
910         unsigned int            oe_intree:1,
911         /** 0 is write, 1 is read */
912                                 oe_rw:1,
913         /** sync extent, queued by osc_queue_sync_pages() */
914                                 oe_sync:1,
915         /** set if this extent has partial, sync pages.
916          * Extents with partial page(s) can't merge with others in RPC */
917                                 oe_no_merge:1,
918                                 oe_srvlock:1,
919                                 oe_memalloc:1,
920         /** an ACTIVE extent is going to be truncated, so when this extent
921          * is released, it will turn into TRUNC state instead of CACHE. */
922                                 oe_trunc_pending:1,
923         /** this extent should be written asap and someone may wait for the
924          * write to finish. This bit is usually set along with urgent if
925          * the extent was CACHE state.
926          * fsync_wait extent can't be merged because new extent region may
927          * exceed fsync range. */
928                                 oe_fsync_wait:1,
929         /** covering lock is being canceled */
930                                 oe_hp:1,
931         /** this extent should be written back asap. set if one of pages is
932          * called by page WB daemon, or sync write or reading requests. */
933                                 oe_urgent:1,
934         /** Non-delay RPC should be used for this extent. */
935                                 oe_ndelay:1;
936         /** how many grants allocated for this extent.
937          *  Grant allocated for this extent. There is no grant allocated
938          *  for reading extents and sync write extents. */
939         unsigned int            oe_grants;
940         /** # of dirty pages in this extent */
941         unsigned int            oe_nr_pages;
942         /** list of pending oap pages. Pages in this list are NOT sorted. */
943         struct list_head        oe_pages;
944         /** Since an extent has to be written out in atomic, this is used to
945          * remember the next page need to be locked to write this extent out.
946          * Not used right now.
947          */
948         struct osc_page         *oe_next_page;
949         /** start and end index of this extent, include start and end
950          * themselves. Page offset here is the page index of osc_pages.
951          * oe_start is used as keyword for red-black tree. */
952         pgoff_t                 oe_start;
953         pgoff_t                 oe_end;
954         /** maximum ending index of this extent, this is limited by
955          * max_pages_per_rpc, lock extent and chunk size. */
956         pgoff_t                 oe_max_end;
957         /** waitqueue - for those who want to be notified if this extent's
958          * state has changed. */
959         wait_queue_head_t       oe_waitq;
960         /** lock covering this extent */
961         struct ldlm_lock        *oe_dlmlock;
962         /** terminator of this extent. Must be true if this extent is in IO. */
963         struct task_struct      *oe_owner;
964         /** return value of writeback. If somebody is waiting for this extent,
965          * this value can be known by outside world. */
966         int                     oe_rc;
967         /** max pages per rpc when this extent was created */
968         unsigned int            oe_mppr;
969         /** FLR: layout version when this osc_extent is publised */
970         __u32                   oe_layout_version;
971 };
972
973 /** @} osc */
974
975 #endif /* LUSTRE_OSC_H */