Whamcloud - gitweb
cl_object_glimpse(): do not use loop control variable after the loop has terminated.
[fs/lustre-release.git] / lustre / osc / osc_io.c
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  * GPL HEADER START
5  *
6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 only,
10  * as published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License version 2 for more details (a copy is included
16  * in the LICENSE file that accompanied this code).
17  *
18  * You should have received a copy of the GNU General Public License
19  * version 2 along with this program; If not, see
20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
21  *
22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23  * CA 95054 USA or visit www.sun.com if you need additional information or
24  * have any questions.
25  *
26  * GPL HEADER END
27  */
28 /*
29  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
30  * Use is subject to license terms.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  *
36  * Implementation of cl_io for OSC layer.
37  *
38  *   Author: Nikita Danilov <nikita.danilov@sun.com>
39  */
40
41 /** \addtogroup osc osc @{ */
42
43 #define DEBUG_SUBSYSTEM S_OSC
44
45 #include "osc_cl_internal.h"
46
47 /*****************************************************************************
48  *
49  * Type conversions.
50  *
51  */
52
53 static struct osc_req *cl2osc_req(const struct cl_req_slice *slice)
54 {
55         LINVRNT(slice->crs_dev->cd_lu_dev.ld_type == &osc_device_type);
56         return container_of0(slice, struct osc_req, or_cl);
57 }
58
59 static struct osc_io *cl2osc_io(const struct lu_env *env,
60                                 const struct cl_io_slice *slice)
61 {
62         struct osc_io *oio = container_of0(slice, struct osc_io, oi_cl);
63         LINVRNT(oio == osc_env_io(env));
64         return oio;
65 }
66
67 static struct osc_page *osc_cl_page_osc(struct cl_page *page)
68 {
69         const struct cl_page_slice *slice;
70
71         slice = cl_page_at(page, &osc_device_type);
72         LASSERT(slice != NULL);
73
74         return cl2osc_page(slice);
75 }
76
77
78 /*****************************************************************************
79  *
80  * io operations.
81  *
82  */
83
84 static void osc_io_fini(const struct lu_env *env, const struct cl_io_slice *io)
85 {
86 }
87
88 struct cl_page *osc_oap2cl_page(struct osc_async_page *oap)
89 {
90         return container_of(oap, struct osc_page, ops_oap)->ops_cl.cpl_page;
91 }
92
93 static void osc_io_unplug(const struct lu_env *env, struct osc_object *osc,
94                           struct client_obd *cli)
95 {
96         loi_list_maint(cli, osc->oo_oinfo);
97         osc_check_rpcs(env, cli);
98         client_obd_list_unlock(&cli->cl_loi_list_lock);
99 }
100
101 /**
102  * How many pages osc_io_submit() queues before checking whether an RPC is
103  * ready.
104  */
105 #define OSC_QUEUE_GRAIN (32)
106
107 /**
108  * An implementation of cl_io_operations::cio_io_submit() method for osc
109  * layer. Iterates over pages in the in-queue, prepares each for io by calling
110  * cl_page_prep() and then either submits them through osc_io_submit_page()
111  * or, if page is already submitted, changes osc flags through
112  * osc_set_async_flags_base().
113  */
114 static int osc_io_submit(const struct lu_env *env,
115                          const struct cl_io_slice *ios,
116                          enum cl_req_type crt, struct cl_2queue *queue)
117 {
118         struct cl_page    *page;
119         struct cl_page    *tmp;
120         struct osc_object *osc0 = NULL;
121         struct client_obd *cli  = NULL;
122         struct osc_object *osc  = NULL; /* to keep gcc happy */
123         struct osc_page   *opg;
124         struct cl_io      *io;
125
126         struct cl_page_list *qin      = &queue->c2_qin;
127         struct cl_page_list *qout     = &queue->c2_qout;
128         int queued = 0;
129         int result = 0;
130
131         LASSERT(qin->pl_nr > 0);
132
133         CDEBUG(D_INFO, "%i %i\n", qin->pl_nr, crt);
134         /*
135          * NOTE: here @page is a top-level page. This is done to avoid
136          *       creation of sub-page-list.
137          */
138         cl_page_list_for_each_safe(page, tmp, qin) {
139                 struct osc_async_page *oap;
140                 struct obd_export     *exp;
141
142                 /* Top level IO. */
143                 io = page->cp_owner;
144                 LASSERT(io != NULL);
145
146                 opg = osc_cl_page_osc(page);
147                 oap = &opg->ops_oap;
148                 osc = cl2osc(opg->ops_cl.cpl_obj);
149                 exp = osc_export(osc);
150
151                 /*
152                  * This can be checked without cli->cl_loi_list_lock, because
153                  * ->oap_*_item are always manipulated when the page is owned.
154                  */
155                 if (!list_empty(&oap->oap_urgent_item) ||
156                     !list_empty(&oap->oap_rpc_item)) {
157                         result = -EBUSY;
158                         break;
159                 }
160
161                 if (osc0 == NULL) { /* first iteration */
162                         cli = &exp->exp_obd->u.cli;
163                         osc0 = osc;
164                 } else /* check that all pages are against the same object
165                         * (for now) */
166                         LASSERT(osc == osc0);
167                 if (queued++ == 0)
168                         client_obd_list_lock(&cli->cl_loi_list_lock);
169                 result = cl_page_prep(env, io, page, crt);
170                 if (result == 0) {
171                         cl_page_list_move(qout, qin, page);
172                         if (list_empty(&oap->oap_pending_item)) {
173                                 osc_io_submit_page(env, cl2osc_io(env, ios),
174                                                    opg, crt);
175                         } else {
176                                 result = osc_set_async_flags_base(cli,
177                                                                   osc->oo_oinfo,
178                                                                   oap,
179                                                                   OSC_FLAGS);
180                                 if (result != 0)
181                                         break;
182                         }
183                 } else {
184                         LASSERT(result < 0);
185                         if (result != -EALREADY)
186                                 break;
187                         /*
188                          * Handle -EALREADY error: for read case, the page is
189                          * already in UPTODATE state; for write, the page
190                          * is not dirty.
191                          */
192                         result = 0;
193                 }
194                 /*
195                  * Don't keep client_obd_list_lock() for too long.
196                  *
197                  * XXX lock_need_resched() should be used here, but it is not
198                  * available in the older of supported kernels.
199                  */
200                 if (queued > OSC_QUEUE_GRAIN || cfs_need_resched()) {
201                         queued = 0;
202                         osc_io_unplug(env, osc, cli);
203                         cfs_cond_resched();
204                 }
205         }
206
207         LASSERT(ergo(result == 0, cli != NULL));
208         LASSERT(ergo(result == 0, osc == osc0));
209
210         if (queued > 0)
211                 osc_io_unplug(env, osc, cli);
212         CDEBUG(D_INFO, "%i/%i %i\n", qin->pl_nr, qout->pl_nr, result);
213         return qout->pl_nr > 0 ? 0 : result;
214 }
215
216 static void osc_page_touch_at(const struct lu_env *env,
217                               struct cl_object *obj, pgoff_t idx, unsigned to)
218 {
219         struct lov_oinfo  *loi  = cl2osc(obj)->oo_oinfo;
220         struct cl_attr    *attr = &osc_env_info(env)->oti_attr;
221         int valid;
222         __u64 kms;
223
224         /* offset within stripe */
225         kms = cl_offset(obj, idx) + to;
226
227         cl_object_attr_lock(obj);
228         /*
229          * XXX old code used
230          *
231          *         ll_inode_size_lock(inode, 0); lov_stripe_lock(lsm);
232          *
233          * here
234          */
235         CDEBUG(D_INODE, "stripe KMS %sincreasing "LPU64"->"LPU64" "LPU64"\n",
236                kms > loi->loi_kms ? "" : "not ", loi->loi_kms, kms,
237                loi->loi_lvb.lvb_size);
238
239         valid = 0;
240         if (kms > loi->loi_kms) {
241                 attr->cat_kms = kms;
242                 valid |= CAT_KMS;
243         }
244         if (kms > loi->loi_lvb.lvb_size) {
245                 attr->cat_size = kms;
246                 valid |= CAT_SIZE;
247         }
248         cl_object_attr_set(env, obj, attr, valid);
249         cl_object_attr_unlock(obj);
250 }
251
252 /**
253  * This is called when a page is accessed within file in a way that creates
254  * new page, if one were missing (i.e., if there were a hole at that place in
255  * the file, or accessed page is beyond the current file size). Examples:
256  * ->commit_write() and ->nopage() methods.
257  *
258  * Expand stripe KMS if necessary.
259  */
260 static void osc_page_touch(const struct lu_env *env,
261                            struct osc_page *opage, unsigned to)
262 {
263         struct cl_page    *page = opage->ops_cl.cpl_page;
264         struct cl_object  *obj  = opage->ops_cl.cpl_obj;
265
266         osc_page_touch_at(env, obj, page->cp_index, to);
267 }
268
269 /**
270  * Implements cl_io_operations::cio_prepare_write() method for osc layer.
271  *
272  * \retval -EIO transfer initiated against this osc will most likely fail
273  * \retval 0    transfer initiated against this osc will most likely succeed.
274  *
275  * The reason for this check is to immediately return an error to the caller
276  * in the case of a deactivated import. Note, that import can be deactivated
277  * later, while pages, dirtied by this IO, are still in the cache, but this is
278  * irrelevant, because that would still return an error to the application (if
279  * it does fsync), but many applications don't do fsync because of performance
280  * issues, and we wanted to return an -EIO at write time to notify the
281  * application.
282  */
283 static int osc_io_prepare_write(const struct lu_env *env,
284                                 const struct cl_io_slice *ios,
285                                 const struct cl_page_slice *slice,
286                                 unsigned from, unsigned to)
287 {
288         struct osc_device *dev = lu2osc_dev(slice->cpl_obj->co_lu.lo_dev);
289         struct obd_import *imp = class_exp2cliimp(dev->od_exp);
290
291         ENTRY;
292
293         /*
294          * This implements OBD_BRW_CHECK logic from old client.
295          */
296
297         RETURN(imp == NULL || imp->imp_invalid ? -EIO : 0);
298 }
299
300 static int osc_io_commit_write(const struct lu_env *env,
301                                const struct cl_io_slice *ios,
302                                const struct cl_page_slice *slice,
303                                unsigned from, unsigned to)
304 {
305         LASSERT(to > 0);
306
307         ENTRY;
308         /*
309          * XXX instead of calling osc_page_touch() here and in
310          * osc_io_fault_start() it might be more logical to introduce
311          * cl_page_touch() method, that generic cl_io_commit_write() and page
312          * fault code calls.
313          */
314         osc_page_touch(env, cl2osc_page(slice), to);
315         RETURN(0);
316 }
317
318 static int osc_io_fault_start(const struct lu_env *env,
319                               const struct cl_io_slice *ios)
320 {
321         struct cl_io       *io;
322         struct cl_fault_io *fio;
323
324         ENTRY;
325
326         io  = ios->cis_io;
327         fio = &io->u.ci_fault;
328         CDEBUG(D_INFO, "%lu %i %i\n",
329                fio->ft_index, fio->ft_writable, fio->ft_nob);
330         /*
331          * If mapping is writeable, adjust kms to cover this page,
332          * but do not extend kms beyond actual file size.
333          * See bug 10919.
334          */
335         if (fio->ft_writable)
336                 osc_page_touch_at(env, ios->cis_obj,
337                                   fio->ft_index, fio->ft_nob);
338         RETURN(0);
339 }
340
341 static int osc_punch_upcall(void *a, int rc)
342 {
343         struct osc_punch_cbargs *args = a;
344
345         args->opc_rc = rc;
346         complete(&args->opc_sync);
347         return 0;
348 }
349
350 #ifdef __KERNEL__
351 /**
352  * Checks that there are no pages being written in the extent being truncated.
353  */
354 static void osc_trunc_check(const struct lu_env *env, struct cl_io *io,
355                             struct osc_io *oio, size_t size)
356 {
357         struct osc_page     *cp;
358         struct osc_object   *obj;
359         struct cl_object    *clob;
360         struct cl_page      *page;
361         struct cl_page_list *list;
362         int                  partial;
363         pgoff_t              start;
364
365         clob    = oio->oi_cl.cis_obj;
366         obj     = cl2osc(clob);
367         start   = cl_index(clob, size);
368         partial = cl_offset(clob, start) < size;
369         list    = &osc_env_info(env)->oti_plist;
370
371         /*
372          * Complain if there are pages in the truncated region.
373          *
374          * XXX this is quite expensive check.
375          */
376         cl_page_list_init(list);
377         cl_page_gang_lookup(env, clob, io, start + partial, CL_PAGE_EOF, list);
378
379         cl_page_list_for_each(page, list)
380                 CL_PAGE_DEBUG(D_ERROR, env, page, "exists %lu\n", start);
381
382         cl_page_list_disown(env, io, list);
383         cl_page_list_fini(env, list);
384
385         spin_lock(&obj->oo_seatbelt);
386         list_for_each_entry(cp, &obj->oo_inflight[CRT_WRITE], ops_inflight) {
387                 page = cp->ops_cl.cpl_page;
388                 if (page->cp_index >= start + partial) {
389                         cfs_task_t *submitter;
390
391                         submitter = cp->ops_submitter;
392                         /*
393                          * XXX Linux specific debugging stuff.
394                          */
395                         CL_PAGE_DEBUG(D_ERROR, env, page, "%s/%i %lu\n",
396                                       submitter->comm, submitter->pid, start);
397                         libcfs_debug_dumpstack(submitter);
398                 }
399         }
400         spin_unlock(&obj->oo_seatbelt);
401 }
402 #else /* __KERNEL__ */
403 # define osc_trunc_check(env, io, oio, size) do {;} while (0)
404 #endif
405
406 static int osc_io_trunc_start(const struct lu_env *env,
407                               const struct cl_io_slice *slice)
408 {
409         struct cl_io            *io     = slice->cis_io;
410         struct osc_io           *oio    = cl2osc_io(env, slice);
411         struct cl_object        *obj    = slice->cis_obj;
412         struct lov_oinfo        *loi    = cl2osc(obj)->oo_oinfo;
413         struct cl_attr          *attr   = &osc_env_info(env)->oti_attr;
414         struct obdo             *oa     = &oio->oi_oa;
415         struct osc_punch_cbargs *cbargs = &oio->oi_punch_cbarg;
416         struct obd_capa         *capa;
417         loff_t                   size   = io->u.ci_truncate.tr_size;
418         int                      result;
419
420         memset(oa, 0, sizeof(*oa));
421
422         osc_trunc_check(env, io, oio, size);
423
424         cl_object_attr_lock(obj);
425         result = cl_object_attr_get(env, obj, attr);
426         if (result == 0) {
427                 attr->cat_size = attr->cat_kms = size;
428                 result = cl_object_attr_set(env, obj, attr, CAT_SIZE|CAT_KMS);
429         }
430         cl_object_attr_unlock(obj);
431
432         if (result == 0) {
433                 oa->o_id = loi->loi_id;
434                 oa->o_gr = loi->loi_gr;
435                 oa->o_mtime = attr->cat_mtime;
436                 oa->o_atime = attr->cat_atime;
437                 oa->o_ctime = attr->cat_ctime;
438                 oa->o_valid = OBD_MD_FLID | OBD_MD_FLGROUP | OBD_MD_FLATIME |
439                         OBD_MD_FLCTIME | OBD_MD_FLMTIME;
440                 if (oio->oi_lockless) {
441                         oa->o_flags = OBD_FL_TRUNCLOCK;
442                         oa->o_valid |= OBD_MD_FLFLAGS;
443                 }
444                 oa->o_size = size;
445                 oa->o_blocks = OBD_OBJECT_EOF;
446                 oa->o_valid |= OBD_MD_FLSIZE | OBD_MD_FLBLOCKS;
447
448                 capa = io->u.ci_truncate.tr_capa;
449                 init_completion(&cbargs->opc_sync);
450                 result = osc_punch_base(osc_export(cl2osc(obj)), oa, capa,
451                                         osc_punch_upcall, cbargs, PTLRPCD_SET);
452         }
453         return result;
454 }
455
456 static void osc_io_trunc_end(const struct lu_env *env,
457                              const struct cl_io_slice *slice)
458 {
459         struct cl_io            *io     = slice->cis_io;
460         struct osc_io           *oio    = cl2osc_io(env, slice);
461         struct osc_punch_cbargs *cbargs = &oio->oi_punch_cbarg;
462         struct obdo             *oa     = &oio->oi_oa;
463         int result;
464
465         wait_for_completion(&cbargs->opc_sync);
466
467         result = io->ci_result = cbargs->opc_rc;
468         if (result == 0) {
469                 struct cl_object *obj = slice->cis_obj;
470                 if (oio->oi_lockless == 0) {
471                         struct cl_attr *attr = &osc_env_info(env)->oti_attr;
472                         int valid = 0;
473
474                         /* Update kms & size */
475                         if (oa->o_valid & OBD_MD_FLSIZE) {
476                                 attr->cat_size = oa->o_size;
477                                 attr->cat_kms  = oa->o_size;
478                                 valid |= CAT_KMS|CAT_SIZE;
479                         }
480                         if (oa->o_valid & OBD_MD_FLBLOCKS) {
481                                 attr->cat_blocks = oa->o_blocks;
482                                 valid |= CAT_BLOCKS;
483                         }
484                         if (oa->o_valid & OBD_MD_FLMTIME) {
485                                 attr->cat_mtime = oa->o_mtime;
486                                 valid |= CAT_MTIME;
487                         }
488                         if (oa->o_valid & OBD_MD_FLCTIME) {
489                                 attr->cat_ctime = oa->o_ctime;
490                                 valid |= CAT_CTIME;
491                         }
492                         if (oa->o_valid & OBD_MD_FLATIME) {
493                                 attr->cat_atime = oa->o_atime;
494                                 valid |= CAT_ATIME;
495                         }
496                         cl_object_attr_lock(obj);
497                         result = cl_object_attr_set(env, obj, attr, valid);
498                         cl_object_attr_unlock(obj);
499                 } else {  /* lockless truncate */
500                         struct osc_device *osd = lu2osc_dev(obj->co_lu.lo_dev);
501                         /* XXX: Need a lock. */
502                         osd->od_stats.os_lockless_truncates++;
503                 }
504         }
505
506         /* return result; */
507 }
508
509 static const struct cl_io_operations osc_io_ops = {
510         .op = {
511                 [CIT_READ] = {
512                         .cio_fini   = osc_io_fini
513                 },
514                 [CIT_WRITE] = {
515                         .cio_fini   = osc_io_fini
516                 },
517                 [CIT_TRUNC] = {
518                         .cio_start  = osc_io_trunc_start,
519                         .cio_end    = osc_io_trunc_end
520                 },
521                 [CIT_FAULT] = {
522                         .cio_fini   = osc_io_fini,
523                         .cio_start  = osc_io_fault_start
524                 },
525                 [CIT_MISC] = {
526                         .cio_fini   = osc_io_fini
527                 }
528         },
529         .req_op = {
530                  [CRT_READ] = {
531                          .cio_submit    = osc_io_submit
532                  },
533                  [CRT_WRITE] = {
534                          .cio_submit    = osc_io_submit
535                  }
536          },
537         .cio_prepare_write = osc_io_prepare_write,
538         .cio_commit_write  = osc_io_commit_write
539 };
540
541 /*****************************************************************************
542  *
543  * Transfer operations.
544  *
545  */
546
547 static int osc_req_prep(const struct lu_env *env,
548                         const struct cl_req_slice *slice)
549 {
550         return 0;
551 }
552
553 static void osc_req_completion(const struct lu_env *env,
554                                const struct cl_req_slice *slice, int ioret)
555 {
556         struct osc_req *or;
557
558         or = cl2osc_req(slice);
559         OBD_SLAB_FREE_PTR(or, osc_req_kmem);
560 }
561
562 /**
563  * Implementation of struct cl_req_operations::cro_attr_set() for osc
564  * layer. osc is responsible for struct obdo::o_id and struct obdo::o_gr
565  * fields.
566  */
567 static void osc_req_attr_set(const struct lu_env *env,
568                              const struct cl_req_slice *slice,
569                              const struct cl_object *obj,
570                              struct cl_req_attr *attr, obd_valid flags)
571 {
572         struct lov_oinfo *oinfo;
573         struct cl_req    *clerq;
574         struct cl_page   *apage; /* _some_ page in @clerq */
575         struct cl_lock   *lock;  /* _some_ lock protecting @apage */
576         struct osc_lock  *olck;
577         struct osc_page  *opg;
578         struct obdo      *oa;
579
580         oa = attr->cra_oa;
581         oinfo = cl2osc(obj)->oo_oinfo;
582         if (flags & OBD_MD_FLID) {
583                 oa->o_id = oinfo->loi_id;
584                 oa->o_valid |= OBD_MD_FLID;
585         }
586         if (flags & OBD_MD_FLGROUP) {
587                 oa->o_gr = oinfo->loi_gr;
588                 oa->o_valid |= OBD_MD_FLGROUP;
589         }
590         if (flags & OBD_MD_FLHANDLE) {
591                 clerq = slice->crs_req;
592                 LASSERT(!list_empty(&clerq->crq_pages));
593                 apage = container_of(clerq->crq_pages.next,
594                                      struct cl_page, cp_flight);
595                 opg = osc_cl_page_osc(apage);
596                 apage = opg->ops_cl.cpl_page; /* now apage is a sub-page */
597                 lock = cl_lock_at_page(env, apage->cp_obj, apage, NULL, 1, 1);
598                 if (lock != NULL) {
599                         olck = osc_lock_at(lock);
600                         LASSERT(olck != NULL);
601                         /* check for lockless io. */
602                         if (olck->ols_lock != NULL) {
603                                 oa->o_handle = olck->ols_lock->l_remote_handle;
604                                 oa->o_valid |= OBD_MD_FLHANDLE;
605                         }
606                         cl_lock_put(env, lock);
607                 } else {
608                         /* Should only be possible with liblustre */
609                         LASSERT(LIBLUSTRE_CLIENT);
610                 }
611         }
612 }
613
614 static const struct cl_req_operations osc_req_ops = {
615         .cro_prep       = osc_req_prep,
616         .cro_attr_set   = osc_req_attr_set,
617         .cro_completion = osc_req_completion
618 };
619
620
621 int osc_io_init(const struct lu_env *env,
622                 struct cl_object *obj, struct cl_io *io)
623 {
624         struct osc_io *oio = osc_env_io(env);
625
626         CL_IO_SLICE_CLEAN(oio, oi_cl);
627         cl_io_slice_add(io, &oio->oi_cl, obj, &osc_io_ops);
628         return 0;
629 }
630
631 int osc_req_init(const struct lu_env *env, struct cl_device *dev,
632                  struct cl_req *req)
633 {
634         struct osc_req *or;
635         int result;
636
637         OBD_SLAB_ALLOC_PTR(or, osc_req_kmem);
638         if (or != NULL) {
639                 cl_req_slice_add(req, &or->or_cl, dev, &osc_req_ops);
640                 result = 0;
641         } else
642                 result = -ENOMEM;
643         return result;
644 }
645
646 /** @} osc */