4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, Whamcloud, Inc.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * Implementation of cl_page for OSC layer.
38 * Author: Nikita Danilov <nikita.danilov@sun.com>
41 #define DEBUG_SUBSYSTEM S_OSC
43 #include "osc_cl_internal.h"
50 * Comment out osc_page_protected because it may sleep inside the
51 * the client_obd_list_lock.
52 * client_obd_list_lock -> osc_ap_completion -> osc_completion ->
53 * -> osc_page_protected -> osc_page_is_dlocked -> osc_match_base
54 * -> ldlm_lock_match -> sptlrpc_import_check_ctx -> sleep.
57 static int osc_page_is_dlocked(const struct lu_env *env,
58 const struct osc_page *opg,
59 enum cl_lock_mode mode, int pending, int unref)
62 struct osc_object *obj;
63 struct osc_thread_info *info;
64 struct ldlm_res_id *resname;
65 struct lustre_handle *lockh;
66 ldlm_policy_data_t *policy;
72 info = osc_env_info(env);
73 resname = &info->oti_resname;
74 policy = &info->oti_policy;
75 lockh = &info->oti_handle;
76 page = opg->ops_cl.cpl_page;
77 obj = cl2osc(opg->ops_cl.cpl_obj);
79 flags = LDLM_FL_TEST_LOCK | LDLM_FL_BLOCK_GRANTED;
81 flags |= LDLM_FL_CBPENDING;
83 dlmmode = osc_cl_lock2ldlm(mode) | LCK_PW;
84 osc_lock_build_res(env, obj, resname);
85 osc_index2policy(policy, page->cp_obj, page->cp_index, page->cp_index);
86 return osc_match_base(osc_export(obj), resname, LDLM_EXTENT, policy,
87 dlmmode, &flags, NULL, lockh, unref);
91 * Checks an invariant that a page in the cache is covered by a lock, as
94 static int osc_page_protected(const struct lu_env *env,
95 const struct osc_page *opg,
96 enum cl_lock_mode mode, int unref)
98 struct cl_object_header *hdr;
100 struct cl_page *page;
101 struct cl_lock_descr *descr;
104 LINVRNT(!opg->ops_temp);
106 page = opg->ops_cl.cpl_page;
107 if (page->cp_owner != NULL &&
108 cl_io_top(page->cp_owner)->ci_lockreq == CILR_NEVER)
110 * If IO is done without locks (liblustre, or lloop), lock is
115 /* otherwise check for a DLM lock */
116 result = osc_page_is_dlocked(env, opg, mode, 1, unref);
118 /* maybe this page is a part of a lockless io? */
119 hdr = cl_object_header(opg->ops_cl.cpl_obj);
120 descr = &osc_env_info(env)->oti_descr;
121 descr->cld_mode = mode;
122 descr->cld_start = page->cp_index;
123 descr->cld_end = page->cp_index;
124 cfs_spin_lock(&hdr->coh_lock_guard);
125 cfs_list_for_each_entry(scan, &hdr->coh_locks, cll_linkage) {
127 * Lock-less sub-lock has to be either in HELD state
128 * (when io is actively going on), or in CACHED state,
129 * when top-lock is being unlocked:
130 * cl_io_unlock()->cl_unuse()->...->lov_lock_unuse().
132 if ((scan->cll_state == CLS_HELD ||
133 scan->cll_state == CLS_CACHED) &&
134 cl_lock_ext_match(&scan->cll_descr, descr)) {
135 struct osc_lock *olck;
137 olck = osc_lock_at(scan);
138 result = osc_lock_is_lockless(olck);
142 cfs_spin_unlock(&hdr->coh_lock_guard);
147 static int osc_page_protected(const struct lu_env *env,
148 const struct osc_page *opg,
149 enum cl_lock_mode mode, int unref)
155 /*****************************************************************************
160 static void osc_page_fini(const struct lu_env *env,
161 struct cl_page_slice *slice)
163 struct osc_page *opg = cl2osc_page(slice);
164 CDEBUG(D_TRACE, "%p\n", opg);
165 LASSERT(opg->ops_lock == NULL);
166 OBD_SLAB_FREE_PTR(opg, osc_page_kmem);
169 static void osc_page_transfer_get(struct osc_page *opg, const char *label)
171 struct cl_page *page = cl_page_top(opg->ops_cl.cpl_page);
173 LASSERT(!opg->ops_transfer_pinned);
175 lu_ref_add_atomic(&page->cp_reference, label, page);
176 opg->ops_transfer_pinned = 1;
179 static void osc_page_transfer_put(const struct lu_env *env,
180 struct osc_page *opg)
182 struct cl_page *page = cl_page_top(opg->ops_cl.cpl_page);
184 if (opg->ops_transfer_pinned) {
185 lu_ref_del(&page->cp_reference, "transfer", page);
186 opg->ops_transfer_pinned = 0;
187 cl_page_put(env, page);
192 * This is called once for every page when it is submitted for a transfer
193 * either opportunistic (osc_page_cache_add()), or immediate
194 * (osc_page_submit()).
196 static void osc_page_transfer_add(const struct lu_env *env,
197 struct osc_page *opg, enum cl_req_type crt)
199 struct osc_object *obj;
201 obj = cl2osc(opg->ops_cl.cpl_obj);
202 cfs_spin_lock(&obj->oo_seatbelt);
203 cfs_list_add(&opg->ops_inflight, &obj->oo_inflight[crt]);
204 opg->ops_submitter = cfs_current();
205 cfs_spin_unlock(&obj->oo_seatbelt);
208 static int osc_page_cache_add(const struct lu_env *env,
209 const struct cl_page_slice *slice,
210 struct cl_io *unused)
212 struct osc_page *opg = cl2osc_page(slice);
213 struct osc_object *obj = cl2osc(opg->ops_cl.cpl_obj);
215 /* All cacheable IO is async-capable */
216 int brw_flags = OBD_BRW_ASYNC;
219 LINVRNT(osc_page_protected(env, opg, CLM_WRITE, 0));
222 /* Set the OBD_BRW_SRVLOCK before the page is queued. */
223 brw_flags |= opg->ops_srvlock ? OBD_BRW_SRVLOCK : 0;
224 if (!client_is_remote(osc_export(obj)) &&
225 cfs_capable(CFS_CAP_SYS_RESOURCE)) {
226 brw_flags |= OBD_BRW_NOQUOTA;
227 noquota = OBD_BRW_NOQUOTA;
230 osc_page_transfer_get(opg, "transfer\0cache");
231 result = osc_queue_async_io(env, osc_export(obj), NULL, obj->oo_oinfo,
232 &opg->ops_oap, OBD_BRW_WRITE | noquota,
233 opg->ops_from, opg->ops_to - opg->ops_from,
236 osc_page_transfer_put(env, opg);
238 osc_page_transfer_add(env, opg, CRT_WRITE);
242 void osc_index2policy(ldlm_policy_data_t *policy, const struct cl_object *obj,
243 pgoff_t start, pgoff_t end)
245 memset(policy, 0, sizeof *policy);
246 policy->l_extent.start = cl_offset(obj, start);
247 policy->l_extent.end = cl_offset(obj, end + 1) - 1;
250 static int osc_page_addref_lock(const struct lu_env *env,
251 struct osc_page *opg,
252 struct cl_lock *lock)
254 struct osc_lock *olock;
257 LASSERT(opg->ops_lock == NULL);
259 olock = osc_lock_at(lock);
260 if (cfs_atomic_inc_return(&olock->ols_pageref) <= 0) {
261 cfs_atomic_dec(&olock->ols_pageref);
262 cl_lock_put(env, lock);
265 opg->ops_lock = lock;
271 static void osc_page_putref_lock(const struct lu_env *env,
272 struct osc_page *opg)
274 struct cl_lock *lock = opg->ops_lock;
275 struct osc_lock *olock;
277 LASSERT(lock != NULL);
278 olock = osc_lock_at(lock);
280 cfs_atomic_dec(&olock->ols_pageref);
281 opg->ops_lock = NULL;
284 * Note: usually this won't be the last reference of the lock, but if
285 * it is, then all the lock_put do is at most just freeing some memory,
286 * so it would be OK that caller is holding spinlocks.
288 LASSERT(cfs_atomic_read(&lock->cll_ref) > 1 || olock->ols_hold == 0);
289 cl_lock_put(env, lock);
292 static int osc_page_is_under_lock(const struct lu_env *env,
293 const struct cl_page_slice *slice,
294 struct cl_io *unused)
296 struct cl_lock *lock;
300 lock = cl_lock_at_page(env, slice->cpl_obj, slice->cpl_page,
303 osc_page_addref_lock(env, cl2osc_page(slice), lock) == 0)
310 static void osc_page_disown(const struct lu_env *env,
311 const struct cl_page_slice *slice,
314 struct osc_page *opg = cl2osc_page(slice);
316 if (unlikely(opg->ops_lock))
317 osc_page_putref_lock(env, opg);
320 static void osc_page_completion_read(const struct lu_env *env,
321 const struct cl_page_slice *slice,
324 struct osc_page *opg = cl2osc_page(slice);
326 if (likely(opg->ops_lock))
327 osc_page_putref_lock(env, opg);
330 static int osc_page_fail(const struct lu_env *env,
331 const struct cl_page_slice *slice,
332 struct cl_io *unused)
342 static const char *osc_list(cfs_list_t *head)
344 return cfs_list_empty(head) ? "-" : "+";
347 static inline cfs_time_t osc_submit_duration(struct osc_page *opg)
349 if (opg->ops_submit_time == 0)
352 return (cfs_time_current() - opg->ops_submit_time);
355 static int osc_page_print(const struct lu_env *env,
356 const struct cl_page_slice *slice,
357 void *cookie, lu_printer_t printer)
359 struct osc_page *opg = cl2osc_page(slice);
360 struct osc_async_page *oap = &opg->ops_oap;
361 struct osc_object *obj = cl2osc(slice->cpl_obj);
362 struct client_obd *cli = &osc_export(obj)->exp_obd->u.cli;
363 struct lov_oinfo *loi = obj->oo_oinfo;
365 return (*printer)(env, cookie, LUSTRE_OSC_NAME"-page@%p: "
366 "1< %#x %d %u %s %s %s > "
367 "2< "LPU64" %u %u %#x %#x | %p %p %p %p %p > "
368 "3< %s %p %d %lu %d > "
369 "4< %d %d %d %lu %s | %s %s %s %s > "
370 "5< %s %s %s %s | %d %s %s | %d %s %s>\n",
373 oap->oap_magic, oap->oap_cmd,
374 oap->oap_interrupted,
375 osc_list(&oap->oap_pending_item),
376 osc_list(&oap->oap_urgent_item),
377 osc_list(&oap->oap_rpc_item),
379 oap->oap_obj_off, oap->oap_page_off, oap->oap_count,
380 oap->oap_async_flags, oap->oap_brw_flags,
382 oap->oap_cli, oap->oap_loi, oap->oap_caller_ops,
383 oap->oap_caller_data,
385 osc_list(&opg->ops_inflight),
386 opg->ops_submitter, opg->ops_transfer_pinned,
387 osc_submit_duration(opg), opg->ops_srvlock,
389 cli->cl_r_in_flight, cli->cl_w_in_flight,
390 cli->cl_max_rpcs_in_flight,
392 osc_list(&cli->cl_cache_waiters),
393 osc_list(&cli->cl_loi_ready_list),
394 osc_list(&cli->cl_loi_hp_ready_list),
395 osc_list(&cli->cl_loi_write_list),
396 osc_list(&cli->cl_loi_read_list),
398 osc_list(&loi->loi_ready_item),
399 osc_list(&loi->loi_hp_ready_item),
400 osc_list(&loi->loi_write_item),
401 osc_list(&loi->loi_read_item),
402 loi->loi_read_lop.lop_num_pending,
403 osc_list(&loi->loi_read_lop.lop_pending),
404 osc_list(&loi->loi_read_lop.lop_urgent),
405 loi->loi_write_lop.lop_num_pending,
406 osc_list(&loi->loi_write_lop.lop_pending),
407 osc_list(&loi->loi_write_lop.lop_urgent));
410 static void osc_page_delete(const struct lu_env *env,
411 const struct cl_page_slice *slice)
413 struct osc_page *opg = cl2osc_page(slice);
414 struct osc_object *obj = cl2osc(opg->ops_cl.cpl_obj);
415 struct osc_async_page *oap = &opg->ops_oap;
418 LINVRNT(opg->ops_temp || osc_page_protected(env, opg, CLM_READ, 1));
421 CDEBUG(D_TRACE, "%p\n", opg);
422 osc_page_transfer_put(env, opg);
423 rc = osc_teardown_async_page(osc_export(obj), NULL, obj->oo_oinfo, oap);
425 CL_PAGE_DEBUG(D_ERROR, env, cl_page_top(slice->cpl_page),
426 "Trying to teardown failed: %d\n", rc);
429 cfs_spin_lock(&obj->oo_seatbelt);
430 cfs_list_del_init(&opg->ops_inflight);
431 cfs_spin_unlock(&obj->oo_seatbelt);
435 void osc_page_clip(const struct lu_env *env, const struct cl_page_slice *slice,
438 struct osc_page *opg = cl2osc_page(slice);
439 struct osc_async_page *oap = &opg->ops_oap;
441 LINVRNT(osc_page_protected(env, opg, CLM_READ, 0));
443 opg->ops_from = from;
445 cfs_spin_lock(&oap->oap_lock);
446 oap->oap_async_flags |= ASYNC_COUNT_STABLE;
447 cfs_spin_unlock(&oap->oap_lock);
450 static int osc_page_cancel(const struct lu_env *env,
451 const struct cl_page_slice *slice)
453 struct osc_page *opg = cl2osc_page(slice);
454 struct osc_async_page *oap = &opg->ops_oap;
457 LINVRNT(osc_page_protected(env, opg, CLM_READ, 0));
459 client_obd_list_lock(&oap->oap_cli->cl_loi_list_lock);
460 /* Check if the transferring against this page
461 * is completed, or not even queued. */
462 if (opg->ops_transfer_pinned)
463 /* FIXME: may not be interrupted.. */
464 rc = osc_oap_interrupted(env, oap);
465 LASSERT(ergo(rc == 0, opg->ops_transfer_pinned == 0));
466 client_obd_list_unlock(&oap->oap_cli->cl_loi_list_lock);
470 static const struct cl_page_operations osc_page_ops = {
471 .cpo_fini = osc_page_fini,
472 .cpo_print = osc_page_print,
473 .cpo_delete = osc_page_delete,
474 .cpo_is_under_lock = osc_page_is_under_lock,
475 .cpo_disown = osc_page_disown,
478 .cpo_cache_add = osc_page_fail,
479 .cpo_completion = osc_page_completion_read
482 .cpo_cache_add = osc_page_cache_add
485 .cpo_clip = osc_page_clip,
486 .cpo_cancel = osc_page_cancel
489 static int osc_make_ready(const struct lu_env *env, void *data, int cmd)
491 struct osc_page *opg = data;
492 struct cl_page *page = cl_page_top(opg->ops_cl.cpl_page);
495 LASSERT(cmd == OBD_BRW_WRITE); /* no cached reads */
496 LINVRNT(osc_page_protected(env, opg, CLM_WRITE, 1));
499 result = cl_page_make_ready(env, page, CRT_WRITE);
501 opg->ops_submit_time = cfs_time_current();
505 static int osc_refresh_count(const struct lu_env *env, void *data, int cmd)
507 struct cl_page *page;
508 struct osc_page *osc = data;
509 struct cl_object *obj;
510 struct cl_attr *attr = &osc_env_info(env)->oti_attr;
515 LINVRNT(osc_page_protected(env, osc, CLM_READ, 1));
517 /* readpage queues with _COUNT_STABLE, shouldn't get here. */
518 LASSERT(!(cmd & OBD_BRW_READ));
519 LASSERT(osc != NULL);
520 page = osc->ops_cl.cpl_page;
521 obj = osc->ops_cl.cpl_obj;
523 cl_object_attr_lock(obj);
524 result = cl_object_attr_get(env, obj, attr);
525 cl_object_attr_unlock(obj);
529 if (cl_offset(obj, page->cp_index) >= kms)
530 /* catch race with truncate */
532 else if (cl_offset(obj, page->cp_index + 1) > kms)
533 /* catch sub-page write at end of file */
534 return kms % CFS_PAGE_SIZE;
536 return CFS_PAGE_SIZE;
539 static int osc_completion(const struct lu_env *env,
540 void *data, int cmd, struct obdo *oa, int rc)
542 struct osc_page *opg = data;
543 struct osc_async_page *oap = &opg->ops_oap;
544 struct cl_page *page = cl_page_top(opg->ops_cl.cpl_page);
545 struct osc_object *obj = cl2osc(opg->ops_cl.cpl_obj);
546 enum cl_req_type crt;
549 LINVRNT(osc_page_protected(env, opg, CLM_READ, 1));
553 cmd &= ~OBD_BRW_NOQUOTA;
554 LASSERT(equi(page->cp_state == CPS_PAGEIN, cmd == OBD_BRW_READ));
555 LASSERT(equi(page->cp_state == CPS_PAGEOUT, cmd == OBD_BRW_WRITE));
556 LASSERT(opg->ops_transfer_pinned);
559 * page->cp_req can be NULL if io submission failed before
560 * cl_req was allocated.
562 if (page->cp_req != NULL)
563 cl_req_page_done(env, page);
564 LASSERT(page->cp_req == NULL);
566 /* As the transfer for this page is being done, clear the flags */
567 cfs_spin_lock(&oap->oap_lock);
568 oap->oap_async_flags = 0;
569 cfs_spin_unlock(&oap->oap_lock);
571 crt = cmd == OBD_BRW_READ ? CRT_READ : CRT_WRITE;
572 /* Clear opg->ops_transfer_pinned before VM lock is released. */
573 opg->ops_transfer_pinned = 0;
575 cfs_spin_lock(&obj->oo_seatbelt);
576 LASSERT(opg->ops_submitter != NULL);
577 LASSERT(!cfs_list_empty(&opg->ops_inflight));
578 cfs_list_del_init(&opg->ops_inflight);
579 cfs_spin_unlock(&obj->oo_seatbelt);
581 opg->ops_submit_time = 0;
582 srvlock = oap->oap_brw_flags & OBD_BRW_SRVLOCK;
584 cl_page_completion(env, page, crt, rc);
587 if (rc == 0 && srvlock) {
588 struct lu_device *ld = opg->ops_cl.cpl_obj->co_lu.lo_dev;
589 struct osc_stats *stats = &lu2osc_dev(ld)->od_stats;
590 int bytes = oap->oap_count;
593 stats->os_lockless_reads += bytes;
595 stats->os_lockless_writes += bytes;
599 * This has to be the last operation with the page, as locks are
600 * released in cl_page_completion() and nothing except for the
601 * reference counter protects page from concurrent reclaim.
603 lu_ref_del(&page->cp_reference, "transfer", page);
605 * As page->cp_obj is pinned by a reference from page->cp_req, it is
606 * safe to call cl_page_put() without risking object destruction in a
607 * non-blocking context.
609 cl_page_put(env, page);
613 const static struct obd_async_page_ops osc_async_page_ops = {
614 .ap_make_ready = osc_make_ready,
615 .ap_refresh_count = osc_refresh_count,
616 .ap_completion = osc_completion
619 struct cl_page *osc_page_init(const struct lu_env *env,
620 struct cl_object *obj,
621 struct cl_page *page, cfs_page_t *vmpage)
623 struct osc_object *osc = cl2osc(obj);
624 struct osc_page *opg;
627 OBD_SLAB_ALLOC_PTR_GFP(opg, osc_page_kmem, CFS_ALLOC_IO);
629 void *oap = &opg->ops_oap;
632 opg->ops_to = CFS_PAGE_SIZE;
634 result = osc_prep_async_page(osc_export(osc),
635 NULL, osc->oo_oinfo, vmpage,
636 cl_offset(obj, page->cp_index),
638 opg, (void **)&oap, 1, NULL);
640 struct osc_io *oio = osc_env_io(env);
641 opg->ops_srvlock = osc_io_srvlock(oio);
642 cl_page_slice_add(page, &opg->ops_cl, obj,
646 * Cannot assert osc_page_protected() here as read-ahead
647 * creates temporary pages outside of a lock.
649 #ifdef INVARIANT_CHECK
650 opg->ops_temp = !osc_page_protected(env, opg, CLM_READ, 1);
652 CFS_INIT_LIST_HEAD(&opg->ops_inflight);
655 return ERR_PTR(result);
659 * Helper function called by osc_io_submit() for every page in an immediate
660 * transfer (i.e., transferred synchronously).
662 void osc_io_submit_page(const struct lu_env *env,
663 struct osc_io *oio, struct osc_page *opg,
664 enum cl_req_type crt)
666 struct osc_async_page *oap = &opg->ops_oap;
667 struct client_obd *cli = oap->oap_cli;
670 LINVRNT(osc_page_protected(env, opg,
671 crt == CRT_WRITE ? CLM_WRITE : CLM_READ, 1));
673 oap->oap_page_off = opg->ops_from;
674 oap->oap_count = opg->ops_to - opg->ops_from;
675 /* Give a hint to OST that requests are coming from kswapd - bug19529 */
676 if (cfs_memory_pressure_get())
677 oap->oap_brw_flags |= OBD_BRW_MEMALLOC;
678 oap->oap_brw_flags |= OBD_BRW_SYNC;
679 if (osc_io_srvlock(oio))
680 oap->oap_brw_flags |= OBD_BRW_SRVLOCK;
682 oap->oap_cmd = crt == CRT_WRITE ? OBD_BRW_WRITE : OBD_BRW_READ;
683 if (!client_is_remote(osc_export(cl2osc(opg->ops_cl.cpl_obj))) &&
684 cfs_capable(CFS_CAP_SYS_RESOURCE)) {
685 oap->oap_brw_flags |= OBD_BRW_NOQUOTA;
686 oap->oap_cmd |= OBD_BRW_NOQUOTA;
689 if (oap->oap_cmd & OBD_BRW_READ)
690 flags = ASYNC_COUNT_STABLE;
691 else if (!(oap->oap_brw_page.flag & OBD_BRW_FROM_GRANT))
692 osc_enter_cache_try(env, cli, oap->oap_loi, oap, 1);
694 cfs_spin_lock(&oap->oap_lock);
695 oap->oap_async_flags |= OSC_FLAGS | flags;
696 cfs_spin_unlock(&oap->oap_lock);
698 osc_oap_to_pending(oap);
699 osc_page_transfer_get(opg, "transfer\0imm");
700 osc_page_transfer_add(env, opg, crt);