Whamcloud - gitweb
LU-3059 obdclass: use a dummy structure for lu_ref_link
[fs/lustre-release.git] / lustre / osc / osc_cache.c
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 only,
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License version 2 for more details (a copy is included
14  * in the LICENSE file that accompanied this code).
15  *
16  * You should have received a copy of the GNU General Public License
17  * version 2 along with this program; If not, see
18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
19  *
20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21  * CA 95054 USA or visit www.sun.com if you need additional information or
22  * have any questions.
23  *
24  * GPL HEADER END
25  */
26 /*
27  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2012, 2013, Intel Corporation.
31  *
32  */
33 /*
34  * This file is part of Lustre, http://www.lustre.org/
35  * Lustre is a trademark of Sun Microsystems, Inc.
36  *
37  * osc cache management.
38  *
39  * Author: Jinshan Xiong <jinshan.xiong@whamcloud.com>
40  */
41
42 #define DEBUG_SUBSYSTEM S_OSC
43
44 #include "osc_cl_internal.h"
45 #include "osc_internal.h"
46
47 static int extent_debug; /* set it to be true for more debug */
48
49 static void osc_update_pending(struct osc_object *obj, int cmd, int delta);
50 static int osc_extent_wait(const struct lu_env *env, struct osc_extent *ext,
51                            int state);
52 static void osc_ap_completion(const struct lu_env *env, struct client_obd *cli,
53                               struct osc_async_page *oap, int sent, int rc);
54 static int osc_make_ready(const struct lu_env *env, struct osc_async_page *oap,
55                           int cmd);
56 static int osc_refresh_count(const struct lu_env *env,
57                              struct osc_async_page *oap, int cmd);
58 static int osc_io_unplug_async(const struct lu_env *env,
59                                struct client_obd *cli, struct osc_object *osc);
60 static void osc_free_grant(struct client_obd *cli, unsigned int nr_pages,
61                            unsigned int lost_grant);
62
63 static void osc_extent_tree_dump0(int level, struct osc_object *obj,
64                                   const char *func, int line);
65 #define osc_extent_tree_dump(lvl, obj) \
66         osc_extent_tree_dump0(lvl, obj, __func__, __LINE__)
67
68 /** \addtogroup osc
69  *  @{
70  */
71
72 /* ------------------ osc extent ------------------ */
73 static inline char *ext_flags(struct osc_extent *ext, char *flags)
74 {
75         char *buf = flags;
76         *buf++ = ext->oe_rw ? 'r' : 'w';
77         if (ext->oe_intree)
78                 *buf++ = 'i';
79         if (ext->oe_srvlock)
80                 *buf++ = 's';
81         if (ext->oe_hp)
82                 *buf++ = 'h';
83         if (ext->oe_urgent)
84                 *buf++ = 'u';
85         if (ext->oe_memalloc)
86                 *buf++ = 'm';
87         if (ext->oe_trunc_pending)
88                 *buf++ = 't';
89         if (ext->oe_fsync_wait)
90                 *buf++ = 'Y';
91         *buf = 0;
92         return flags;
93 }
94
95 static inline char list_empty_marker(cfs_list_t *list)
96 {
97         return cfs_list_empty(list) ? '-' : '+';
98 }
99
100 #define EXTSTR       "[%lu -> %lu/%lu]"
101 #define EXTPARA(ext) (ext)->oe_start, (ext)->oe_end, (ext)->oe_max_end
102 static const char *oes_strings[] = {
103         "inv", "active", "cache", "locking", "lockdone", "rpc", "trunc", NULL };
104
105 #define OSC_EXTENT_DUMP(lvl, extent, fmt, ...) do {                           \
106         struct osc_extent *__ext = (extent);                                  \
107         char __buf[16];                                                       \
108                                                                               \
109         CDEBUG(lvl,                                                           \
110                 "extent %p@{" EXTSTR ", "                                     \
111                 "[%d|%d|%c|%s|%s|%p], [%d|%d|%c|%c|%p|%u|%p]} " fmt,          \
112                 /* ----- extent part 0 ----- */                               \
113                 __ext, EXTPARA(__ext),                                        \
114                 /* ----- part 1 ----- */                                      \
115                 cfs_atomic_read(&__ext->oe_refc),                             \
116                 cfs_atomic_read(&__ext->oe_users),                            \
117                 list_empty_marker(&__ext->oe_link),                           \
118                 oes_strings[__ext->oe_state], ext_flags(__ext, __buf),        \
119                 __ext->oe_obj,                                                \
120                 /* ----- part 2 ----- */                                      \
121                 __ext->oe_grants, __ext->oe_nr_pages,                         \
122                 list_empty_marker(&__ext->oe_pages),                          \
123                 cfs_waitq_active(&__ext->oe_waitq) ? '+' : '-',               \
124                 __ext->oe_osclock, __ext->oe_mppr, __ext->oe_owner,           \
125                 /* ----- part 4 ----- */                                      \
126                 ## __VA_ARGS__);                                              \
127 } while (0)
128
129 #undef EASSERTF
130 #define EASSERTF(expr, ext, fmt, args...) do {                          \
131         if (!(expr)) {                                                  \
132                 OSC_EXTENT_DUMP(D_ERROR, (ext), fmt, ##args);           \
133                 osc_extent_tree_dump(D_ERROR, (ext)->oe_obj);           \
134                 LASSERT(expr);                                          \
135         }                                                               \
136 } while (0)
137
138 #undef EASSERT
139 #define EASSERT(expr, ext) EASSERTF(expr, ext, "\n")
140
141 static inline struct osc_extent *rb_extent(struct rb_node *n)
142 {
143         if (n == NULL)
144                 return NULL;
145
146         return container_of(n, struct osc_extent, oe_node);
147 }
148
149 static inline struct osc_extent *next_extent(struct osc_extent *ext)
150 {
151         if (ext == NULL)
152                 return NULL;
153
154         LASSERT(ext->oe_intree);
155         return rb_extent(rb_next(&ext->oe_node));
156 }
157
158 static inline struct osc_extent *prev_extent(struct osc_extent *ext)
159 {
160         if (ext == NULL)
161                 return NULL;
162
163         LASSERT(ext->oe_intree);
164         return rb_extent(rb_prev(&ext->oe_node));
165 }
166
167 static inline struct osc_extent *first_extent(struct osc_object *obj)
168 {
169         return rb_extent(rb_first(&obj->oo_root));
170 }
171
172 /* object must be locked by caller. */
173 static int osc_extent_sanity_check0(struct osc_extent *ext,
174                                     const char *func, const int line)
175 {
176         struct osc_object *obj = ext->oe_obj;
177         struct osc_async_page *oap;
178         int page_count;
179         int rc = 0;
180
181         if (!osc_object_is_locked(obj))
182                 GOTO(out, rc = 9);
183
184         if (ext->oe_state >= OES_STATE_MAX)
185                 GOTO(out, rc = 10);
186
187         if (cfs_atomic_read(&ext->oe_refc) <= 0)
188                 GOTO(out, rc = 20);
189
190         if (cfs_atomic_read(&ext->oe_refc) < cfs_atomic_read(&ext->oe_users))
191                 GOTO(out, rc = 30);
192
193         switch (ext->oe_state) {
194         case OES_INV:
195                 if (ext->oe_nr_pages > 0 || !cfs_list_empty(&ext->oe_pages))
196                         GOTO(out, rc = 35);
197                 GOTO(out, rc = 0);
198                 break;
199         case OES_ACTIVE:
200                 if (cfs_atomic_read(&ext->oe_users) == 0)
201                         GOTO(out, rc = 40);
202                 if (ext->oe_hp)
203                         GOTO(out, rc = 50);
204                 if (ext->oe_fsync_wait && !ext->oe_urgent)
205                         GOTO(out, rc = 55);
206                 break;
207         case OES_CACHE:
208                 if (ext->oe_grants == 0)
209                         GOTO(out, rc = 60);
210                 if (ext->oe_fsync_wait && !ext->oe_urgent && !ext->oe_hp)
211                         GOTO(out, rc = 65);
212         default:
213                 if (cfs_atomic_read(&ext->oe_users) > 0)
214                         GOTO(out, rc = 70);
215         }
216
217         if (ext->oe_max_end < ext->oe_end || ext->oe_end < ext->oe_start)
218                 GOTO(out, rc = 80);
219
220         if (ext->oe_osclock == NULL && ext->oe_grants > 0)
221                 GOTO(out, rc = 90);
222
223         if (ext->oe_osclock) {
224                 struct cl_lock_descr *descr;
225                 descr = &ext->oe_osclock->cll_descr;
226                 if (!(descr->cld_start <= ext->oe_start &&
227                       descr->cld_end >= ext->oe_max_end))
228                         GOTO(out, rc = 100);
229         }
230
231         if (ext->oe_nr_pages > ext->oe_mppr)
232                 GOTO(out, rc = 105);
233
234         /* Do not verify page list if extent is in RPC. This is because an
235          * in-RPC extent is supposed to be exclusively accessible w/o lock. */
236         if (ext->oe_state > OES_CACHE)
237                 GOTO(out, rc = 0);
238
239         if (!extent_debug)
240                 GOTO(out, rc = 0);
241
242         page_count = 0;
243         cfs_list_for_each_entry(oap, &ext->oe_pages, oap_pending_item) {
244                 pgoff_t index = oap2cl_page(oap)->cp_index;
245                 ++page_count;
246                 if (index > ext->oe_end || index < ext->oe_start)
247                         GOTO(out, rc = 110);
248         }
249         if (page_count != ext->oe_nr_pages)
250                 GOTO(out, rc = 120);
251
252 out:
253         if (rc != 0)
254                 OSC_EXTENT_DUMP(D_ERROR, ext,
255                                 "%s:%d sanity check %p failed with rc = %d\n",
256                                 func, line, ext, rc);
257         return rc;
258 }
259
260 #define sanity_check_nolock(ext) \
261         osc_extent_sanity_check0(ext, __func__, __LINE__)
262
263 #define sanity_check(ext) ({                                                   \
264         int __res;                                                             \
265         osc_object_lock((ext)->oe_obj);                                        \
266         __res = sanity_check_nolock(ext);                                      \
267         osc_object_unlock((ext)->oe_obj);                                      \
268         __res;                                                                 \
269 })
270
271
272 /**
273  * sanity check - to make sure there is no overlapped extent in the tree.
274  */
275 static int osc_extent_is_overlapped(struct osc_object *obj,
276                                     struct osc_extent *ext)
277 {
278         struct osc_extent *tmp;
279
280         LASSERT(osc_object_is_locked(obj));
281
282         if (!extent_debug)
283                 return 0;
284
285         for (tmp = first_extent(obj); tmp != NULL; tmp = next_extent(tmp)) {
286                 if (tmp == ext)
287                         continue;
288                 if (tmp->oe_end >= ext->oe_start &&
289                     tmp->oe_start <= ext->oe_end)
290                         return 1;
291         }
292         return 0;
293 }
294
295 static void osc_extent_state_set(struct osc_extent *ext, int state)
296 {
297         LASSERT(osc_object_is_locked(ext->oe_obj));
298         LASSERT(state >= OES_INV && state < OES_STATE_MAX);
299
300         /* Never try to sanity check a state changing extent :-) */
301         /* LASSERT(sanity_check_nolock(ext) == 0); */
302
303         /* TODO: validate the state machine */
304         ext->oe_state = state;
305         cfs_waitq_broadcast(&ext->oe_waitq);
306 }
307
308 static struct osc_extent *osc_extent_alloc(struct osc_object *obj)
309 {
310         struct osc_extent *ext;
311
312         OBD_SLAB_ALLOC_PTR_GFP(ext, osc_extent_kmem, CFS_ALLOC_STD);
313         if (ext == NULL)
314                 return NULL;
315
316         RB_CLEAR_NODE(&ext->oe_node);
317         ext->oe_obj = obj;
318         cfs_atomic_set(&ext->oe_refc, 1);
319         cfs_atomic_set(&ext->oe_users, 0);
320         CFS_INIT_LIST_HEAD(&ext->oe_link);
321         ext->oe_state = OES_INV;
322         CFS_INIT_LIST_HEAD(&ext->oe_pages);
323         cfs_waitq_init(&ext->oe_waitq);
324         ext->oe_osclock = NULL;
325
326         return ext;
327 }
328
329 static void osc_extent_free(struct osc_extent *ext)
330 {
331         OBD_SLAB_FREE_PTR(ext, osc_extent_kmem);
332 }
333
334 static struct osc_extent *osc_extent_get(struct osc_extent *ext)
335 {
336         LASSERT(cfs_atomic_read(&ext->oe_refc) >= 0);
337         cfs_atomic_inc(&ext->oe_refc);
338         return ext;
339 }
340
341 static void osc_extent_put(const struct lu_env *env, struct osc_extent *ext)
342 {
343         LASSERT(cfs_atomic_read(&ext->oe_refc) > 0);
344         if (cfs_atomic_dec_and_test(&ext->oe_refc)) {
345                 LASSERT(cfs_list_empty(&ext->oe_link));
346                 LASSERT(cfs_atomic_read(&ext->oe_users) == 0);
347                 LASSERT(ext->oe_state == OES_INV);
348                 LASSERT(!ext->oe_intree);
349
350                 if (ext->oe_osclock) {
351                         cl_lock_put(env, ext->oe_osclock);
352                         ext->oe_osclock = NULL;
353                 }
354                 osc_extent_free(ext);
355         }
356 }
357
358 /**
359  * osc_extent_put_trust() is a special version of osc_extent_put() when
360  * it's known that the caller is not the last user. This is to address the
361  * problem of lacking of lu_env ;-).
362  */
363 static void osc_extent_put_trust(struct osc_extent *ext)
364 {
365         LASSERT(cfs_atomic_read(&ext->oe_refc) > 1);
366         LASSERT(osc_object_is_locked(ext->oe_obj));
367         cfs_atomic_dec(&ext->oe_refc);
368 }
369
370 /**
371  * Return the extent which includes pgoff @index, or return the greatest
372  * previous extent in the tree.
373  */
374 static struct osc_extent *osc_extent_search(struct osc_object *obj,
375                                             pgoff_t index)
376 {
377         struct rb_node    *n = obj->oo_root.rb_node;
378         struct osc_extent *tmp, *p = NULL;
379
380         LASSERT(osc_object_is_locked(obj));
381         while (n != NULL) {
382                 tmp = rb_extent(n);
383                 if (index < tmp->oe_start) {
384                         n = n->rb_left;
385                 } else if (index > tmp->oe_end) {
386                         p = rb_extent(n);
387                         n = n->rb_right;
388                 } else {
389                         return tmp;
390                 }
391         }
392         return p;
393 }
394
395 /*
396  * Return the extent covering @index, otherwise return NULL.
397  * caller must have held object lock.
398  */
399 static struct osc_extent *osc_extent_lookup(struct osc_object *obj,
400                                             pgoff_t index)
401 {
402         struct osc_extent *ext;
403
404         ext = osc_extent_search(obj, index);
405         if (ext != NULL && ext->oe_start <= index && index <= ext->oe_end)
406                 return osc_extent_get(ext);
407         return NULL;
408 }
409
410 /* caller must have held object lock. */
411 static void osc_extent_insert(struct osc_object *obj, struct osc_extent *ext)
412 {
413         struct rb_node   **n      = &obj->oo_root.rb_node;
414         struct rb_node    *parent = NULL;
415         struct osc_extent *tmp;
416
417         LASSERT(ext->oe_intree == 0);
418         LASSERT(ext->oe_obj == obj);
419         LASSERT(osc_object_is_locked(obj));
420         while (*n != NULL) {
421                 tmp = rb_extent(*n);
422                 parent = *n;
423
424                 if (ext->oe_end < tmp->oe_start)
425                         n = &(*n)->rb_left;
426                 else if (ext->oe_start > tmp->oe_end)
427                         n = &(*n)->rb_right;
428                 else
429                         EASSERTF(0, tmp, EXTSTR, EXTPARA(ext));
430         }
431         rb_link_node(&ext->oe_node, parent, n);
432         rb_insert_color(&ext->oe_node, &obj->oo_root);
433         osc_extent_get(ext);
434         ext->oe_intree = 1;
435 }
436
437 /* caller must have held object lock. */
438 static void osc_extent_erase(struct osc_extent *ext)
439 {
440         struct osc_object *obj = ext->oe_obj;
441         LASSERT(osc_object_is_locked(obj));
442         if (ext->oe_intree) {
443                 rb_erase(&ext->oe_node, &obj->oo_root);
444                 ext->oe_intree = 0;
445                 /* rbtree held a refcount */
446                 osc_extent_put_trust(ext);
447         }
448 }
449
450 static struct osc_extent *osc_extent_hold(struct osc_extent *ext)
451 {
452         struct osc_object *obj = ext->oe_obj;
453
454         LASSERT(osc_object_is_locked(obj));
455         LASSERT(ext->oe_state == OES_ACTIVE || ext->oe_state == OES_CACHE);
456         if (ext->oe_state == OES_CACHE) {
457                 osc_extent_state_set(ext, OES_ACTIVE);
458                 osc_update_pending(obj, OBD_BRW_WRITE, -ext->oe_nr_pages);
459         }
460         cfs_atomic_inc(&ext->oe_users);
461         cfs_list_del_init(&ext->oe_link);
462         return osc_extent_get(ext);
463 }
464
465 static void __osc_extent_remove(struct osc_extent *ext)
466 {
467         LASSERT(osc_object_is_locked(ext->oe_obj));
468         LASSERT(cfs_list_empty(&ext->oe_pages));
469         osc_extent_erase(ext);
470         cfs_list_del_init(&ext->oe_link);
471         osc_extent_state_set(ext, OES_INV);
472         OSC_EXTENT_DUMP(D_CACHE, ext, "destroyed.\n");
473 }
474
475 static void osc_extent_remove(struct osc_extent *ext)
476 {
477         struct osc_object *obj = ext->oe_obj;
478
479         osc_object_lock(obj);
480         __osc_extent_remove(ext);
481         osc_object_unlock(obj);
482 }
483
484 /**
485  * This function is used to merge extents to get better performance. It checks
486  * if @cur and @victim are contiguous at chunk level.
487  */
488 static int osc_extent_merge(const struct lu_env *env, struct osc_extent *cur,
489                             struct osc_extent *victim)
490 {
491         struct osc_object *obj = cur->oe_obj;
492         pgoff_t chunk_start;
493         pgoff_t chunk_end;
494         int ppc_bits;
495
496         LASSERT(cur->oe_state == OES_CACHE);
497         LASSERT(osc_object_is_locked(obj));
498         if (victim == NULL)
499                 return -EINVAL;
500
501         if (victim->oe_state != OES_CACHE || victim->oe_fsync_wait)
502                 return -EBUSY;
503
504         if (cur->oe_max_end != victim->oe_max_end)
505                 return -ERANGE;
506
507         LASSERT(cur->oe_osclock == victim->oe_osclock);
508         ppc_bits = osc_cli(obj)->cl_chunkbits - CFS_PAGE_SHIFT;
509         chunk_start = cur->oe_start >> ppc_bits;
510         chunk_end   = cur->oe_end   >> ppc_bits;
511         if (chunk_start   != (victim->oe_end >> ppc_bits) + 1 &&
512             chunk_end + 1 != victim->oe_start >> ppc_bits)
513                 return -ERANGE;
514
515         OSC_EXTENT_DUMP(D_CACHE, victim, "will be merged by %p.\n", cur);
516
517         cur->oe_start     = min(cur->oe_start, victim->oe_start);
518         cur->oe_end       = max(cur->oe_end,   victim->oe_end);
519         cur->oe_grants   += victim->oe_grants;
520         cur->oe_nr_pages += victim->oe_nr_pages;
521         /* only the following bits are needed to merge */
522         cur->oe_urgent   |= victim->oe_urgent;
523         cur->oe_memalloc |= victim->oe_memalloc;
524         cfs_list_splice_init(&victim->oe_pages, &cur->oe_pages);
525         cfs_list_del_init(&victim->oe_link);
526         victim->oe_nr_pages = 0;
527
528         osc_extent_get(victim);
529         __osc_extent_remove(victim);
530         osc_extent_put(env, victim);
531
532         OSC_EXTENT_DUMP(D_CACHE, cur, "after merging %p.\n", victim);
533         return 0;
534 }
535
536 /**
537  * Drop user count of osc_extent, and unplug IO asynchronously.
538  */
539 int osc_extent_release(const struct lu_env *env, struct osc_extent *ext)
540 {
541         struct osc_object *obj = ext->oe_obj;
542         int rc = 0;
543         ENTRY;
544
545         LASSERT(cfs_atomic_read(&ext->oe_users) > 0);
546         LASSERT(sanity_check(ext) == 0);
547         LASSERT(ext->oe_grants > 0);
548
549         if (cfs_atomic_dec_and_lock(&ext->oe_users, &obj->oo_lock)) {
550                 LASSERT(ext->oe_state == OES_ACTIVE);
551                 if (ext->oe_trunc_pending) {
552                         /* a truncate process is waiting for this extent.
553                          * This may happen due to a race, check
554                          * osc_cache_truncate_start(). */
555                         osc_extent_state_set(ext, OES_TRUNC);
556                         ext->oe_trunc_pending = 0;
557                 } else {
558                         osc_extent_state_set(ext, OES_CACHE);
559                         osc_update_pending(obj, OBD_BRW_WRITE,
560                                            ext->oe_nr_pages);
561
562                         /* try to merge the previous and next extent. */
563                         osc_extent_merge(env, ext, prev_extent(ext));
564                         osc_extent_merge(env, ext, next_extent(ext));
565
566                         if (ext->oe_urgent)
567                                 cfs_list_move_tail(&ext->oe_link,
568                                                    &obj->oo_urgent_exts);
569                 }
570                 osc_object_unlock(obj);
571
572                 osc_io_unplug_async(env, osc_cli(obj), obj);
573         }
574         osc_extent_put(env, ext);
575         RETURN(rc);
576 }
577
578 static inline int overlapped(struct osc_extent *ex1, struct osc_extent *ex2)
579 {
580         return !(ex1->oe_end < ex2->oe_start || ex2->oe_end < ex1->oe_start);
581 }
582
583 /**
584  * Find or create an extent which includes @index, core function to manage
585  * extent tree.
586  */
587 struct osc_extent *osc_extent_find(const struct lu_env *env,
588                                    struct osc_object *obj, pgoff_t index,
589                                    int *grants)
590
591 {
592         struct client_obd *cli = osc_cli(obj);
593         struct cl_lock    *lock;
594         struct osc_extent *cur;
595         struct osc_extent *ext;
596         struct osc_extent *conflict = NULL;
597         struct osc_extent *found = NULL;
598         pgoff_t    chunk;
599         pgoff_t    max_end;
600         int        max_pages; /* max_pages_per_rpc */
601         int        chunksize;
602         int        ppc_bits; /* pages per chunk bits */
603         int        chunk_mask;
604         int        rc;
605         ENTRY;
606
607         cur = osc_extent_alloc(obj);
608         if (cur == NULL)
609                 RETURN(ERR_PTR(-ENOMEM));
610
611         lock = cl_lock_at_pgoff(env, osc2cl(obj), index, NULL, 1, 0);
612         LASSERT(lock != NULL);
613         LASSERT(lock->cll_descr.cld_mode >= CLM_WRITE);
614
615         LASSERT(cli->cl_chunkbits >= CFS_PAGE_SHIFT);
616         ppc_bits   = cli->cl_chunkbits - CFS_PAGE_SHIFT;
617         chunk_mask = ~((1 << ppc_bits) - 1);
618         chunksize  = 1 << cli->cl_chunkbits;
619         chunk      = index >> ppc_bits;
620
621         /* align end to rpc edge, rpc size may not be a power 2 integer. */
622         max_pages = cli->cl_max_pages_per_rpc;
623         LASSERT((max_pages & ~chunk_mask) == 0);
624         max_end = index - (index % max_pages) + max_pages - 1;
625         max_end = min_t(pgoff_t, max_end, lock->cll_descr.cld_end);
626
627         /* initialize new extent by parameters so far */
628         cur->oe_max_end = max_end;
629         cur->oe_start   = index & chunk_mask;
630         cur->oe_end     = ((index + ~chunk_mask + 1) & chunk_mask) - 1;
631         if (cur->oe_start < lock->cll_descr.cld_start)
632                 cur->oe_start = lock->cll_descr.cld_start;
633         if (cur->oe_end > max_end)
634                 cur->oe_end = max_end;
635         cur->oe_osclock = lock;
636         cur->oe_grants  = 0;
637         cur->oe_mppr    = max_pages;
638
639         /* grants has been allocated by caller */
640         LASSERTF(*grants >= chunksize + cli->cl_extent_tax,
641                  "%u/%u/%u.\n", *grants, chunksize, cli->cl_extent_tax);
642         LASSERTF((max_end - cur->oe_start) < max_pages, EXTSTR, EXTPARA(cur));
643
644 restart:
645         osc_object_lock(obj);
646         ext = osc_extent_search(obj, cur->oe_start);
647         if (ext == NULL)
648                 ext = first_extent(obj);
649         while (ext != NULL) {
650                 loff_t ext_chk_start = ext->oe_start >> ppc_bits;
651                 loff_t ext_chk_end   = ext->oe_end   >> ppc_bits;
652
653                 LASSERT(sanity_check_nolock(ext) == 0);
654                 if (chunk > ext_chk_end + 1)
655                         break;
656
657                 /* if covering by different locks, no chance to match */
658                 if (lock != ext->oe_osclock) {
659                         EASSERTF(!overlapped(ext, cur), ext,
660                                  EXTSTR, EXTPARA(cur));
661
662                         ext = next_extent(ext);
663                         continue;
664                 }
665
666                 /* discontiguous chunks? */
667                 if (chunk + 1 < ext_chk_start) {
668                         ext = next_extent(ext);
669                         continue;
670                 }
671
672                 /* ok, from now on, ext and cur have these attrs:
673                  * 1. covered by the same lock
674                  * 2. contiguous at chunk level or overlapping. */
675
676                 if (overlapped(ext, cur)) {
677                         /* cur is the minimum unit, so overlapping means
678                          * full contain. */
679                         EASSERTF((ext->oe_start <= cur->oe_start &&
680                                   ext->oe_end >= cur->oe_end),
681                                  ext, EXTSTR, EXTPARA(cur));
682
683                         if (ext->oe_state > OES_CACHE || ext->oe_fsync_wait) {
684                                 /* for simplicity, we wait for this extent to
685                                  * finish before going forward. */
686                                 conflict = osc_extent_get(ext);
687                                 break;
688                         }
689
690                         found = osc_extent_hold(ext);
691                         break;
692                 }
693
694                 /* non-overlapped extent */
695                 if (ext->oe_state != OES_CACHE || ext->oe_fsync_wait) {
696                         /* we can't do anything for a non OES_CACHE extent, or
697                          * if there is someone waiting for this extent to be
698                          * flushed, try next one. */
699                         ext = next_extent(ext);
700                         continue;
701                 }
702
703                 /* check if they belong to the same rpc slot before trying to
704                  * merge. the extents are not overlapped and contiguous at
705                  * chunk level to get here. */
706                 if (ext->oe_max_end != max_end) {
707                         /* if they don't belong to the same RPC slot or
708                          * max_pages_per_rpc has ever changed, do not merge. */
709                         ext = next_extent(ext);
710                         continue;
711                 }
712
713                 /* it's required that an extent must be contiguous at chunk
714                  * level so that we know the whole extent is covered by grant
715                  * (the pages in the extent are NOT required to be contiguous).
716                  * Otherwise, it will be too much difficult to know which
717                  * chunks have grants allocated. */
718
719                 /* try to do front merge - extend ext's start */
720                 if (chunk + 1 == ext_chk_start) {
721                         /* ext must be chunk size aligned */
722                         EASSERT((ext->oe_start & ~chunk_mask) == 0, ext);
723
724                         /* pull ext's start back to cover cur */
725                         ext->oe_start   = cur->oe_start;
726                         ext->oe_grants += chunksize;
727                         *grants -= chunksize;
728
729                         found = osc_extent_hold(ext);
730                 } else if (chunk == ext_chk_end + 1) {
731                         /* rear merge */
732                         ext->oe_end     = cur->oe_end;
733                         ext->oe_grants += chunksize;
734                         *grants -= chunksize;
735
736                         /* try to merge with the next one because we just fill
737                          * in a gap */
738                         if (osc_extent_merge(env, ext, next_extent(ext)) == 0)
739                                 /* we can save extent tax from next extent */
740                                 *grants += cli->cl_extent_tax;
741
742                         found = osc_extent_hold(ext);
743                 }
744                 if (found != NULL)
745                         break;
746
747                 ext = next_extent(ext);
748         }
749
750         osc_extent_tree_dump(D_CACHE, obj);
751         if (found != NULL) {
752                 LASSERT(conflict == NULL);
753                 if (!IS_ERR(found)) {
754                         LASSERT(found->oe_osclock == cur->oe_osclock);
755                         OSC_EXTENT_DUMP(D_CACHE, found,
756                                         "found caching ext for %lu.\n", index);
757                 }
758         } else if (conflict == NULL) {
759                 /* create a new extent */
760                 EASSERT(osc_extent_is_overlapped(obj, cur) == 0, cur);
761                 cur->oe_grants = chunksize + cli->cl_extent_tax;
762                 *grants -= cur->oe_grants;
763                 LASSERT(*grants >= 0);
764
765                 cur->oe_state = OES_CACHE;
766                 found = osc_extent_hold(cur);
767                 osc_extent_insert(obj, cur);
768                 OSC_EXTENT_DUMP(D_CACHE, cur, "add into tree %lu/%lu.\n",
769                                 index, lock->cll_descr.cld_end);
770         }
771         osc_object_unlock(obj);
772
773         if (conflict != NULL) {
774                 LASSERT(found == NULL);
775
776                 /* waiting for IO to finish. Please notice that it's impossible
777                  * to be an OES_TRUNC extent. */
778                 rc = osc_extent_wait(env, conflict, OES_INV);
779                 osc_extent_put(env, conflict);
780                 conflict = NULL;
781                 if (rc < 0)
782                         GOTO(out, found = ERR_PTR(rc));
783
784                 goto restart;
785         }
786         EXIT;
787
788 out:
789         osc_extent_put(env, cur);
790         LASSERT(*grants >= 0);
791         return found;
792 }
793
794 /**
795  * Called when IO is finished to an extent.
796  */
797 int osc_extent_finish(const struct lu_env *env, struct osc_extent *ext,
798                       int sent, int rc)
799 {
800         struct client_obd *cli = osc_cli(ext->oe_obj);
801         struct osc_async_page *oap;
802         struct osc_async_page *tmp;
803         int nr_pages = ext->oe_nr_pages;
804         int lost_grant = 0;
805         int blocksize = cli->cl_import->imp_obd->obd_osfs.os_bsize ? : 4096;
806         __u64 last_off = 0;
807         int last_count = -1;
808         ENTRY;
809
810         OSC_EXTENT_DUMP(D_CACHE, ext, "extent finished.\n");
811
812         ext->oe_rc = rc ?: ext->oe_nr_pages;
813         EASSERT(ergo(rc == 0, ext->oe_state == OES_RPC), ext);
814         cfs_list_for_each_entry_safe(oap, tmp, &ext->oe_pages,
815                                      oap_pending_item) {
816                 cfs_list_del_init(&oap->oap_rpc_item);
817                 cfs_list_del_init(&oap->oap_pending_item);
818                 if (last_off <= oap->oap_obj_off) {
819                         last_off = oap->oap_obj_off;
820                         last_count = oap->oap_count;
821                 }
822
823                 --ext->oe_nr_pages;
824                 osc_ap_completion(env, cli, oap, sent, rc);
825         }
826         EASSERT(ext->oe_nr_pages == 0, ext);
827
828         if (!sent) {
829                 lost_grant = ext->oe_grants;
830         } else if (blocksize < CFS_PAGE_SIZE &&
831                    last_count != CFS_PAGE_SIZE) {
832                 /* For short writes we shouldn't count parts of pages that
833                  * span a whole chunk on the OST side, or our accounting goes
834                  * wrong.  Should match the code in filter_grant_check. */
835                 int offset = oap->oap_page_off & ~CFS_PAGE_MASK;
836                 int count = oap->oap_count + (offset & (blocksize - 1));
837                 int end = (offset + oap->oap_count) & (blocksize - 1);
838                 if (end)
839                         count += blocksize - end;
840
841                 lost_grant = CFS_PAGE_SIZE - count;
842         }
843         if (ext->oe_grants > 0)
844                 osc_free_grant(cli, nr_pages, lost_grant);
845
846         osc_extent_remove(ext);
847         /* put the refcount for RPC */
848         osc_extent_put(env, ext);
849         RETURN(0);
850 }
851
852 static int extent_wait_cb(struct osc_extent *ext, int state)
853 {
854         int ret;
855
856         osc_object_lock(ext->oe_obj);
857         ret = ext->oe_state == state;
858         osc_object_unlock(ext->oe_obj);
859
860         return ret;
861 }
862
863 /**
864  * Wait for the extent's state to become @state.
865  */
866 static int osc_extent_wait(const struct lu_env *env, struct osc_extent *ext,
867                            int state)
868 {
869         struct osc_object *obj = ext->oe_obj;
870         struct l_wait_info lwi = LWI_TIMEOUT_INTR(cfs_time_seconds(600), NULL,
871                                                   LWI_ON_SIGNAL_NOOP, NULL);
872         int rc = 0;
873         ENTRY;
874
875         osc_object_lock(obj);
876         LASSERT(sanity_check_nolock(ext) == 0);
877         /* `Kick' this extent only if the caller is waiting for it to be
878          * written out. */
879         if (state == OES_INV && !ext->oe_urgent && !ext->oe_hp) {
880                 if (ext->oe_state == OES_ACTIVE) {
881                         ext->oe_urgent = 1;
882                 } else if (ext->oe_state == OES_CACHE) {
883                         ext->oe_urgent = 1;
884                         osc_extent_hold(ext);
885                         rc = 1;
886                 }
887         }
888         osc_object_unlock(obj);
889         if (rc == 1)
890                 osc_extent_release(env, ext);
891
892         /* wait for the extent until its state becomes @state */
893         rc = l_wait_event(ext->oe_waitq, extent_wait_cb(ext, state), &lwi);
894         if (rc == -ETIMEDOUT) {
895                 OSC_EXTENT_DUMP(D_ERROR, ext,
896                         "%s: wait ext to %d timedout, recovery in progress?\n",
897                         osc_export(obj)->exp_obd->obd_name, state);
898
899                 lwi = LWI_INTR(LWI_ON_SIGNAL_NOOP, NULL);
900                 rc = l_wait_event(ext->oe_waitq, extent_wait_cb(ext, state),
901                                   &lwi);
902         }
903         if (rc == 0 && ext->oe_rc < 0)
904                 rc = ext->oe_rc;
905         RETURN(rc);
906 }
907
908 /**
909  * Discard pages with index greater than @size. If @ext is overlapped with
910  * @size, then partial truncate happens.
911  */
912 static int osc_extent_truncate(struct osc_extent *ext, pgoff_t trunc_index,
913                                 bool partial)
914 {
915         struct cl_env_nest     nest;
916         struct lu_env         *env;
917         struct cl_io          *io;
918         struct osc_object     *obj = ext->oe_obj;
919         struct client_obd     *cli = osc_cli(obj);
920         struct osc_async_page *oap;
921         struct osc_async_page *tmp;
922         int                    pages_in_chunk = 0;
923         int                    ppc_bits    = cli->cl_chunkbits - CFS_PAGE_SHIFT;
924         __u64                  trunc_chunk = trunc_index >> ppc_bits;
925         int                    grants   = 0;
926         int                    nr_pages = 0;
927         int                    rc       = 0;
928         ENTRY;
929
930         LASSERT(sanity_check(ext) == 0);
931         LASSERT(ext->oe_state == OES_TRUNC);
932         LASSERT(!ext->oe_urgent);
933
934         /* Request new lu_env.
935          * We can't use that env from osc_cache_truncate_start() because
936          * it's from lov_io_sub and not fully initialized. */
937         env = cl_env_nested_get(&nest);
938         io  = &osc_env_info(env)->oti_io;
939         io->ci_obj = cl_object_top(osc2cl(obj));
940         rc = cl_io_init(env, io, CIT_MISC, io->ci_obj);
941         if (rc < 0)
942                 GOTO(out, rc);
943
944         /* discard all pages with index greater then trunc_index */
945         cfs_list_for_each_entry_safe(oap, tmp, &ext->oe_pages,
946                                      oap_pending_item) {
947                 struct cl_page  *sub  = oap2cl_page(oap);
948                 struct cl_page  *page = cl_page_top(sub);
949
950                 LASSERT(cfs_list_empty(&oap->oap_rpc_item));
951
952                 /* only discard the pages with their index greater than
953                  * trunc_index, and ... */
954                 if (sub->cp_index < trunc_index ||
955                     (sub->cp_index == trunc_index && partial)) {
956                         /* accounting how many pages remaining in the chunk
957                          * so that we can calculate grants correctly. */
958                         if (sub->cp_index >> ppc_bits == trunc_chunk)
959                                 ++pages_in_chunk;
960                         continue;
961                 }
962
963                 cfs_list_del_init(&oap->oap_pending_item);
964
965                 cl_page_get(page);
966                 lu_ref_add(&page->cp_reference, "truncate", cfs_current());
967
968                 if (cl_page_own(env, io, page) == 0) {
969                         cl_page_unmap(env, io, page);
970                         cl_page_discard(env, io, page);
971                         cl_page_disown(env, io, page);
972                 } else {
973                         LASSERT(page->cp_state == CPS_FREEING);
974                         LASSERT(0);
975                 }
976
977                 lu_ref_del(&page->cp_reference, "truncate", cfs_current());
978                 cl_page_put(env, page);
979
980                 --ext->oe_nr_pages;
981                 ++nr_pages;
982         }
983         EASSERTF(ergo(ext->oe_start >= trunc_index + !!partial,
984                       ext->oe_nr_pages == 0),
985                 ext, "trunc_index %lu, partial %d\n", trunc_index, partial);
986
987         osc_object_lock(obj);
988         if (ext->oe_nr_pages == 0) {
989                 LASSERT(pages_in_chunk == 0);
990                 grants = ext->oe_grants;
991                 ext->oe_grants = 0;
992         } else { /* calculate how many grants we can free */
993                 int     chunks = (ext->oe_end >> ppc_bits) - trunc_chunk;
994                 pgoff_t last_index;
995
996
997                 /* if there is no pages in this chunk, we can also free grants
998                  * for the last chunk */
999                 if (pages_in_chunk == 0) {
1000                         /* if this is the 1st chunk and no pages in this chunk,
1001                          * ext->oe_nr_pages must be zero, so we should be in
1002                          * the other if-clause. */
1003                         LASSERT(trunc_chunk > 0);
1004                         --trunc_chunk;
1005                         ++chunks;
1006                 }
1007
1008                 /* this is what we can free from this extent */
1009                 grants          = chunks << cli->cl_chunkbits;
1010                 ext->oe_grants -= grants;
1011                 last_index      = ((trunc_chunk + 1) << ppc_bits) - 1;
1012                 ext->oe_end     = min(last_index, ext->oe_max_end);
1013                 LASSERT(ext->oe_end >= ext->oe_start);
1014                 LASSERT(ext->oe_grants > 0);
1015         }
1016         osc_object_unlock(obj);
1017
1018         if (grants > 0 || nr_pages > 0)
1019                 osc_free_grant(cli, nr_pages, grants);
1020
1021 out:
1022         cl_io_fini(env, io);
1023         cl_env_nested_put(&nest, env);
1024         RETURN(rc);
1025 }
1026
1027 /**
1028  * This function is used to make the extent prepared for transfer.
1029  * A race with flusing page - ll_writepage() has to be handled cautiously.
1030  */
1031 static int osc_extent_make_ready(const struct lu_env *env,
1032                                  struct osc_extent *ext)
1033 {
1034         struct osc_async_page *oap;
1035         struct osc_async_page *last = NULL;
1036         struct osc_object *obj = ext->oe_obj;
1037         int page_count = 0;
1038         int rc;
1039         ENTRY;
1040
1041         /* we're going to grab page lock, so object lock must not be taken. */
1042         LASSERT(sanity_check(ext) == 0);
1043         /* in locking state, any process should not touch this extent. */
1044         EASSERT(ext->oe_state == OES_LOCKING, ext);
1045         EASSERT(ext->oe_owner != NULL, ext);
1046
1047         OSC_EXTENT_DUMP(D_CACHE, ext, "make ready\n");
1048
1049         cfs_list_for_each_entry(oap, &ext->oe_pages, oap_pending_item) {
1050                 ++page_count;
1051                 if (last == NULL || last->oap_obj_off < oap->oap_obj_off)
1052                         last = oap;
1053
1054                 /* checking ASYNC_READY is race safe */
1055                 if ((oap->oap_async_flags & ASYNC_READY) != 0)
1056                         continue;
1057
1058                 rc = osc_make_ready(env, oap, OBD_BRW_WRITE);
1059                 switch (rc) {
1060                 case 0:
1061                         spin_lock(&oap->oap_lock);
1062                         oap->oap_async_flags |= ASYNC_READY;
1063                         spin_unlock(&oap->oap_lock);
1064                         break;
1065                 case -EALREADY:
1066                         LASSERT((oap->oap_async_flags & ASYNC_READY) != 0);
1067                         break;
1068                 default:
1069                         LASSERTF(0, "unknown return code: %d\n", rc);
1070                 }
1071         }
1072
1073         LASSERT(page_count == ext->oe_nr_pages);
1074         LASSERT(last != NULL);
1075         /* the last page is the only one we need to refresh its count by
1076          * the size of file. */
1077         if (!(last->oap_async_flags & ASYNC_COUNT_STABLE)) {
1078                 last->oap_count = osc_refresh_count(env, last, OBD_BRW_WRITE);
1079                 LASSERT(last->oap_count > 0);
1080                 LASSERT(last->oap_page_off + last->oap_count <= CFS_PAGE_SIZE);
1081                 last->oap_async_flags |= ASYNC_COUNT_STABLE;
1082         }
1083
1084         /* for the rest of pages, we don't need to call osf_refresh_count()
1085          * because it's known they are not the last page */
1086         cfs_list_for_each_entry(oap, &ext->oe_pages, oap_pending_item) {
1087                 if (!(oap->oap_async_flags & ASYNC_COUNT_STABLE)) {
1088                         oap->oap_count = CFS_PAGE_SIZE - oap->oap_page_off;
1089                         oap->oap_async_flags |= ASYNC_COUNT_STABLE;
1090                 }
1091         }
1092
1093         osc_object_lock(obj);
1094         osc_extent_state_set(ext, OES_RPC);
1095         osc_object_unlock(obj);
1096         /* get a refcount for RPC. */
1097         osc_extent_get(ext);
1098
1099         RETURN(0);
1100 }
1101
1102 /**
1103  * Quick and simple version of osc_extent_find(). This function is frequently
1104  * called to expand the extent for the same IO. To expand the extent, the
1105  * page index must be in the same or next chunk of ext->oe_end.
1106  */
1107 static int osc_extent_expand(struct osc_extent *ext, pgoff_t index, int *grants)
1108 {
1109         struct osc_object *obj = ext->oe_obj;
1110         struct client_obd *cli = osc_cli(obj);
1111         struct osc_extent *next;
1112         int ppc_bits = cli->cl_chunkbits - CFS_PAGE_SHIFT;
1113         pgoff_t chunk = index >> ppc_bits;
1114         pgoff_t end_chunk;
1115         pgoff_t end_index;
1116         int chunksize = 1 << cli->cl_chunkbits;
1117         int rc = 0;
1118         ENTRY;
1119
1120         LASSERT(ext->oe_max_end >= index && ext->oe_start <= index);
1121         osc_object_lock(obj);
1122         LASSERT(sanity_check_nolock(ext) == 0);
1123         end_chunk = ext->oe_end >> ppc_bits;
1124         if (chunk > end_chunk + 1)
1125                 GOTO(out, rc = -ERANGE);
1126
1127         if (end_chunk >= chunk)
1128                 GOTO(out, rc = 0);
1129
1130         LASSERT(end_chunk + 1 == chunk);
1131         /* try to expand this extent to cover @index */
1132         end_index = min(ext->oe_max_end, ((chunk + 1) << ppc_bits) - 1);
1133
1134         next = next_extent(ext);
1135         if (next != NULL && next->oe_start <= end_index)
1136                 /* complex mode - overlapped with the next extent,
1137                  * this case will be handled by osc_extent_find() */
1138                 GOTO(out, rc = -EAGAIN);
1139
1140         ext->oe_end = end_index;
1141         ext->oe_grants += chunksize;
1142         *grants -= chunksize;
1143         LASSERT(*grants >= 0);
1144         EASSERTF(osc_extent_is_overlapped(obj, ext) == 0, ext,
1145                  "overlapped after expanding for %lu.\n", index);
1146         EXIT;
1147
1148 out:
1149         osc_object_unlock(obj);
1150         RETURN(rc);
1151 }
1152
1153 static void osc_extent_tree_dump0(int level, struct osc_object *obj,
1154                                   const char *func, int line)
1155 {
1156         struct osc_extent *ext;
1157         int cnt;
1158
1159         CDEBUG(level, "Dump object %p extents at %s:%d, mppr: %u.\n",
1160                obj, func, line, osc_cli(obj)->cl_max_pages_per_rpc);
1161
1162         /* osc_object_lock(obj); */
1163         cnt = 1;
1164         for (ext = first_extent(obj); ext != NULL; ext = next_extent(ext))
1165                 OSC_EXTENT_DUMP(level, ext, "in tree %d.\n", cnt++);
1166
1167         cnt = 1;
1168         cfs_list_for_each_entry(ext, &obj->oo_hp_exts, oe_link)
1169                 OSC_EXTENT_DUMP(level, ext, "hp %d.\n", cnt++);
1170
1171         cnt = 1;
1172         cfs_list_for_each_entry(ext, &obj->oo_urgent_exts, oe_link)
1173                 OSC_EXTENT_DUMP(level, ext, "urgent %d.\n", cnt++);
1174
1175         cnt = 1;
1176         cfs_list_for_each_entry(ext, &obj->oo_reading_exts, oe_link)
1177                 OSC_EXTENT_DUMP(level, ext, "reading %d.\n", cnt++);
1178         /* osc_object_unlock(obj); */
1179 }
1180
1181 /* ------------------ osc extent end ------------------ */
1182
1183 static inline int osc_is_ready(struct osc_object *osc)
1184 {
1185         return !cfs_list_empty(&osc->oo_ready_item) ||
1186                !cfs_list_empty(&osc->oo_hp_ready_item);
1187 }
1188
1189 #define OSC_IO_DEBUG(OSC, STR, args...)                                        \
1190         CDEBUG(D_CACHE, "obj %p ready %d|%c|%c wr %d|%c|%c rd %d|%c " STR,     \
1191                (OSC), osc_is_ready(OSC),                                       \
1192                list_empty_marker(&(OSC)->oo_hp_ready_item),                    \
1193                list_empty_marker(&(OSC)->oo_ready_item),                       \
1194                cfs_atomic_read(&(OSC)->oo_nr_writes),                          \
1195                list_empty_marker(&(OSC)->oo_hp_exts),                          \
1196                list_empty_marker(&(OSC)->oo_urgent_exts),                      \
1197                cfs_atomic_read(&(OSC)->oo_nr_reads),                           \
1198                list_empty_marker(&(OSC)->oo_reading_exts),                     \
1199                ##args)
1200
1201 static int osc_make_ready(const struct lu_env *env, struct osc_async_page *oap,
1202                           int cmd)
1203 {
1204         struct osc_page *opg  = oap2osc_page(oap);
1205         struct cl_page  *page = cl_page_top(oap2cl_page(oap));
1206         int result;
1207
1208         LASSERT(cmd == OBD_BRW_WRITE); /* no cached reads */
1209
1210         ENTRY;
1211         result = cl_page_make_ready(env, page, CRT_WRITE);
1212         if (result == 0)
1213                 opg->ops_submit_time = cfs_time_current();
1214         RETURN(result);
1215 }
1216
1217 static int osc_refresh_count(const struct lu_env *env,
1218                              struct osc_async_page *oap, int cmd)
1219 {
1220         struct osc_page  *opg = oap2osc_page(oap);
1221         struct cl_page   *page = oap2cl_page(oap);
1222         struct cl_object *obj;
1223         struct cl_attr   *attr = &osc_env_info(env)->oti_attr;
1224
1225         int result;
1226         loff_t kms;
1227
1228         /* readpage queues with _COUNT_STABLE, shouldn't get here. */
1229         LASSERT(!(cmd & OBD_BRW_READ));
1230         LASSERT(opg != NULL);
1231         obj = opg->ops_cl.cpl_obj;
1232
1233         cl_object_attr_lock(obj);
1234         result = cl_object_attr_get(env, obj, attr);
1235         cl_object_attr_unlock(obj);
1236         if (result < 0)
1237                 return result;
1238         kms = attr->cat_kms;
1239         if (cl_offset(obj, page->cp_index) >= kms)
1240                 /* catch race with truncate */
1241                 return 0;
1242         else if (cl_offset(obj, page->cp_index + 1) > kms)
1243                 /* catch sub-page write at end of file */
1244                 return kms % CFS_PAGE_SIZE;
1245         else
1246                 return CFS_PAGE_SIZE;
1247 }
1248
1249 static int osc_completion(const struct lu_env *env, struct osc_async_page *oap,
1250                           int cmd, int rc)
1251 {
1252         struct osc_page   *opg  = oap2osc_page(oap);
1253         struct cl_page    *page = cl_page_top(oap2cl_page(oap));
1254         struct osc_object *obj  = cl2osc(opg->ops_cl.cpl_obj);
1255         enum cl_req_type   crt;
1256         int srvlock;
1257
1258         ENTRY;
1259
1260         cmd &= ~OBD_BRW_NOQUOTA;
1261         LASSERT(equi(page->cp_state == CPS_PAGEIN,  cmd == OBD_BRW_READ));
1262         LASSERT(equi(page->cp_state == CPS_PAGEOUT, cmd == OBD_BRW_WRITE));
1263         LASSERT(opg->ops_transfer_pinned);
1264
1265         /*
1266          * page->cp_req can be NULL if io submission failed before
1267          * cl_req was allocated.
1268          */
1269         if (page->cp_req != NULL)
1270                 cl_req_page_done(env, page);
1271         LASSERT(page->cp_req == NULL);
1272
1273         crt = cmd == OBD_BRW_READ ? CRT_READ : CRT_WRITE;
1274         /* Clear opg->ops_transfer_pinned before VM lock is released. */
1275         opg->ops_transfer_pinned = 0;
1276
1277         spin_lock(&obj->oo_seatbelt);
1278         LASSERT(opg->ops_submitter != NULL);
1279         LASSERT(!cfs_list_empty(&opg->ops_inflight));
1280         cfs_list_del_init(&opg->ops_inflight);
1281         opg->ops_submitter = NULL;
1282         spin_unlock(&obj->oo_seatbelt);
1283
1284         opg->ops_submit_time = 0;
1285         srvlock = oap->oap_brw_flags & OBD_BRW_SRVLOCK;
1286
1287         /* statistic */
1288         if (rc == 0 && srvlock) {
1289                 struct lu_device *ld    = opg->ops_cl.cpl_obj->co_lu.lo_dev;
1290                 struct osc_stats *stats = &lu2osc_dev(ld)->od_stats;
1291                 int bytes = oap->oap_count;
1292
1293                 if (crt == CRT_READ)
1294                         stats->os_lockless_reads += bytes;
1295                 else
1296                         stats->os_lockless_writes += bytes;
1297         }
1298
1299         /*
1300          * This has to be the last operation with the page, as locks are
1301          * released in cl_page_completion() and nothing except for the
1302          * reference counter protects page from concurrent reclaim.
1303          */
1304         lu_ref_del(&page->cp_reference, "transfer", page);
1305
1306         cl_page_completion(env, page, crt, rc);
1307
1308         RETURN(0);
1309 }
1310
1311 #define OSC_DUMP_GRANT(cli, fmt, args...) do {                                \
1312         struct client_obd *__tmp = (cli);                                     \
1313         CDEBUG(D_CACHE, "%s: { dirty: %ld/%ld dirty_pages: %d/%d "            \
1314                "dropped: %ld avail: %ld, reserved: %ld, flight: %d } " fmt,   \
1315                __tmp->cl_import->imp_obd->obd_name,                           \
1316                __tmp->cl_dirty, __tmp->cl_dirty_max,                          \
1317                cfs_atomic_read(&obd_dirty_pages), obd_max_dirty_pages,        \
1318                __tmp->cl_lost_grant, __tmp->cl_avail_grant,                   \
1319                __tmp->cl_reserved_grant, __tmp->cl_w_in_flight, ##args);      \
1320 } while (0)
1321
1322 /* caller must hold loi_list_lock */
1323 static void osc_consume_write_grant(struct client_obd *cli,
1324                                     struct brw_page *pga)
1325 {
1326         LASSERT_SPIN_LOCKED(&cli->cl_loi_list_lock.lock);
1327         LASSERT(!(pga->flag & OBD_BRW_FROM_GRANT));
1328         cfs_atomic_inc(&obd_dirty_pages);
1329         cli->cl_dirty += CFS_PAGE_SIZE;
1330         pga->flag |= OBD_BRW_FROM_GRANT;
1331         CDEBUG(D_CACHE, "using %lu grant credits for brw %p page %p\n",
1332                CFS_PAGE_SIZE, pga, pga->pg);
1333         osc_update_next_shrink(cli);
1334 }
1335
1336 /* the companion to osc_consume_write_grant, called when a brw has completed.
1337  * must be called with the loi lock held. */
1338 static void osc_release_write_grant(struct client_obd *cli,
1339                                     struct brw_page *pga)
1340 {
1341         ENTRY;
1342
1343         LASSERT_SPIN_LOCKED(&cli->cl_loi_list_lock.lock);
1344         if (!(pga->flag & OBD_BRW_FROM_GRANT)) {
1345                 EXIT;
1346                 return;
1347         }
1348
1349         pga->flag &= ~OBD_BRW_FROM_GRANT;
1350         cfs_atomic_dec(&obd_dirty_pages);
1351         cli->cl_dirty -= CFS_PAGE_SIZE;
1352         if (pga->flag & OBD_BRW_NOCACHE) {
1353                 pga->flag &= ~OBD_BRW_NOCACHE;
1354                 cfs_atomic_dec(&obd_dirty_transit_pages);
1355                 cli->cl_dirty_transit -= CFS_PAGE_SIZE;
1356         }
1357         EXIT;
1358 }
1359
1360 /**
1361  * To avoid sleeping with object lock held, it's good for us allocate enough
1362  * grants before entering into critical section.
1363  *
1364  * client_obd_list_lock held by caller
1365  */
1366 static int osc_reserve_grant(struct client_obd *cli, unsigned int bytes)
1367 {
1368         int rc = -EDQUOT;
1369
1370         if (cli->cl_avail_grant >= bytes) {
1371                 cli->cl_avail_grant    -= bytes;
1372                 cli->cl_reserved_grant += bytes;
1373                 rc = 0;
1374         }
1375         return rc;
1376 }
1377
1378 static void __osc_unreserve_grant(struct client_obd *cli,
1379                                   unsigned int reserved, unsigned int unused)
1380 {
1381         /* it's quite normal for us to get more grant than reserved.
1382          * Thinking about a case that two extents merged by adding a new
1383          * chunk, we can save one extent tax. If extent tax is greater than
1384          * one chunk, we can save more grant by adding a new chunk */
1385         cli->cl_reserved_grant -= reserved;
1386         if (unused > reserved) {
1387                 cli->cl_avail_grant += reserved;
1388                 cli->cl_lost_grant  += unused - reserved;
1389         } else {
1390                 cli->cl_avail_grant += unused;
1391         }
1392 }
1393
1394 void osc_unreserve_grant(struct client_obd *cli,
1395                          unsigned int reserved, unsigned int unused)
1396 {
1397         client_obd_list_lock(&cli->cl_loi_list_lock);
1398         __osc_unreserve_grant(cli, reserved, unused);
1399         if (unused > 0)
1400                 osc_wake_cache_waiters(cli);
1401         client_obd_list_unlock(&cli->cl_loi_list_lock);
1402 }
1403
1404 /**
1405  * Free grant after IO is finished or canceled.
1406  *
1407  * @lost_grant is used to remember how many grants we have allocated but not
1408  * used, we should return these grants to OST. There're two cases where grants
1409  * can be lost:
1410  * 1. truncate;
1411  * 2. blocksize at OST is less than CFS_PAGE_SIZE and a partial page was
1412  *    written. In this case OST may use less chunks to serve this partial
1413  *    write. OSTs don't actually know the page size on the client side. so
1414  *    clients have to calculate lost grant by the blocksize on the OST.
1415  *    See filter_grant_check() for details.
1416  */
1417 static void osc_free_grant(struct client_obd *cli, unsigned int nr_pages,
1418                            unsigned int lost_grant)
1419 {
1420         int grant = (1 << cli->cl_chunkbits) + cli->cl_extent_tax;
1421
1422         client_obd_list_lock(&cli->cl_loi_list_lock);
1423         cfs_atomic_sub(nr_pages, &obd_dirty_pages);
1424         cli->cl_dirty -= nr_pages << CFS_PAGE_SHIFT;
1425         cli->cl_lost_grant += lost_grant;
1426         if (cli->cl_avail_grant < grant && cli->cl_lost_grant >= grant) {
1427                 /* borrow some grant from truncate to avoid the case that
1428                  * truncate uses up all avail grant */
1429                 cli->cl_lost_grant -= grant;
1430                 cli->cl_avail_grant += grant;
1431         }
1432         osc_wake_cache_waiters(cli);
1433         client_obd_list_unlock(&cli->cl_loi_list_lock);
1434         CDEBUG(D_CACHE, "lost %u grant: %lu avail: %lu dirty: %lu\n",
1435                lost_grant, cli->cl_lost_grant,
1436                cli->cl_avail_grant, cli->cl_dirty);
1437 }
1438
1439 /**
1440  * The companion to osc_enter_cache(), called when @oap is no longer part of
1441  * the dirty accounting due to error.
1442  */
1443 static void osc_exit_cache(struct client_obd *cli, struct osc_async_page *oap)
1444 {
1445         client_obd_list_lock(&cli->cl_loi_list_lock);
1446         osc_release_write_grant(cli, &oap->oap_brw_page);
1447         client_obd_list_unlock(&cli->cl_loi_list_lock);
1448 }
1449
1450 /**
1451  * Non-blocking version of osc_enter_cache() that consumes grant only when it
1452  * is available.
1453  */
1454 static int osc_enter_cache_try(struct client_obd *cli,
1455                                struct osc_async_page *oap,
1456                                int bytes, int transient)
1457 {
1458         int rc;
1459
1460         OSC_DUMP_GRANT(cli, "need:%d.\n", bytes);
1461
1462         rc = osc_reserve_grant(cli, bytes);
1463         if (rc < 0)
1464                 return 0;
1465
1466         if (cli->cl_dirty + CFS_PAGE_SIZE <= cli->cl_dirty_max &&
1467             cfs_atomic_read(&obd_dirty_pages) + 1 <= obd_max_dirty_pages) {
1468                 osc_consume_write_grant(cli, &oap->oap_brw_page);
1469                 if (transient) {
1470                         cli->cl_dirty_transit += CFS_PAGE_SIZE;
1471                         cfs_atomic_inc(&obd_dirty_transit_pages);
1472                         oap->oap_brw_flags |= OBD_BRW_NOCACHE;
1473                 }
1474                 rc = 1;
1475         } else {
1476                 __osc_unreserve_grant(cli, bytes, bytes);
1477                 rc = 0;
1478         }
1479         return rc;
1480 }
1481
1482 static int ocw_granted(struct client_obd *cli, struct osc_cache_waiter *ocw)
1483 {
1484         int rc;
1485         client_obd_list_lock(&cli->cl_loi_list_lock);
1486         rc = cfs_list_empty(&ocw->ocw_entry);
1487         client_obd_list_unlock(&cli->cl_loi_list_lock);
1488         return rc;
1489 }
1490
1491 /**
1492  * The main entry to reserve dirty page accounting. Usually the grant reserved
1493  * in this function will be freed in bulk in osc_free_grant() unless it fails
1494  * to add osc cache, in that case, it will be freed in osc_exit_cache().
1495  *
1496  * The process will be put into sleep if it's already run out of grant.
1497  */
1498 static int osc_enter_cache(const struct lu_env *env, struct client_obd *cli,
1499                            struct osc_async_page *oap, int bytes)
1500 {
1501         struct osc_object *osc = oap->oap_obj;
1502         struct lov_oinfo  *loi = osc->oo_oinfo;
1503         struct osc_cache_waiter ocw;
1504         struct l_wait_info lwi = LWI_INTR(LWI_ON_SIGNAL_NOOP, NULL);
1505         int rc = -EDQUOT;
1506         ENTRY;
1507
1508         OSC_DUMP_GRANT(cli, "need:%d.\n", bytes);
1509
1510         client_obd_list_lock(&cli->cl_loi_list_lock);
1511
1512         /* force the caller to try sync io.  this can jump the list
1513          * of queued writes and create a discontiguous rpc stream */
1514         if (OBD_FAIL_CHECK(OBD_FAIL_OSC_NO_GRANT) ||
1515             cli->cl_dirty_max < CFS_PAGE_SIZE     ||
1516             cli->cl_ar.ar_force_sync || loi->loi_ar.ar_force_sync)
1517                 GOTO(out, rc = -EDQUOT);
1518
1519         /* Hopefully normal case - cache space and write credits available */
1520         if (osc_enter_cache_try(cli, oap, bytes, 0))
1521                 GOTO(out, rc = 0);
1522
1523         /* We can get here for two reasons: too many dirty pages in cache, or
1524          * run out of grants. In both cases we should write dirty pages out.
1525          * Adding a cache waiter will trigger urgent write-out no matter what
1526          * RPC size will be.
1527          * The exiting condition is no avail grants and no dirty pages caching,
1528          * that really means there is no space on the OST. */
1529         cfs_waitq_init(&ocw.ocw_waitq);
1530         ocw.ocw_oap   = oap;
1531         ocw.ocw_grant = bytes;
1532         while (cli->cl_dirty > 0 || cli->cl_w_in_flight > 0) {
1533                 cfs_list_add_tail(&ocw.ocw_entry, &cli->cl_cache_waiters);
1534                 ocw.ocw_rc = 0;
1535                 client_obd_list_unlock(&cli->cl_loi_list_lock);
1536
1537                 osc_io_unplug_async(env, cli, NULL);
1538
1539                 CDEBUG(D_CACHE, "%s: sleeping for cache space @ %p for %p\n",
1540                        cli->cl_import->imp_obd->obd_name, &ocw, oap);
1541
1542                 rc = l_wait_event(ocw.ocw_waitq, ocw_granted(cli, &ocw), &lwi);
1543
1544                 client_obd_list_lock(&cli->cl_loi_list_lock);
1545
1546                 /* l_wait_event is interrupted by signal */
1547                 if (rc < 0) {
1548                         cfs_list_del_init(&ocw.ocw_entry);
1549                         GOTO(out, rc);
1550                 }
1551
1552                 LASSERT(cfs_list_empty(&ocw.ocw_entry));
1553                 rc = ocw.ocw_rc;
1554
1555                 if (rc != -EDQUOT)
1556                         GOTO(out, rc);
1557                 if (osc_enter_cache_try(cli, oap, bytes, 0))
1558                         GOTO(out, rc = 0);
1559         }
1560         EXIT;
1561 out:
1562         client_obd_list_unlock(&cli->cl_loi_list_lock);
1563         OSC_DUMP_GRANT(cli, "returned %d.\n", rc);
1564         RETURN(rc);
1565 }
1566
1567 /* caller must hold loi_list_lock */
1568 void osc_wake_cache_waiters(struct client_obd *cli)
1569 {
1570         cfs_list_t *l, *tmp;
1571         struct osc_cache_waiter *ocw;
1572
1573         ENTRY;
1574         cfs_list_for_each_safe(l, tmp, &cli->cl_cache_waiters) {
1575                 ocw = cfs_list_entry(l, struct osc_cache_waiter, ocw_entry);
1576                 cfs_list_del_init(&ocw->ocw_entry);
1577
1578                 ocw->ocw_rc = -EDQUOT;
1579                 /* we can't dirty more */
1580                 if ((cli->cl_dirty + CFS_PAGE_SIZE > cli->cl_dirty_max) ||
1581                     (cfs_atomic_read(&obd_dirty_pages) + 1 >
1582                      obd_max_dirty_pages)) {
1583                         CDEBUG(D_CACHE, "no dirty room: dirty: %ld "
1584                                "osc max %ld, sys max %d\n", cli->cl_dirty,
1585                                cli->cl_dirty_max, obd_max_dirty_pages);
1586                         goto wakeup;
1587                 }
1588
1589                 ocw->ocw_rc = 0;
1590                 if (!osc_enter_cache_try(cli, ocw->ocw_oap, ocw->ocw_grant, 0))
1591                         ocw->ocw_rc = -EDQUOT;
1592
1593 wakeup:
1594                 CDEBUG(D_CACHE, "wake up %p for oap %p, avail grant %ld, %d\n",
1595                        ocw, ocw->ocw_oap, cli->cl_avail_grant, ocw->ocw_rc);
1596
1597                 cfs_waitq_signal(&ocw->ocw_waitq);
1598         }
1599
1600         EXIT;
1601 }
1602
1603 static int osc_max_rpc_in_flight(struct client_obd *cli, struct osc_object *osc)
1604 {
1605         int hprpc = !!cfs_list_empty(&osc->oo_hp_exts);
1606         return rpcs_in_flight(cli) >= cli->cl_max_rpcs_in_flight + hprpc;
1607 }
1608
1609 /* This maintains the lists of pending pages to read/write for a given object
1610  * (lop).  This is used by osc_check_rpcs->osc_next_obj() and osc_list_maint()
1611  * to quickly find objects that are ready to send an RPC. */
1612 static int osc_makes_rpc(struct client_obd *cli, struct osc_object *osc,
1613                          int cmd)
1614 {
1615         int invalid_import = 0;
1616         ENTRY;
1617
1618         /* if we have an invalid import we want to drain the queued pages
1619          * by forcing them through rpcs that immediately fail and complete
1620          * the pages.  recovery relies on this to empty the queued pages
1621          * before canceling the locks and evicting down the llite pages */
1622         if ((cli->cl_import == NULL || cli->cl_import->imp_invalid))
1623                 invalid_import = 1;
1624
1625         if (cmd & OBD_BRW_WRITE) {
1626                 if (cfs_atomic_read(&osc->oo_nr_writes) == 0)
1627                         RETURN(0);
1628                 if (invalid_import) {
1629                         CDEBUG(D_CACHE, "invalid import forcing RPC\n");
1630                         RETURN(1);
1631                 }
1632                 if (!cfs_list_empty(&osc->oo_hp_exts)) {
1633                         CDEBUG(D_CACHE, "high prio request forcing RPC\n");
1634                         RETURN(1);
1635                 }
1636                 if (!cfs_list_empty(&osc->oo_urgent_exts)) {
1637                         CDEBUG(D_CACHE, "urgent request forcing RPC\n");
1638                         RETURN(1);
1639                 }
1640                 /* trigger a write rpc stream as long as there are dirtiers
1641                  * waiting for space.  as they're waiting, they're not going to
1642                  * create more pages to coalesce with what's waiting.. */
1643                 if (!cfs_list_empty(&cli->cl_cache_waiters)) {
1644                         CDEBUG(D_CACHE, "cache waiters forcing RPC\n");
1645                         RETURN(1);
1646                 }
1647                 if (cfs_atomic_read(&osc->oo_nr_writes) >=
1648                     cli->cl_max_pages_per_rpc)
1649                         RETURN(1);
1650         } else {
1651                 if (cfs_atomic_read(&osc->oo_nr_reads) == 0)
1652                         RETURN(0);
1653                 if (invalid_import) {
1654                         CDEBUG(D_CACHE, "invalid import forcing RPC\n");
1655                         RETURN(1);
1656                 }
1657                 /* all read are urgent. */
1658                 if (!cfs_list_empty(&osc->oo_reading_exts))
1659                         RETURN(1);
1660         }
1661
1662         RETURN(0);
1663 }
1664
1665 static void osc_update_pending(struct osc_object *obj, int cmd, int delta)
1666 {
1667         struct client_obd *cli = osc_cli(obj);
1668         if (cmd & OBD_BRW_WRITE) {
1669                 cfs_atomic_add(delta, &obj->oo_nr_writes);
1670                 cfs_atomic_add(delta, &cli->cl_pending_w_pages);
1671                 LASSERT(cfs_atomic_read(&obj->oo_nr_writes) >= 0);
1672         } else {
1673                 cfs_atomic_add(delta, &obj->oo_nr_reads);
1674                 cfs_atomic_add(delta, &cli->cl_pending_r_pages);
1675                 LASSERT(cfs_atomic_read(&obj->oo_nr_reads) >= 0);
1676         }
1677         OSC_IO_DEBUG(obj, "update pending cmd %d delta %d.\n", cmd, delta);
1678 }
1679
1680 static int osc_makes_hprpc(struct osc_object *obj)
1681 {
1682         return !cfs_list_empty(&obj->oo_hp_exts);
1683 }
1684
1685 static void on_list(cfs_list_t *item, cfs_list_t *list, int should_be_on)
1686 {
1687         if (cfs_list_empty(item) && should_be_on)
1688                 cfs_list_add_tail(item, list);
1689         else if (!cfs_list_empty(item) && !should_be_on)
1690                 cfs_list_del_init(item);
1691 }
1692
1693 /* maintain the osc's cli list membership invariants so that osc_send_oap_rpc
1694  * can find pages to build into rpcs quickly */
1695 static int __osc_list_maint(struct client_obd *cli, struct osc_object *osc)
1696 {
1697         if (osc_makes_hprpc(osc)) {
1698                 /* HP rpc */
1699                 on_list(&osc->oo_ready_item, &cli->cl_loi_ready_list, 0);
1700                 on_list(&osc->oo_hp_ready_item, &cli->cl_loi_hp_ready_list, 1);
1701         } else {
1702                 on_list(&osc->oo_hp_ready_item, &cli->cl_loi_hp_ready_list, 0);
1703                 on_list(&osc->oo_ready_item, &cli->cl_loi_ready_list,
1704                         osc_makes_rpc(cli, osc, OBD_BRW_WRITE) ||
1705                         osc_makes_rpc(cli, osc, OBD_BRW_READ));
1706         }
1707
1708         on_list(&osc->oo_write_item, &cli->cl_loi_write_list,
1709                 cfs_atomic_read(&osc->oo_nr_writes) > 0);
1710
1711         on_list(&osc->oo_read_item, &cli->cl_loi_read_list,
1712                 cfs_atomic_read(&osc->oo_nr_reads) > 0);
1713
1714         return osc_is_ready(osc);
1715 }
1716
1717 static int osc_list_maint(struct client_obd *cli, struct osc_object *osc)
1718 {
1719         int is_ready;
1720
1721         client_obd_list_lock(&cli->cl_loi_list_lock);
1722         is_ready = __osc_list_maint(cli, osc);
1723         client_obd_list_unlock(&cli->cl_loi_list_lock);
1724
1725         return is_ready;
1726 }
1727
1728 /* this is trying to propogate async writeback errors back up to the
1729  * application.  As an async write fails we record the error code for later if
1730  * the app does an fsync.  As long as errors persist we force future rpcs to be
1731  * sync so that the app can get a sync error and break the cycle of queueing
1732  * pages for which writeback will fail. */
1733 static void osc_process_ar(struct osc_async_rc *ar, __u64 xid,
1734                            int rc)
1735 {
1736         if (rc) {
1737                 if (!ar->ar_rc)
1738                         ar->ar_rc = rc;
1739
1740                 ar->ar_force_sync = 1;
1741                 ar->ar_min_xid = ptlrpc_sample_next_xid();
1742                 return;
1743
1744         }
1745
1746         if (ar->ar_force_sync && (xid >= ar->ar_min_xid))
1747                 ar->ar_force_sync = 0;
1748 }
1749
1750 /* this must be called holding the loi list lock to give coverage to exit_cache,
1751  * async_flag maintenance, and oap_request */
1752 static void osc_ap_completion(const struct lu_env *env, struct client_obd *cli,
1753                               struct osc_async_page *oap, int sent, int rc)
1754 {
1755         struct osc_object *osc = oap->oap_obj;
1756         struct lov_oinfo  *loi = osc->oo_oinfo;
1757         __u64 xid = 0;
1758
1759         ENTRY;
1760         if (oap->oap_request != NULL) {
1761                 xid = ptlrpc_req_xid(oap->oap_request);
1762                 ptlrpc_req_finished(oap->oap_request);
1763                 oap->oap_request = NULL;
1764         }
1765
1766         /* As the transfer for this page is being done, clear the flags */
1767         spin_lock(&oap->oap_lock);
1768         oap->oap_async_flags = 0;
1769         spin_unlock(&oap->oap_lock);
1770         oap->oap_interrupted = 0;
1771
1772         if (oap->oap_cmd & OBD_BRW_WRITE && xid > 0) {
1773                 client_obd_list_lock(&cli->cl_loi_list_lock);
1774                 osc_process_ar(&cli->cl_ar, xid, rc);
1775                 osc_process_ar(&loi->loi_ar, xid, rc);
1776                 client_obd_list_unlock(&cli->cl_loi_list_lock);
1777         }
1778
1779         rc = osc_completion(env, oap, oap->oap_cmd, rc);
1780         if (rc)
1781                 CERROR("completion on oap %p obj %p returns %d.\n",
1782                        oap, osc, rc);
1783
1784         EXIT;
1785 }
1786
1787 /**
1788  * Try to add extent to one RPC. We need to think about the following things:
1789  * - # of pages must not be over max_pages_per_rpc
1790  * - extent must be compatible with previous ones
1791  */
1792 static int try_to_add_extent_for_io(struct client_obd *cli,
1793                                     struct osc_extent *ext, cfs_list_t *rpclist,
1794                                     int *pc, unsigned int *max_pages)
1795 {
1796         struct osc_extent *tmp;
1797         ENTRY;
1798
1799         EASSERT((ext->oe_state == OES_CACHE || ext->oe_state == OES_LOCK_DONE),
1800                 ext);
1801
1802         *max_pages = max(ext->oe_mppr, *max_pages);
1803         if (*pc + ext->oe_nr_pages > *max_pages)
1804                 RETURN(0);
1805
1806         cfs_list_for_each_entry(tmp, rpclist, oe_link) {
1807                 EASSERT(tmp->oe_owner == cfs_current(), tmp);
1808 #if 0
1809                 if (overlapped(tmp, ext)) {
1810                         OSC_EXTENT_DUMP(D_ERROR, tmp, "overlapped %p.\n", ext);
1811                         EASSERT(0, ext);
1812                 }
1813 #endif
1814
1815                 if (tmp->oe_srvlock != ext->oe_srvlock ||
1816                     !tmp->oe_grants != !ext->oe_grants)
1817                         RETURN(0);
1818
1819                 /* remove break for strict check */
1820                 break;
1821         }
1822
1823         *pc += ext->oe_nr_pages;
1824         cfs_list_move_tail(&ext->oe_link, rpclist);
1825         ext->oe_owner = cfs_current();
1826         RETURN(1);
1827 }
1828
1829 /**
1830  * In order to prevent multiple ptlrpcd from breaking contiguous extents,
1831  * get_write_extent() takes all appropriate extents in atomic.
1832  *
1833  * The following policy is used to collect extents for IO:
1834  * 1. Add as many HP extents as possible;
1835  * 2. Add the first urgent extent in urgent extent list and take it out of
1836  *    urgent list;
1837  * 3. Add subsequent extents of this urgent extent;
1838  * 4. If urgent list is not empty, goto 2;
1839  * 5. Traverse the extent tree from the 1st extent;
1840  * 6. Above steps exit if there is no space in this RPC.
1841  */
1842 static int get_write_extents(struct osc_object *obj, cfs_list_t *rpclist)
1843 {
1844         struct client_obd *cli = osc_cli(obj);
1845         struct osc_extent *ext;
1846         int page_count = 0;
1847         unsigned int max_pages = cli->cl_max_pages_per_rpc;
1848
1849         LASSERT(osc_object_is_locked(obj));
1850         while (!cfs_list_empty(&obj->oo_hp_exts)) {
1851                 ext = cfs_list_entry(obj->oo_hp_exts.next, struct osc_extent,
1852                                      oe_link);
1853                 LASSERT(ext->oe_state == OES_CACHE);
1854                 if (!try_to_add_extent_for_io(cli, ext, rpclist, &page_count,
1855                                               &max_pages))
1856                         return page_count;
1857                 EASSERT(ext->oe_nr_pages <= max_pages, ext);
1858         }
1859         if (page_count == max_pages)
1860                 return page_count;
1861
1862         while (!cfs_list_empty(&obj->oo_urgent_exts)) {
1863                 ext = cfs_list_entry(obj->oo_urgent_exts.next,
1864                                      struct osc_extent, oe_link);
1865                 if (!try_to_add_extent_for_io(cli, ext, rpclist, &page_count,
1866                                               &max_pages))
1867                         return page_count;
1868
1869                 if (!ext->oe_intree)
1870                         continue;
1871
1872                 while ((ext = next_extent(ext)) != NULL) {
1873                         if ((ext->oe_state != OES_CACHE) ||
1874                             (!cfs_list_empty(&ext->oe_link) &&
1875                              ext->oe_owner != NULL))
1876                                 continue;
1877
1878                         if (!try_to_add_extent_for_io(cli, ext, rpclist,
1879                                                       &page_count, &max_pages))
1880                                 return page_count;
1881                 }
1882         }
1883         if (page_count == max_pages)
1884                 return page_count;
1885
1886         ext = first_extent(obj);
1887         while (ext != NULL) {
1888                 if ((ext->oe_state != OES_CACHE) ||
1889                     /* this extent may be already in current rpclist */
1890                     (!cfs_list_empty(&ext->oe_link) && ext->oe_owner != NULL)) {
1891                         ext = next_extent(ext);
1892                         continue;
1893                 }
1894
1895                 if (!try_to_add_extent_for_io(cli, ext, rpclist, &page_count,
1896                                               &max_pages))
1897                         return page_count;
1898
1899                 ext = next_extent(ext);
1900         }
1901         return page_count;
1902 }
1903
1904 static int
1905 osc_send_write_rpc(const struct lu_env *env, struct client_obd *cli,
1906                    struct osc_object *osc, pdl_policy_t pol)
1907 {
1908         CFS_LIST_HEAD(rpclist);
1909         struct osc_extent *ext;
1910         struct osc_extent *tmp;
1911         struct osc_extent *first = NULL;
1912         obd_count page_count = 0;
1913         int srvlock = 0;
1914         int rc = 0;
1915         ENTRY;
1916
1917         LASSERT(osc_object_is_locked(osc));
1918
1919         page_count = get_write_extents(osc, &rpclist);
1920         LASSERT(equi(page_count == 0, cfs_list_empty(&rpclist)));
1921
1922         if (cfs_list_empty(&rpclist))
1923                 RETURN(0);
1924
1925         osc_update_pending(osc, OBD_BRW_WRITE, -page_count);
1926
1927         cfs_list_for_each_entry(ext, &rpclist, oe_link) {
1928                 LASSERT(ext->oe_state == OES_CACHE ||
1929                         ext->oe_state == OES_LOCK_DONE);
1930                 if (ext->oe_state == OES_CACHE)
1931                         osc_extent_state_set(ext, OES_LOCKING);
1932                 else
1933                         osc_extent_state_set(ext, OES_RPC);
1934         }
1935
1936         /* we're going to grab page lock, so release object lock because
1937          * lock order is page lock -> object lock. */
1938         osc_object_unlock(osc);
1939
1940         cfs_list_for_each_entry_safe(ext, tmp, &rpclist, oe_link) {
1941                 if (ext->oe_state == OES_LOCKING) {
1942                         rc = osc_extent_make_ready(env, ext);
1943                         if (unlikely(rc < 0)) {
1944                                 cfs_list_del_init(&ext->oe_link);
1945                                 osc_extent_finish(env, ext, 0, rc);
1946                                 continue;
1947                         }
1948                 }
1949                 if (first == NULL) {
1950                         first = ext;
1951                         srvlock = ext->oe_srvlock;
1952                 } else {
1953                         LASSERT(srvlock == ext->oe_srvlock);
1954                 }
1955         }
1956
1957         if (!cfs_list_empty(&rpclist)) {
1958                 LASSERT(page_count > 0);
1959                 rc = osc_build_rpc(env, cli, &rpclist, OBD_BRW_WRITE, pol);
1960                 LASSERT(cfs_list_empty(&rpclist));
1961         }
1962
1963         osc_object_lock(osc);
1964         RETURN(rc);
1965 }
1966
1967 /**
1968  * prepare pages for ASYNC io and put pages in send queue.
1969  *
1970  * \param cmd OBD_BRW_* macroses
1971  * \param lop pending pages
1972  *
1973  * \return zero if no page added to send queue.
1974  * \return 1 if pages successfully added to send queue.
1975  * \return negative on errors.
1976  */
1977 static int
1978 osc_send_read_rpc(const struct lu_env *env, struct client_obd *cli,
1979                   struct osc_object *osc, pdl_policy_t pol)
1980 {
1981         struct osc_extent *ext;
1982         struct osc_extent *next;
1983         CFS_LIST_HEAD(rpclist);
1984         int page_count = 0;
1985         unsigned int max_pages = cli->cl_max_pages_per_rpc;
1986         int rc = 0;
1987         ENTRY;
1988
1989         LASSERT(osc_object_is_locked(osc));
1990         cfs_list_for_each_entry_safe(ext, next,
1991                                      &osc->oo_reading_exts, oe_link) {
1992                 EASSERT(ext->oe_state == OES_LOCK_DONE, ext);
1993                 if (!try_to_add_extent_for_io(cli, ext, &rpclist, &page_count,
1994                                               &max_pages))
1995                         break;
1996                 osc_extent_state_set(ext, OES_RPC);
1997                 EASSERT(ext->oe_nr_pages <= max_pages, ext);
1998         }
1999         LASSERT(page_count <= max_pages);
2000
2001         osc_update_pending(osc, OBD_BRW_READ, -page_count);
2002
2003         if (!cfs_list_empty(&rpclist)) {
2004                 osc_object_unlock(osc);
2005
2006                 LASSERT(page_count > 0);
2007                 rc = osc_build_rpc(env, cli, &rpclist, OBD_BRW_READ, pol);
2008                 LASSERT(cfs_list_empty(&rpclist));
2009
2010                 osc_object_lock(osc);
2011         }
2012         RETURN(rc);
2013 }
2014
2015 #define list_to_obj(list, item) ({                                            \
2016         cfs_list_t *__tmp = (list)->next;                                     \
2017         cfs_list_del_init(__tmp);                                             \
2018         cfs_list_entry(__tmp, struct osc_object, oo_##item);                  \
2019 })
2020
2021 /* This is called by osc_check_rpcs() to find which objects have pages that
2022  * we could be sending.  These lists are maintained by osc_makes_rpc(). */
2023 static struct osc_object *osc_next_obj(struct client_obd *cli)
2024 {
2025         ENTRY;
2026
2027         /* First return objects that have blocked locks so that they
2028          * will be flushed quickly and other clients can get the lock,
2029          * then objects which have pages ready to be stuffed into RPCs */
2030         if (!cfs_list_empty(&cli->cl_loi_hp_ready_list))
2031                 RETURN(list_to_obj(&cli->cl_loi_hp_ready_list, hp_ready_item));
2032         if (!cfs_list_empty(&cli->cl_loi_ready_list))
2033                 RETURN(list_to_obj(&cli->cl_loi_ready_list, ready_item));
2034
2035         /* then if we have cache waiters, return all objects with queued
2036          * writes.  This is especially important when many small files
2037          * have filled up the cache and not been fired into rpcs because
2038          * they don't pass the nr_pending/object threshhold */
2039         if (!cfs_list_empty(&cli->cl_cache_waiters) &&
2040             !cfs_list_empty(&cli->cl_loi_write_list))
2041                 RETURN(list_to_obj(&cli->cl_loi_write_list, write_item));
2042
2043         /* then return all queued objects when we have an invalid import
2044          * so that they get flushed */
2045         if (cli->cl_import == NULL || cli->cl_import->imp_invalid) {
2046                 if (!cfs_list_empty(&cli->cl_loi_write_list))
2047                         RETURN(list_to_obj(&cli->cl_loi_write_list,
2048                                            write_item));
2049                 if (!cfs_list_empty(&cli->cl_loi_read_list))
2050                         RETURN(list_to_obj(&cli->cl_loi_read_list,
2051                                            read_item));
2052         }
2053         RETURN(NULL);
2054 }
2055
2056 /* called with the loi list lock held */
2057 static void osc_check_rpcs(const struct lu_env *env, struct client_obd *cli,
2058                            pdl_policy_t pol)
2059 {
2060         struct osc_object *osc;
2061         int rc = 0;
2062         ENTRY;
2063
2064         while ((osc = osc_next_obj(cli)) != NULL) {
2065                 struct cl_object *obj = osc2cl(osc);
2066                 struct lu_ref_link link;
2067
2068                 OSC_IO_DEBUG(osc, "%lu in flight\n", rpcs_in_flight(cli));
2069
2070                 if (osc_max_rpc_in_flight(cli, osc)) {
2071                         __osc_list_maint(cli, osc);
2072                         break;
2073                 }
2074
2075                 cl_object_get(obj);
2076                 client_obd_list_unlock(&cli->cl_loi_list_lock);
2077                 lu_object_ref_add_at(&obj->co_lu, &link, "check",
2078                                      cfs_current());
2079
2080                 /* attempt some read/write balancing by alternating between
2081                  * reads and writes in an object.  The makes_rpc checks here
2082                  * would be redundant if we were getting read/write work items
2083                  * instead of objects.  we don't want send_oap_rpc to drain a
2084                  * partial read pending queue when we're given this object to
2085                  * do io on writes while there are cache waiters */
2086                 osc_object_lock(osc);
2087                 if (osc_makes_rpc(cli, osc, OBD_BRW_WRITE)) {
2088                         rc = osc_send_write_rpc(env, cli, osc, pol);
2089                         if (rc < 0) {
2090                                 CERROR("Write request failed with %d\n", rc);
2091
2092                                 /* osc_send_write_rpc failed, mostly because of
2093                                  * memory pressure.
2094                                  *
2095                                  * It can't break here, because if:
2096                                  *  - a page was submitted by osc_io_submit, so
2097                                  *    page locked;
2098                                  *  - no request in flight
2099                                  *  - no subsequent request
2100                                  * The system will be in live-lock state,
2101                                  * because there is no chance to call
2102                                  * osc_io_unplug() and osc_check_rpcs() any
2103                                  * more. pdflush can't help in this case,
2104                                  * because it might be blocked at grabbing
2105                                  * the page lock as we mentioned.
2106                                  *
2107                                  * Anyway, continue to drain pages. */
2108                                 /* break; */
2109                         }
2110                 }
2111                 if (osc_makes_rpc(cli, osc, OBD_BRW_READ)) {
2112                         rc = osc_send_read_rpc(env, cli, osc, pol);
2113                         if (rc < 0)
2114                                 CERROR("Read request failed with %d\n", rc);
2115                 }
2116                 osc_object_unlock(osc);
2117
2118                 osc_list_maint(cli, osc);
2119                 lu_object_ref_del_at(&obj->co_lu, &link, "check",
2120                                      cfs_current());
2121                 cl_object_put(env, obj);
2122
2123                 client_obd_list_lock(&cli->cl_loi_list_lock);
2124         }
2125 }
2126
2127 static int osc_io_unplug0(const struct lu_env *env, struct client_obd *cli,
2128                           struct osc_object *osc, pdl_policy_t pol, int async)
2129 {
2130         int rc = 0;
2131
2132         if (osc != NULL && osc_list_maint(cli, osc) == 0)
2133                 return 0;
2134
2135         if (!async) {
2136                 /* disable osc_lru_shrink() temporarily to avoid
2137                  * potential stack overrun problem. LU-2859 */
2138                 cfs_atomic_inc(&cli->cl_lru_shrinkers);
2139                 client_obd_list_lock(&cli->cl_loi_list_lock);
2140                 osc_check_rpcs(env, cli, pol);
2141                 client_obd_list_unlock(&cli->cl_loi_list_lock);
2142                 cfs_atomic_dec(&cli->cl_lru_shrinkers);
2143         } else {
2144                 CDEBUG(D_CACHE, "Queue writeback work for client %p.\n", cli);
2145                 LASSERT(cli->cl_writeback_work != NULL);
2146                 rc = ptlrpcd_queue_work(cli->cl_writeback_work);
2147         }
2148         return rc;
2149 }
2150
2151 static int osc_io_unplug_async(const struct lu_env *env,
2152                                 struct client_obd *cli, struct osc_object *osc)
2153 {
2154         /* XXX: policy is no use actually. */
2155         return osc_io_unplug0(env, cli, osc, PDL_POLICY_ROUND, 1);
2156 }
2157
2158 void osc_io_unplug(const struct lu_env *env, struct client_obd *cli,
2159                    struct osc_object *osc, pdl_policy_t pol)
2160 {
2161         (void)osc_io_unplug0(env, cli, osc, pol, 0);
2162 }
2163
2164 int osc_prep_async_page(struct osc_object *osc, struct osc_page *ops,
2165                         cfs_page_t *page, loff_t offset)
2166 {
2167         struct obd_export     *exp = osc_export(osc);
2168         struct osc_async_page *oap = &ops->ops_oap;
2169         ENTRY;
2170
2171         if (!page)
2172                 return cfs_size_round(sizeof(*oap));
2173
2174         oap->oap_magic = OAP_MAGIC;
2175         oap->oap_cli = &exp->exp_obd->u.cli;
2176         oap->oap_obj = osc;
2177
2178         oap->oap_page = page;
2179         oap->oap_obj_off = offset;
2180         LASSERT(!(offset & ~CFS_PAGE_MASK));
2181
2182         if (!client_is_remote(exp) && cfs_capable(CFS_CAP_SYS_RESOURCE))
2183                 oap->oap_brw_flags = OBD_BRW_NOQUOTA;
2184
2185         CFS_INIT_LIST_HEAD(&oap->oap_pending_item);
2186         CFS_INIT_LIST_HEAD(&oap->oap_rpc_item);
2187
2188         spin_lock_init(&oap->oap_lock);
2189         CDEBUG(D_INFO, "oap %p page %p obj off "LPU64"\n",
2190                oap, page, oap->oap_obj_off);
2191         RETURN(0);
2192 }
2193
2194 int osc_queue_async_io(const struct lu_env *env, struct cl_io *io,
2195                        struct osc_page *ops)
2196 {
2197         struct osc_io *oio = osc_env_io(env);
2198         struct osc_extent     *ext = NULL;
2199         struct osc_async_page *oap = &ops->ops_oap;
2200         struct client_obd     *cli = oap->oap_cli;
2201         struct osc_object     *osc = oap->oap_obj;
2202         pgoff_t index;
2203         int    grants = 0;
2204         int    brw_flags = OBD_BRW_ASYNC;
2205         int    cmd = OBD_BRW_WRITE;
2206         int    need_release = 0;
2207         int    rc = 0;
2208         ENTRY;
2209
2210         if (oap->oap_magic != OAP_MAGIC)
2211                 RETURN(-EINVAL);
2212
2213         if (cli->cl_import == NULL || cli->cl_import->imp_invalid)
2214                 RETURN(-EIO);
2215
2216         if (!cfs_list_empty(&oap->oap_pending_item) ||
2217             !cfs_list_empty(&oap->oap_rpc_item))
2218                 RETURN(-EBUSY);
2219
2220         /* Set the OBD_BRW_SRVLOCK before the page is queued. */
2221         brw_flags |= ops->ops_srvlock ? OBD_BRW_SRVLOCK : 0;
2222         if (!client_is_remote(osc_export(osc)) &&
2223             cfs_capable(CFS_CAP_SYS_RESOURCE)) {
2224                 brw_flags |= OBD_BRW_NOQUOTA;
2225                 cmd |= OBD_BRW_NOQUOTA;
2226         }
2227
2228         /* check if the file's owner/group is over quota */
2229         if (!(cmd & OBD_BRW_NOQUOTA)) {
2230                 struct cl_object *obj;
2231                 struct cl_attr   *attr;
2232                 unsigned int qid[MAXQUOTAS];
2233
2234                 obj = cl_object_top(&osc->oo_cl);
2235                 attr = &osc_env_info(env)->oti_attr;
2236
2237                 cl_object_attr_lock(obj);
2238                 rc = cl_object_attr_get(env, obj, attr);
2239                 cl_object_attr_unlock(obj);
2240
2241                 qid[USRQUOTA] = attr->cat_uid;
2242                 qid[GRPQUOTA] = attr->cat_gid;
2243                 if (rc == 0 && osc_quota_chkdq(cli, qid) == NO_QUOTA)
2244                         rc = -EDQUOT;
2245                 if (rc)
2246                         RETURN(rc);
2247         }
2248
2249         oap->oap_cmd = cmd;
2250         oap->oap_page_off = ops->ops_from;
2251         oap->oap_count = ops->ops_to - ops->ops_from;
2252         oap->oap_async_flags = 0;
2253         oap->oap_brw_flags = brw_flags;
2254
2255         OSC_IO_DEBUG(osc, "oap %p page %p added for cmd %d\n",
2256                      oap, oap->oap_page, oap->oap_cmd & OBD_BRW_RWMASK);
2257
2258         index = oap2cl_page(oap)->cp_index;
2259
2260         /* Add this page into extent by the following steps:
2261          * 1. if there exists an active extent for this IO, mostly this page
2262          *    can be added to the active extent and sometimes we need to
2263          *    expand extent to accomodate this page;
2264          * 2. otherwise, a new extent will be allocated. */
2265
2266         ext = oio->oi_active;
2267         if (ext != NULL && ext->oe_start <= index && ext->oe_max_end >= index) {
2268                 /* one chunk plus extent overhead must be enough to write this
2269                  * page */
2270                 grants = (1 << cli->cl_chunkbits) + cli->cl_extent_tax;
2271                 if (ext->oe_end >= index)
2272                         grants = 0;
2273
2274                 /* it doesn't need any grant to dirty this page */
2275                 client_obd_list_lock(&cli->cl_loi_list_lock);
2276                 rc = osc_enter_cache_try(cli, oap, grants, 0);
2277                 client_obd_list_unlock(&cli->cl_loi_list_lock);
2278                 if (rc == 0) { /* try failed */
2279                         grants = 0;
2280                         need_release = 1;
2281                 } else if (ext->oe_end < index) {
2282                         int tmp = grants;
2283                         /* try to expand this extent */
2284                         rc = osc_extent_expand(ext, index, &tmp);
2285                         if (rc < 0) {
2286                                 need_release = 1;
2287                                 /* don't free reserved grant */
2288                         } else {
2289                                 OSC_EXTENT_DUMP(D_CACHE, ext,
2290                                                 "expanded for %lu.\n", index);
2291                                 osc_unreserve_grant(cli, grants, tmp);
2292                                 grants = 0;
2293                         }
2294                 }
2295                 rc = 0;
2296         } else if (ext != NULL) {
2297                 /* index is located outside of active extent */
2298                 need_release = 1;
2299         }
2300         if (need_release) {
2301                 osc_extent_release(env, ext);
2302                 oio->oi_active = NULL;
2303                 ext = NULL;
2304         }
2305
2306         if (ext == NULL) {
2307                 int tmp = (1 << cli->cl_chunkbits) + cli->cl_extent_tax;
2308
2309                 /* try to find new extent to cover this page */
2310                 LASSERT(oio->oi_active == NULL);
2311                 /* we may have allocated grant for this page if we failed
2312                  * to expand the previous active extent. */
2313                 LASSERT(ergo(grants > 0, grants >= tmp));
2314
2315                 rc = 0;
2316                 if (grants == 0) {
2317                         /* we haven't allocated grant for this page. */
2318                         rc = osc_enter_cache(env, cli, oap, tmp);
2319                         if (rc == 0)
2320                                 grants = tmp;
2321                 }
2322
2323                 tmp = grants;
2324                 if (rc == 0) {
2325                         ext = osc_extent_find(env, osc, index, &tmp);
2326                         if (IS_ERR(ext)) {
2327                                 LASSERT(tmp == grants);
2328                                 osc_exit_cache(cli, oap);
2329                                 rc = PTR_ERR(ext);
2330                                 ext = NULL;
2331                         } else {
2332                                 oio->oi_active = ext;
2333                         }
2334                 }
2335                 if (grants > 0)
2336                         osc_unreserve_grant(cli, grants, tmp);
2337         }
2338
2339         LASSERT(ergo(rc == 0, ext != NULL));
2340         if (ext != NULL) {
2341                 EASSERTF(ext->oe_end >= index && ext->oe_start <= index,
2342                          ext, "index = %lu.\n", index);
2343                 LASSERT((oap->oap_brw_flags & OBD_BRW_FROM_GRANT) != 0);
2344
2345                 osc_object_lock(osc);
2346                 if (ext->oe_nr_pages == 0)
2347                         ext->oe_srvlock = ops->ops_srvlock;
2348                 else
2349                         LASSERT(ext->oe_srvlock == ops->ops_srvlock);
2350                 ++ext->oe_nr_pages;
2351                 cfs_list_add_tail(&oap->oap_pending_item, &ext->oe_pages);
2352                 osc_object_unlock(osc);
2353         }
2354         RETURN(rc);
2355 }
2356
2357 int osc_teardown_async_page(const struct lu_env *env,
2358                             struct osc_object *obj, struct osc_page *ops)
2359 {
2360         struct osc_async_page *oap = &ops->ops_oap;
2361         struct osc_extent     *ext = NULL;
2362         int rc = 0;
2363         ENTRY;
2364
2365         LASSERT(oap->oap_magic == OAP_MAGIC);
2366
2367         CDEBUG(D_INFO, "teardown oap %p page %p at index %lu.\n",
2368                oap, ops, oap2cl_page(oap)->cp_index);
2369
2370         osc_object_lock(obj);
2371         if (!cfs_list_empty(&oap->oap_rpc_item)) {
2372                 CDEBUG(D_CACHE, "oap %p is not in cache.\n", oap);
2373                 rc = -EBUSY;
2374         } else if (!cfs_list_empty(&oap->oap_pending_item)) {
2375                 ext = osc_extent_lookup(obj, oap2cl_page(oap)->cp_index);
2376                 /* only truncated pages are allowed to be taken out.
2377                  * See osc_extent_truncate() and osc_cache_truncate_start()
2378                  * for details. */
2379                 if (ext != NULL && ext->oe_state != OES_TRUNC) {
2380                         OSC_EXTENT_DUMP(D_ERROR, ext, "trunc at %lu.\n",
2381                                         oap2cl_page(oap)->cp_index);
2382                         rc = -EBUSY;
2383                 }
2384         }
2385         osc_object_unlock(obj);
2386         if (ext != NULL)
2387                 osc_extent_put(env, ext);
2388         RETURN(rc);
2389 }
2390
2391 /**
2392  * This is called when a page is picked up by kernel to write out.
2393  *
2394  * We should find out the corresponding extent and add the whole extent
2395  * into urgent list. The extent may be being truncated or used, handle it
2396  * carefully.
2397  */
2398 int osc_flush_async_page(const struct lu_env *env, struct cl_io *io,
2399                          struct osc_page *ops)
2400 {
2401         struct osc_extent *ext   = NULL;
2402         struct osc_object *obj   = cl2osc(ops->ops_cl.cpl_obj);
2403         struct cl_page    *cp    = ops->ops_cl.cpl_page;
2404         pgoff_t            index = cp->cp_index;
2405         struct osc_async_page *oap = &ops->ops_oap;
2406         bool unplug = false;
2407         int rc = 0;
2408         ENTRY;
2409
2410         osc_object_lock(obj);
2411         ext = osc_extent_lookup(obj, index);
2412         if (ext == NULL) {
2413                 osc_extent_tree_dump(D_ERROR, obj);
2414                 LASSERTF(0, "page index %lu is NOT covered.\n", index);
2415         }
2416
2417         switch (ext->oe_state) {
2418         case OES_RPC:
2419         case OES_LOCK_DONE:
2420                 CL_PAGE_DEBUG(D_ERROR, env, cl_page_top(cp),
2421                               "flush an in-rpc page?\n");
2422                 LASSERT(0);
2423                 break;
2424         case OES_LOCKING:
2425                 /* If we know this extent is being written out, we should abort
2426                  * so that the writer can make this page ready. Otherwise, there
2427                  * exists a deadlock problem because other process can wait for
2428                  * page writeback bit holding page lock; and meanwhile in
2429                  * vvp_page_make_ready(), we need to grab page lock before
2430                  * really sending the RPC. */
2431         case OES_TRUNC:
2432                 /* race with truncate, page will be redirtied */
2433                 GOTO(out, rc = -EAGAIN);
2434         default:
2435                 break;
2436         }
2437
2438         rc = cl_page_prep(env, io, cl_page_top(cp), CRT_WRITE);
2439         if (rc)
2440                 GOTO(out, rc);
2441
2442         spin_lock(&oap->oap_lock);
2443         oap->oap_async_flags |= ASYNC_READY|ASYNC_URGENT;
2444         spin_unlock(&oap->oap_lock);
2445
2446         if (cfs_memory_pressure_get())
2447                 ext->oe_memalloc = 1;
2448
2449         ext->oe_urgent = 1;
2450         if (ext->oe_state == OES_CACHE) {
2451                 OSC_EXTENT_DUMP(D_CACHE, ext,
2452                                 "flush page %p make it urgent.\n", oap);
2453                 if (cfs_list_empty(&ext->oe_link))
2454                         cfs_list_add_tail(&ext->oe_link, &obj->oo_urgent_exts);
2455                 unplug = true;
2456         }
2457         rc = 0;
2458         EXIT;
2459
2460 out:
2461         osc_object_unlock(obj);
2462         osc_extent_put(env, ext);
2463         if (unplug)
2464                 osc_io_unplug_async(env, osc_cli(obj), obj);
2465         return rc;
2466 }
2467
2468 /**
2469  * this is called when a sync waiter receives an interruption.  Its job is to
2470  * get the caller woken as soon as possible.  If its page hasn't been put in an
2471  * rpc yet it can dequeue immediately.  Otherwise it has to mark the rpc as
2472  * desiring interruption which will forcefully complete the rpc once the rpc
2473  * has timed out.
2474  */
2475 int osc_cancel_async_page(const struct lu_env *env, struct osc_page *ops)
2476 {
2477         struct osc_async_page *oap = &ops->ops_oap;
2478         struct osc_object     *obj = oap->oap_obj;
2479         struct client_obd     *cli = osc_cli(obj);
2480         struct osc_extent     *ext;
2481         struct osc_extent     *found = NULL;
2482         cfs_list_t            *plist;
2483         pgoff_t index = oap2cl_page(oap)->cp_index;
2484         int     rc = -EBUSY;
2485         int     cmd;
2486         ENTRY;
2487
2488         LASSERT(!oap->oap_interrupted);
2489         oap->oap_interrupted = 1;
2490
2491         /* Find out the caching extent */
2492         osc_object_lock(obj);
2493         if (oap->oap_cmd & OBD_BRW_WRITE) {
2494                 plist = &obj->oo_urgent_exts;
2495                 cmd   = OBD_BRW_WRITE;
2496         } else {
2497                 plist = &obj->oo_reading_exts;
2498                 cmd   = OBD_BRW_READ;
2499         }
2500         cfs_list_for_each_entry(ext, plist, oe_link) {
2501                 if (ext->oe_start <= index && ext->oe_end >= index) {
2502                         LASSERT(ext->oe_state == OES_LOCK_DONE);
2503                         /* For OES_LOCK_DONE state extent, it has already held
2504                          * a refcount for RPC. */
2505                         found = osc_extent_get(ext);
2506                         break;
2507                 }
2508         }
2509         if (found != NULL) {
2510                 cfs_list_del_init(&found->oe_link);
2511                 osc_update_pending(obj, cmd, -found->oe_nr_pages);
2512                 osc_object_unlock(obj);
2513
2514                 osc_extent_finish(env, found, 0, -EINTR);
2515                 osc_extent_put(env, found);
2516                 rc = 0;
2517         } else {
2518                 osc_object_unlock(obj);
2519                 /* ok, it's been put in an rpc. only one oap gets a request
2520                  * reference */
2521                 if (oap->oap_request != NULL) {
2522                         ptlrpc_mark_interrupted(oap->oap_request);
2523                         ptlrpcd_wake(oap->oap_request);
2524                         ptlrpc_req_finished(oap->oap_request);
2525                         oap->oap_request = NULL;
2526                 }
2527         }
2528
2529         osc_list_maint(cli, obj);
2530         RETURN(rc);
2531 }
2532
2533 int osc_queue_sync_pages(const struct lu_env *env, struct osc_object *obj,
2534                          cfs_list_t *list, int cmd, int brw_flags)
2535 {
2536         struct client_obd     *cli = osc_cli(obj);
2537         struct osc_extent     *ext;
2538         struct osc_async_page *oap;
2539         int     page_count = 0;
2540         int     mppr       = cli->cl_max_pages_per_rpc;
2541         pgoff_t start      = CL_PAGE_EOF;
2542         pgoff_t end        = 0;
2543         ENTRY;
2544
2545         cfs_list_for_each_entry(oap, list, oap_pending_item) {
2546                 struct cl_page *cp = oap2cl_page(oap);
2547                 if (cp->cp_index > end)
2548                         end = cp->cp_index;
2549                 if (cp->cp_index < start)
2550                         start = cp->cp_index;
2551                 ++page_count;
2552                 mppr <<= (page_count > mppr);
2553         }
2554
2555         ext = osc_extent_alloc(obj);
2556         if (ext == NULL) {
2557                 cfs_list_for_each_entry(oap, list, oap_pending_item) {
2558                         cfs_list_del_init(&oap->oap_pending_item);
2559                         osc_ap_completion(env, cli, oap, 0, -ENOMEM);
2560                 }
2561                 RETURN(-ENOMEM);
2562         }
2563
2564         ext->oe_rw = !!(cmd & OBD_BRW_READ);
2565         ext->oe_urgent = 1;
2566         ext->oe_start = start;
2567         ext->oe_end = ext->oe_max_end = end;
2568         ext->oe_obj = obj;
2569         ext->oe_srvlock = !!(brw_flags & OBD_BRW_SRVLOCK);
2570         ext->oe_nr_pages = page_count;
2571         ext->oe_mppr = mppr;
2572         cfs_list_splice_init(list, &ext->oe_pages);
2573
2574         osc_object_lock(obj);
2575         /* Reuse the initial refcount for RPC, don't drop it */
2576         osc_extent_state_set(ext, OES_LOCK_DONE);
2577         if (cmd & OBD_BRW_WRITE) {
2578                 cfs_list_add_tail(&ext->oe_link, &obj->oo_urgent_exts);
2579                 osc_update_pending(obj, OBD_BRW_WRITE, page_count);
2580         } else {
2581                 cfs_list_add_tail(&ext->oe_link, &obj->oo_reading_exts);
2582                 osc_update_pending(obj, OBD_BRW_READ, page_count);
2583         }
2584         osc_object_unlock(obj);
2585
2586         osc_io_unplug(env, cli, obj, PDL_POLICY_ROUND);
2587         RETURN(0);
2588 }
2589
2590 /**
2591  * Called by osc_io_setattr_start() to freeze and destroy covering extents.
2592  */
2593 int osc_cache_truncate_start(const struct lu_env *env, struct osc_io *oio,
2594                              struct osc_object *obj, __u64 size)
2595 {
2596         struct client_obd *cli = osc_cli(obj);
2597         struct osc_extent *ext;
2598         struct osc_extent *waiting = NULL;
2599         pgoff_t index;
2600         CFS_LIST_HEAD(list);
2601         int result = 0;
2602         bool partial;
2603         ENTRY;
2604
2605         /* pages with index greater or equal to index will be truncated. */
2606         index = cl_index(osc2cl(obj), size);
2607         partial = size > cl_offset(osc2cl(obj), index);
2608
2609 again:
2610         osc_object_lock(obj);
2611         ext = osc_extent_search(obj, index);
2612         if (ext == NULL)
2613                 ext = first_extent(obj);
2614         else if (ext->oe_end < index)
2615                 ext = next_extent(ext);
2616         while (ext != NULL) {
2617                 EASSERT(ext->oe_state != OES_TRUNC, ext);
2618
2619                 if (ext->oe_state > OES_CACHE || ext->oe_urgent) {
2620                         /* if ext is in urgent state, it means there must exist
2621                          * a page already having been flushed by write_page().
2622                          * We have to wait for this extent because we can't
2623                          * truncate that page. */
2624                         LASSERT(!ext->oe_hp);
2625                         OSC_EXTENT_DUMP(D_CACHE, ext,
2626                                         "waiting for busy extent\n");
2627                         waiting = osc_extent_get(ext);
2628                         break;
2629                 }
2630
2631                 OSC_EXTENT_DUMP(D_CACHE, ext, "try to trunc:"LPU64".\n", size);
2632
2633                 osc_extent_get(ext);
2634                 if (ext->oe_state == OES_ACTIVE) {
2635                         /* though we grab inode mutex for write path, but we
2636                          * release it before releasing extent(in osc_io_end()),
2637                          * so there is a race window that an extent is still
2638                          * in OES_ACTIVE when truncate starts. */
2639                         LASSERT(!ext->oe_trunc_pending);
2640                         ext->oe_trunc_pending = 1;
2641                 } else {
2642                         EASSERT(ext->oe_state == OES_CACHE, ext);
2643                         osc_extent_state_set(ext, OES_TRUNC);
2644                         osc_update_pending(obj, OBD_BRW_WRITE,
2645                                            -ext->oe_nr_pages);
2646                 }
2647                 EASSERT(cfs_list_empty(&ext->oe_link), ext);
2648                 cfs_list_add_tail(&ext->oe_link, &list);
2649
2650                 ext = next_extent(ext);
2651         }
2652         osc_object_unlock(obj);
2653
2654         osc_list_maint(cli, obj);
2655
2656         while (!cfs_list_empty(&list)) {
2657                 int rc;
2658
2659                 ext = cfs_list_entry(list.next, struct osc_extent, oe_link);
2660                 cfs_list_del_init(&ext->oe_link);
2661
2662                 /* extent may be in OES_ACTIVE state because inode mutex
2663                  * is released before osc_io_end() in file write case */
2664                 if (ext->oe_state != OES_TRUNC)
2665                         osc_extent_wait(env, ext, OES_TRUNC);
2666
2667                 rc = osc_extent_truncate(ext, index, partial);
2668                 if (rc < 0) {
2669                         if (result == 0)
2670                                 result = rc;
2671
2672                         OSC_EXTENT_DUMP(D_ERROR, ext,
2673                                         "truncate error %d\n", rc);
2674                 } else if (ext->oe_nr_pages == 0) {
2675                         osc_extent_remove(ext);
2676                 } else {
2677                         /* this must be an overlapped extent which means only
2678                          * part of pages in this extent have been truncated.
2679                          */
2680                         EASSERTF(ext->oe_start <= index, ext,
2681                                  "trunc index = %lu/%d.\n", index, partial);
2682                         /* fix index to skip this partially truncated extent */
2683                         index = ext->oe_end + 1;
2684                         partial = false;
2685
2686                         /* we need to hold this extent in OES_TRUNC state so
2687                          * that no writeback will happen. This is to avoid
2688                          * BUG 17397. */
2689                         LASSERT(oio->oi_trunc == NULL);
2690                         oio->oi_trunc = osc_extent_get(ext);
2691                         OSC_EXTENT_DUMP(D_CACHE, ext,
2692                                         "trunc at "LPU64"\n", size);
2693                 }
2694                 osc_extent_put(env, ext);
2695         }
2696         if (waiting != NULL) {
2697                 int rc;
2698
2699                 /* ignore the result of osc_extent_wait the write initiator
2700                  * should take care of it. */
2701                 rc = osc_extent_wait(env, waiting, OES_INV);
2702                 if (rc < 0)
2703                         OSC_EXTENT_DUMP(D_CACHE, waiting, "error: %d.\n", rc);
2704
2705                 osc_extent_put(env, waiting);
2706                 waiting = NULL;
2707                 goto again;
2708         }
2709         RETURN(result);
2710 }
2711
2712 /**
2713  * Called after osc_io_setattr_end to add oio->oi_trunc back to cache.
2714  */
2715 void osc_cache_truncate_end(const struct lu_env *env, struct osc_io *oio,
2716                             struct osc_object *obj)
2717 {
2718         struct osc_extent *ext = oio->oi_trunc;
2719
2720         oio->oi_trunc = NULL;
2721         if (ext != NULL) {
2722                 bool unplug = false;
2723
2724                 EASSERT(ext->oe_nr_pages > 0, ext);
2725                 EASSERT(ext->oe_state == OES_TRUNC, ext);
2726                 EASSERT(!ext->oe_urgent, ext);
2727
2728                 OSC_EXTENT_DUMP(D_CACHE, ext, "trunc -> cache.\n");
2729                 osc_object_lock(obj);
2730                 osc_extent_state_set(ext, OES_CACHE);
2731                 if (ext->oe_fsync_wait && !ext->oe_urgent) {
2732                         ext->oe_urgent = 1;
2733                         cfs_list_move_tail(&ext->oe_link, &obj->oo_urgent_exts);
2734                         unplug = true;
2735                 }
2736                 osc_update_pending(obj, OBD_BRW_WRITE, ext->oe_nr_pages);
2737                 osc_object_unlock(obj);
2738                 osc_extent_put(env, ext);
2739
2740                 if (unplug)
2741                         osc_io_unplug_async(env, osc_cli(obj), obj);
2742         }
2743 }
2744
2745 /**
2746  * Wait for extents in a specific range to be written out.
2747  * The caller must have called osc_cache_writeback_range() to issue IO
2748  * otherwise it will take a long time for this function to finish.
2749  *
2750  * Caller must hold inode_mutex , or cancel exclusive dlm lock so that
2751  * nobody else can dirty this range of file while we're waiting for
2752  * extents to be written.
2753  */
2754 int osc_cache_wait_range(const struct lu_env *env, struct osc_object *obj,
2755                          pgoff_t start, pgoff_t end)
2756 {
2757         struct osc_extent *ext;
2758         pgoff_t index = start;
2759         int     result = 0;
2760         ENTRY;
2761
2762 again:
2763         osc_object_lock(obj);
2764         ext = osc_extent_search(obj, index);
2765         if (ext == NULL)
2766                 ext = first_extent(obj);
2767         else if (ext->oe_end < index)
2768                 ext = next_extent(ext);
2769         while (ext != NULL) {
2770                 int rc;
2771
2772                 if (ext->oe_start > end)
2773                         break;
2774
2775                 if (!ext->oe_fsync_wait) {
2776                         ext = next_extent(ext);
2777                         continue;
2778                 }
2779
2780                 EASSERT(ergo(ext->oe_state == OES_CACHE,
2781                              ext->oe_hp || ext->oe_urgent), ext);
2782                 EASSERT(ergo(ext->oe_state == OES_ACTIVE,
2783                              !ext->oe_hp && ext->oe_urgent), ext);
2784
2785                 index = ext->oe_end + 1;
2786                 osc_extent_get(ext);
2787                 osc_object_unlock(obj);
2788
2789                 rc = osc_extent_wait(env, ext, OES_INV);
2790                 if (result == 0)
2791                         result = rc;
2792                 osc_extent_put(env, ext);
2793                 goto again;
2794         }
2795         osc_object_unlock(obj);
2796
2797         OSC_IO_DEBUG(obj, "sync file range.\n");
2798         RETURN(result);
2799 }
2800
2801 /**
2802  * Called to write out a range of osc object.
2803  *
2804  * @hp     : should be set this is caused by lock cancel;
2805  * @discard: is set if dirty pages should be dropped - file will be deleted or
2806  *         truncated, this implies there is no partially discarding extents.
2807  *
2808  * Return how many pages will be issued, or error code if error occurred.
2809  */
2810 int osc_cache_writeback_range(const struct lu_env *env, struct osc_object *obj,
2811                               pgoff_t start, pgoff_t end, int hp, int discard)
2812 {
2813         struct osc_extent *ext;
2814         CFS_LIST_HEAD(discard_list);
2815         bool unplug = false;
2816         int result = 0;
2817         ENTRY;
2818
2819         osc_object_lock(obj);
2820         ext = osc_extent_search(obj, start);
2821         if (ext == NULL)
2822                 ext = first_extent(obj);
2823         else if (ext->oe_end < start)
2824                 ext = next_extent(ext);
2825         while (ext != NULL) {
2826                 if (ext->oe_start > end)
2827                         break;
2828
2829                 ext->oe_fsync_wait = 1;
2830                 switch (ext->oe_state) {
2831                 case OES_CACHE:
2832                         result += ext->oe_nr_pages;
2833                         if (!discard) {
2834                                 cfs_list_t *list = NULL;
2835                                 if (hp) {
2836                                         EASSERT(!ext->oe_hp, ext);
2837                                         ext->oe_hp = 1;
2838                                         list = &obj->oo_hp_exts;
2839                                 } else if (!ext->oe_urgent) {
2840                                         ext->oe_urgent = 1;
2841                                         list = &obj->oo_urgent_exts;
2842                                 }
2843                                 if (list != NULL)
2844                                         cfs_list_move_tail(&ext->oe_link, list);
2845                                 unplug = true;
2846                         } else {
2847                                 /* the only discarder is lock cancelling, so
2848                                  * [start, end] must contain this extent */
2849                                 EASSERT(ext->oe_start >= start &&
2850                                         ext->oe_max_end <= end, ext);
2851                                 osc_extent_state_set(ext, OES_LOCKING);
2852                                 ext->oe_owner = cfs_current();
2853                                 cfs_list_move_tail(&ext->oe_link,
2854                                                    &discard_list);
2855                                 osc_update_pending(obj, OBD_BRW_WRITE,
2856                                                    -ext->oe_nr_pages);
2857                         }
2858                         break;
2859                 case OES_ACTIVE:
2860                         /* It's pretty bad to wait for ACTIVE extents, because
2861                          * we don't know how long we will wait for it to be
2862                          * flushed since it may be blocked at awaiting more
2863                          * grants. We do this for the correctness of fsync. */
2864                         LASSERT(hp == 0 && discard == 0);
2865                         ext->oe_urgent = 1;
2866                         break;
2867                 case OES_TRUNC:
2868                         /* this extent is being truncated, can't do anything
2869                          * for it now. it will be set to urgent after truncate
2870                          * is finished in osc_cache_truncate_end(). */
2871                 default:
2872                         break;
2873                 }
2874                 ext = next_extent(ext);
2875         }
2876         osc_object_unlock(obj);
2877
2878         LASSERT(ergo(!discard, cfs_list_empty(&discard_list)));
2879         if (!cfs_list_empty(&discard_list)) {
2880                 struct osc_extent *tmp;
2881                 int rc;
2882
2883                 osc_list_maint(osc_cli(obj), obj);
2884                 cfs_list_for_each_entry_safe(ext, tmp, &discard_list, oe_link) {
2885                         cfs_list_del_init(&ext->oe_link);
2886                         EASSERT(ext->oe_state == OES_LOCKING, ext);
2887
2888                         /* Discard caching pages. We don't actually write this
2889                          * extent out but we complete it as if we did. */
2890                         rc = osc_extent_make_ready(env, ext);
2891                         if (unlikely(rc < 0)) {
2892                                 OSC_EXTENT_DUMP(D_ERROR, ext,
2893                                                 "make_ready returned %d\n", rc);
2894                                 if (result >= 0)
2895                                         result = rc;
2896                         }
2897
2898                         /* finish the extent as if the pages were sent */
2899                         osc_extent_finish(env, ext, 0, 0);
2900                 }
2901         }
2902
2903         if (unplug)
2904                 osc_io_unplug(env, osc_cli(obj), obj, PDL_POLICY_ROUND);
2905
2906         if (hp || discard) {
2907                 int rc;
2908                 rc = osc_cache_wait_range(env, obj, start, end);
2909                 if (result >= 0 && rc < 0)
2910                         result = rc;
2911         }
2912
2913         OSC_IO_DEBUG(obj, "cache page out.\n");
2914         RETURN(result);
2915 }
2916
2917 /** @} osc */