Whamcloud - gitweb
LU-3409 llite: silence lockdep warning in ll_md_blocking_ast
[fs/lustre-release.git] / lustre / osd-ldiskfs / osd_scrub.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,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License version 2 for more details.  A copy is
14  * included in the COPYING file that accompanied this code.
15
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2012, 2013, Intel Corporation.
24  */
25 /*
26  * lustre/osd-ldiskfs/osd_scrub.c
27  *
28  * Top-level entry points into osd module
29  *
30  * The OI scrub is used for rebuilding Object Index files when restores MDT from
31  * file-level backup.
32  *
33  * The otable based iterator scans ldiskfs inode table to feed up layer LFSCK.
34  *
35  * Author: Fan Yong <yong.fan@whamcloud.com>
36  */
37
38 #ifndef EXPORT_SYMTAB
39 # define EXPORT_SYMTAB
40 #endif
41 #define DEBUG_SUBSYSTEM S_MDS
42
43 #include <lustre/lustre_idl.h>
44 #include <lustre_disk.h>
45 #include <dt_object.h>
46
47 #include "osd_internal.h"
48 #include "osd_oi.h"
49 #include "osd_scrub.h"
50
51 #define HALF_SEC        (CFS_HZ >> 1)
52
53 #define OSD_OTABLE_MAX_HASH             0x00000000ffffffffULL
54
55 #define SCRUB_NEXT_BREAK        1 /* exit current loop and process next group */
56 #define SCRUB_NEXT_CONTINUE     2 /* skip current object and process next bit */
57 #define SCRUB_NEXT_EXIT         3 /* exit all the loops */
58 #define SCRUB_NEXT_WAIT         4 /* wait for free cache slot */
59 #define SCRUB_NEXT_CRASH        5 /* simulate system crash during OI scrub */
60 #define SCRUB_NEXT_FATAL        6 /* simulate failure during OI scrub */
61 #define SCRUB_NEXT_NOSCRUB      7 /* new created object, no scrub on it */
62 #define SCRUB_NEXT_NOLMA        8 /* the inode has no FID-in-LMA */
63
64 /* misc functions */
65
66 static inline struct osd_device *osd_scrub2dev(struct osd_scrub *scrub)
67 {
68         return container_of0(scrub, struct osd_device, od_scrub);
69 }
70
71 static inline struct super_block *osd_scrub2sb(struct osd_scrub *scrub)
72 {
73         return osd_sb(osd_scrub2dev(scrub));
74 }
75
76 static inline int osd_scrub_has_window(struct osd_scrub *scrub,
77                                        struct osd_otable_cache *ooc)
78 {
79         return scrub->os_pos_current < ooc->ooc_pos_preload + SCRUB_WINDOW_SIZE;
80 }
81
82 /**
83  * update/insert/delete the specified OI mapping (@fid @id) according to the ops
84  *
85  * \retval   1, changed nothing
86  * \retval   0, changed successfully
87  * \retval -ve, on error
88  */
89 static int osd_scrub_refresh_mapping(struct osd_thread_info *info,
90                                      struct osd_device *dev,
91                                      const struct lu_fid *fid,
92                                      const struct osd_inode_id *id, int ops)
93 {
94         struct lu_fid         *oi_fid = &info->oti_fid2;
95         struct osd_inode_id   *oi_id  = &info->oti_id2;
96         struct iam_container  *bag;
97         struct iam_path_descr *ipd;
98         handle_t              *jh;
99         int                    rc;
100         ENTRY;
101
102         fid_cpu_to_be(oi_fid, fid);
103         osd_id_pack(oi_id, id);
104         jh = ldiskfs_journal_start_sb(osd_sb(dev),
105                                       osd_dto_credits_noquota[ops]);
106         if (IS_ERR(jh)) {
107                 rc = PTR_ERR(jh);
108                 CERROR("%.16s: fail to start trans for scrub store: rc = %d\n",
109                        LDISKFS_SB(osd_sb(dev))->s_es->s_volume_name, rc);
110                 RETURN(rc);
111         }
112
113         bag = &osd_fid2oi(dev, fid)->oi_dir.od_container;
114         ipd = osd_idx_ipd_get(info->oti_env, bag);
115         if (unlikely(ipd == NULL)) {
116                 ldiskfs_journal_stop(jh);
117                 CERROR("%.16s: fail to get ipd for scrub store\n",
118                        LDISKFS_SB(osd_sb(dev))->s_es->s_volume_name);
119                 RETURN(-ENOMEM);
120         }
121
122         switch (ops) {
123         case DTO_INDEX_UPDATE:
124                 rc = iam_update(jh, bag, (const struct iam_key *)oi_fid,
125                                 (struct iam_rec *)oi_id, ipd);
126                 if (unlikely(rc == -ENOENT)) {
127                         /* Some unlink thread may removed the OI mapping. */
128                         rc = 1;
129                 }
130                 break;
131         case DTO_INDEX_INSERT:
132                 rc = iam_insert(jh, bag, (const struct iam_key *)oi_fid,
133                                 (struct iam_rec *)oi_id, ipd);
134                 if (unlikely(rc == -EEXIST)) {
135                         rc = 1;
136                         /* XXX: There are trouble things when adding OI
137                          *      mapping for IGIF object, which may cause
138                          *      multiple objects to be mapped to the same
139                          *      IGIF formatted FID. Consider the following
140                          *      situations:
141                          *
142                          *      1) The MDT is upgrading from 1.8 device.
143                          *      The OI scrub generates IGIF FID1 for the
144                          *      OBJ1 and adds the OI mapping.
145                          *
146                          *      2) For some reason, the OI scrub does not
147                          *      process all the IGIF objects completely.
148                          *
149                          *      3) The MDT is backuped and restored against
150                          *      this device.
151                          *
152                          *      4) When the MDT mounts up, the OI scrub will
153                          *      try to rebuild the OI files. For some IGIF
154                          *      object, OBJ2, which was not processed by the
155                          *      OI scrub before the backup/restore, and the
156                          *      new generated IGIF formatted FID may be just
157                          *      the FID1, the same as OBJ1.
158                          *
159                          *      Under such case, the OI scrub cannot know how
160                          *      to generate new FID for the OBJ2.
161                          *
162                          *      Currently, we do nothing for that. One possible
163                          *      solution is to generate new normal FID for the
164                          *      conflict object.
165                          *
166                          *      Anyway, it is rare, only exists in theory. */
167                 }
168                 break;
169         case DTO_INDEX_DELETE:
170                 rc = iam_delete(jh, bag, (const struct iam_key *)oi_fid, ipd);
171                 if (rc == -ENOENT) {
172                         /* It is normal that the unlink thread has removed the
173                          * OI mapping already. */
174                         rc = 1;
175                 }
176                 break;
177         default:
178                 LASSERTF(0, "Unexpected ops %d\n", ops);
179                 break;
180         }
181         osd_ipd_put(info->oti_env, bag, ipd);
182         ldiskfs_journal_stop(jh);
183         RETURN(rc);
184 }
185
186 /* OI_scrub file ops */
187
188 static void osd_scrub_file_to_cpu(struct scrub_file *des,
189                                   struct scrub_file *src)
190 {
191         memcpy(des->sf_uuid, src->sf_uuid, 16);
192         des->sf_flags   = le64_to_cpu(src->sf_flags);
193         des->sf_magic   = le32_to_cpu(src->sf_magic);
194         des->sf_status  = le16_to_cpu(src->sf_status);
195         des->sf_param   = le16_to_cpu(src->sf_param);
196         des->sf_time_last_complete      =
197                                 le64_to_cpu(src->sf_time_last_complete);
198         des->sf_time_latest_start       =
199                                 le64_to_cpu(src->sf_time_latest_start);
200         des->sf_time_last_checkpoint    =
201                                 le64_to_cpu(src->sf_time_last_checkpoint);
202         des->sf_pos_latest_start        =
203                                 le64_to_cpu(src->sf_pos_latest_start);
204         des->sf_pos_last_checkpoint     =
205                                 le64_to_cpu(src->sf_pos_last_checkpoint);
206         des->sf_pos_first_inconsistent  =
207                                 le64_to_cpu(src->sf_pos_first_inconsistent);
208         des->sf_items_checked           =
209                                 le64_to_cpu(src->sf_items_checked);
210         des->sf_items_updated           =
211                                 le64_to_cpu(src->sf_items_updated);
212         des->sf_items_failed            =
213                                 le64_to_cpu(src->sf_items_failed);
214         des->sf_items_updated_prior     =
215                                 le64_to_cpu(src->sf_items_updated_prior);
216         des->sf_run_time        = le32_to_cpu(src->sf_run_time);
217         des->sf_success_count   = le32_to_cpu(src->sf_success_count);
218         des->sf_oi_count        = le16_to_cpu(src->sf_oi_count);
219         memcpy(des->sf_oi_bitmap, src->sf_oi_bitmap, SCRUB_OI_BITMAP_SIZE);
220 }
221
222 static void osd_scrub_file_to_le(struct scrub_file *des,
223                                  struct scrub_file *src)
224 {
225         memcpy(des->sf_uuid, src->sf_uuid, 16);
226         des->sf_flags   = cpu_to_le64(src->sf_flags);
227         des->sf_magic   = cpu_to_le32(src->sf_magic);
228         des->sf_status  = cpu_to_le16(src->sf_status);
229         des->sf_param   = cpu_to_le16(src->sf_param);
230         des->sf_time_last_complete      =
231                                 cpu_to_le64(src->sf_time_last_complete);
232         des->sf_time_latest_start       =
233                                 cpu_to_le64(src->sf_time_latest_start);
234         des->sf_time_last_checkpoint    =
235                                 cpu_to_le64(src->sf_time_last_checkpoint);
236         des->sf_pos_latest_start        =
237                                 cpu_to_le64(src->sf_pos_latest_start);
238         des->sf_pos_last_checkpoint     =
239                                 cpu_to_le64(src->sf_pos_last_checkpoint);
240         des->sf_pos_first_inconsistent  =
241                                 cpu_to_le64(src->sf_pos_first_inconsistent);
242         des->sf_items_checked           =
243                                 cpu_to_le64(src->sf_items_checked);
244         des->sf_items_updated           =
245                                 cpu_to_le64(src->sf_items_updated);
246         des->sf_items_failed            =
247                                 cpu_to_le64(src->sf_items_failed);
248         des->sf_items_updated_prior     =
249                                 cpu_to_le64(src->sf_items_updated_prior);
250         des->sf_run_time        = cpu_to_le32(src->sf_run_time);
251         des->sf_success_count   = cpu_to_le32(src->sf_success_count);
252         des->sf_oi_count        = cpu_to_le16(src->sf_oi_count);
253         memcpy(des->sf_oi_bitmap, src->sf_oi_bitmap, SCRUB_OI_BITMAP_SIZE);
254 }
255
256 static void osd_scrub_file_init(struct osd_scrub *scrub, __u8 *uuid)
257 {
258         struct scrub_file *sf = &scrub->os_file;
259
260         memset(sf, 0, sizeof(*sf));
261         memcpy(sf->sf_uuid, uuid, 16);
262         sf->sf_magic = SCRUB_MAGIC_V1;
263         sf->sf_status = SS_INIT;
264 }
265
266 void osd_scrub_file_reset(struct osd_scrub *scrub, __u8 *uuid, __u64 flags)
267 {
268         struct scrub_file *sf = &scrub->os_file;
269
270         CDEBUG(D_LFSCK, "Reset OI scrub file, flags = "LPX64"\n", flags);
271         memcpy(sf->sf_uuid, uuid, 16);
272         sf->sf_status = SS_INIT;
273         sf->sf_flags |= flags;
274         sf->sf_param = 0;
275         sf->sf_run_time = 0;
276         sf->sf_time_latest_start = 0;
277         sf->sf_time_last_checkpoint = 0;
278         sf->sf_pos_latest_start = 0;
279         sf->sf_pos_last_checkpoint = 0;
280         sf->sf_pos_first_inconsistent = 0;
281         sf->sf_items_checked = 0;
282         sf->sf_items_updated = 0;
283         sf->sf_items_failed = 0;
284         sf->sf_items_updated_prior = 0;
285         sf->sf_items_noscrub = 0;
286         sf->sf_items_igif = 0;
287 }
288
289 static int osd_scrub_file_load(struct osd_scrub *scrub)
290 {
291         loff_t  pos  = 0;
292         char   *name = LDISKFS_SB(osd_scrub2sb(scrub))->s_es->s_volume_name;
293         int     len  = sizeof(scrub->os_file_disk);
294         int     rc;
295
296         rc = osd_ldiskfs_read(scrub->os_inode, &scrub->os_file_disk, len, &pos);
297         if (rc == len) {
298                 struct scrub_file *sf = &scrub->os_file;
299
300                 osd_scrub_file_to_cpu(sf, &scrub->os_file_disk);
301                 if (sf->sf_magic != SCRUB_MAGIC_V1) {
302                         CWARN("%.16s: invalid scrub magic 0x%x != 0x%x\n,",
303                               name, sf->sf_magic, SCRUB_MAGIC_V1);
304                         /* Process it as new scrub file. */
305                         rc = -ENOENT;
306                 } else {
307                         rc = 0;
308                 }
309         } else if (rc != 0) {
310                 CERROR("%.16s: fail to load scrub file, expected = %d, "
311                        "rc = %d\n", name, len, rc);
312                 if (rc > 0)
313                         rc = -EFAULT;
314         } else {
315                 /* return -ENOENT for empty scrub file case. */
316                 rc = -ENOENT;
317         }
318
319         return rc;
320 }
321
322 int osd_scrub_file_store(struct osd_scrub *scrub)
323 {
324         struct osd_device *dev;
325         handle_t          *jh;
326         loff_t             pos     = 0;
327         int                len     = sizeof(scrub->os_file_disk);
328         int                credits;
329         int                rc;
330
331         dev = container_of0(scrub, struct osd_device, od_scrub);
332         credits = osd_dto_credits_noquota[DTO_WRITE_BASE] +
333                   osd_dto_credits_noquota[DTO_WRITE_BLOCK];
334         jh = ldiskfs_journal_start_sb(osd_sb(dev), credits);
335         if (IS_ERR(jh)) {
336                 rc = PTR_ERR(jh);
337                 CERROR("%.16s: fail to start trans for scrub store, rc = %d\n",
338                        LDISKFS_SB(osd_scrub2sb(scrub))->s_es->s_volume_name,rc);
339                 return rc;
340         }
341
342         osd_scrub_file_to_le(&scrub->os_file_disk, &scrub->os_file);
343         rc = osd_ldiskfs_write_record(scrub->os_inode, &scrub->os_file_disk,
344                                       len, 0, &pos, jh);
345         ldiskfs_journal_stop(jh);
346         if (rc != 0)
347                 CERROR("%.16s: fail to store scrub file, expected = %d, "
348                        "rc = %d\n",
349                        LDISKFS_SB(osd_scrub2sb(scrub))->s_es->s_volume_name,
350                        len, rc);
351         scrub->os_time_last_checkpoint = cfs_time_current();
352         scrub->os_time_next_checkpoint = scrub->os_time_last_checkpoint +
353                                 cfs_time_seconds(SCRUB_CHECKPOINT_INTERVAL);
354         return rc;
355 }
356
357 /* OI scrub APIs */
358
359 static int osd_scrub_prep(struct osd_device *dev)
360 {
361         struct osd_scrub     *scrub  = &dev->od_scrub;
362         struct ptlrpc_thread *thread = &scrub->os_thread;
363         struct scrub_file    *sf     = &scrub->os_file;
364         __u32                 flags  = scrub->os_start_flags;
365         int                   rc;
366         ENTRY;
367
368         down_write(&scrub->os_rwsem);
369         if (flags & SS_SET_FAILOUT)
370                 sf->sf_param |= SP_FAILOUT;
371
372         if (flags & SS_CLEAR_FAILOUT)
373                 sf->sf_param &= ~SP_FAILOUT;
374
375         if (flags & SS_RESET)
376                 osd_scrub_file_reset(scrub,
377                         LDISKFS_SB(osd_sb(dev))->s_es->s_uuid, 0);
378
379         if (flags & SS_AUTO) {
380                 scrub->os_full_speed = 1;
381                 sf->sf_flags |= SF_AUTO;
382         } else {
383                 scrub->os_full_speed = 0;
384         }
385
386         if (sf->sf_flags & (SF_RECREATED | SF_INCONSISTENT | SF_UPGRADE))
387                 scrub->os_full_speed = 1;
388
389         scrub->os_in_prior = 0;
390         scrub->os_waiting = 0;
391         scrub->os_paused = 0;
392         scrub->os_new_checked = 0;
393         if (sf->sf_pos_last_checkpoint != 0)
394                 sf->sf_pos_latest_start = sf->sf_pos_last_checkpoint + 1;
395         else
396                 sf->sf_pos_latest_start = LDISKFS_FIRST_INO(osd_sb(dev)) + 1;
397
398         scrub->os_pos_current = sf->sf_pos_latest_start;
399         sf->sf_status = SS_SCANNING;
400         sf->sf_time_latest_start = cfs_time_current_sec();
401         sf->sf_time_last_checkpoint = sf->sf_time_latest_start;
402         rc = osd_scrub_file_store(scrub);
403         if (rc == 0) {
404                 spin_lock(&scrub->os_lock);
405                 thread_set_flags(thread, SVC_RUNNING);
406                 spin_unlock(&scrub->os_lock);
407                 cfs_waitq_broadcast(&thread->t_ctl_waitq);
408         }
409         up_write(&scrub->os_rwsem);
410
411         RETURN(rc);
412 }
413
414 static int
415 osd_scrub_check_update(struct osd_thread_info *info, struct osd_device *dev,
416                        struct osd_idmap_cache *oic, int val)
417 {
418         struct osd_scrub             *scrub  = &dev->od_scrub;
419         struct scrub_file            *sf     = &scrub->os_file;
420         struct lu_fid                *fid    = &oic->oic_fid;
421         struct osd_inode_id          *lid    = &oic->oic_lid;
422         struct osd_inode_id          *lid2   = &info->oti_id;
423         struct osd_inconsistent_item *oii    = NULL;
424         struct inode                 *inode  = NULL;
425         int                           ops    = DTO_INDEX_UPDATE;
426         int                           idx;
427         int                           rc;
428         ENTRY;
429
430         down_write(&scrub->os_rwsem);
431         scrub->os_new_checked++;
432         if (val < 0)
433                 GOTO(out, rc = val);
434
435         if (scrub->os_in_prior)
436                 oii = cfs_list_entry(oic, struct osd_inconsistent_item,
437                                      oii_cache);
438
439         if (lid->oii_ino < sf->sf_pos_latest_start && oii == NULL)
440                 GOTO(out, rc = 0);
441
442         if (fid_is_igif(fid))
443                 sf->sf_items_igif++;
444
445         if ((val == SCRUB_NEXT_NOLMA) &&
446             (!dev->od_handle_nolma || OBD_FAIL_CHECK(OBD_FAIL_FID_NOLMA)))
447                 GOTO(out, rc = 0);
448
449         if ((oii != NULL && oii->oii_insert) || (val == SCRUB_NEXT_NOLMA))
450                 goto iget;
451
452         /* XXX: Currently, no FID-in-LMA for OST object, so osd_oi_lookup()
453          *      without checking FLD is enough.
454          *
455          *      It should be updated if FID-in-LMA for OSD object introduced
456          *      in the future. */
457         rc = osd_oi_lookup(info, dev, fid, lid2, false);
458         if (rc != 0) {
459                 if (rc != -ENOENT)
460                         GOTO(out, rc);
461
462 iget:
463                 inode = osd_iget(info, dev, lid);
464                 if (IS_ERR(inode)) {
465                         rc = PTR_ERR(inode);
466                         /* Someone removed the inode. */
467                         if (rc == -ENOENT || rc == -ESTALE)
468                                 rc = 0;
469                         GOTO(out, rc);
470                 }
471
472                 /* Check whether the inode to be unlinked during OI scrub. */
473                 if (unlikely(inode->i_nlink == 0)) {
474                         iput(inode);
475                         GOTO(out, rc = 0);
476                 }
477
478                 ops = DTO_INDEX_INSERT;
479                 idx = osd_oi_fid2idx(dev, fid);
480                 if (val == SCRUB_NEXT_NOLMA) {
481                         sf->sf_flags |= SF_UPGRADE;
482                         scrub->os_full_speed = 1;
483                         rc = osd_ea_fid_set(info, inode, fid, 0);
484                         if (rc != 0)
485                                 GOTO(out, rc);
486
487                         if (!(sf->sf_flags & SF_INCONSISTENT))
488                                 dev->od_igif_inoi = 0;
489                 } else {
490                         sf->sf_flags |= SF_RECREATED;
491                         scrub->os_full_speed = 1;
492                         if (unlikely(!ldiskfs_test_bit(idx, sf->sf_oi_bitmap)))
493                                 ldiskfs_set_bit(idx, sf->sf_oi_bitmap);
494                 }
495         } else if (osd_id_eq(lid, lid2)) {
496                 GOTO(out, rc = 0);
497         } else {
498                 sf->sf_flags |= SF_INCONSISTENT;
499                 scrub->os_full_speed = 1;
500
501                 /* XXX: If the device is restored from file-level backup, then
502                  *      some IGIFs may have been already in OI files, and some
503                  *      may be not yet. Means upgrading from 1.8 may be partly
504                  *      processed, but some clients may hold some immobilized
505                  *      IGIFs, and use them to access related objects. Under
506                  *      such case, OSD does not know whether an given IGIF has
507                  *      been processed or to be processed, and it also cannot
508                  *      generate local ino#/gen# directly from the immobilized
509                  *      IGIF because of the backup/restore. Then force OSD to
510                  *      lookup the given IGIF in OI files, and if no entry,
511                  *      then ask the client to retry after upgrading completed.
512                  *      No better choice. */
513                 dev->od_igif_inoi = 1;
514         }
515
516         rc = osd_scrub_refresh_mapping(info, dev, fid, lid, ops);
517         if (rc == 0) {
518                 if (scrub->os_in_prior)
519                         sf->sf_items_updated_prior++;
520                 else
521                         sf->sf_items_updated++;
522         }
523
524         GOTO(out, rc);
525
526 out:
527         if (rc < 0) {
528                 sf->sf_items_failed++;
529                 if (sf->sf_pos_first_inconsistent == 0 ||
530                     sf->sf_pos_first_inconsistent > lid->oii_ino)
531                         sf->sf_pos_first_inconsistent = lid->oii_ino;
532         } else {
533                 rc = 0;
534         }
535
536         if (ops == DTO_INDEX_INSERT) {
537                 /* There may be conflict unlink during the OI scrub,
538                  * if happend, then remove the new added OI mapping. */
539                 if (unlikely(inode->i_nlink == 0))
540                         osd_scrub_refresh_mapping(info, dev, fid, lid,
541                                                   DTO_INDEX_DELETE);
542                 iput(inode);
543         }
544         up_write(&scrub->os_rwsem);
545
546         if (oii != NULL) {
547                 LASSERT(!cfs_list_empty(&oii->oii_list));
548
549                 spin_lock(&scrub->os_lock);
550                 cfs_list_del_init(&oii->oii_list);
551                 spin_unlock(&scrub->os_lock);
552                 OBD_FREE_PTR(oii);
553         }
554         RETURN(sf->sf_param & SP_FAILOUT ? rc : 0);
555 }
556
557 static int osd_scrub_checkpoint(struct osd_scrub *scrub)
558 {
559         struct scrub_file *sf = &scrub->os_file;
560         int                rc;
561
562         if (likely(cfs_time_before(cfs_time_current(),
563                                    scrub->os_time_next_checkpoint) ||
564                    scrub->os_new_checked == 0))
565                 return 0;
566
567         down_write(&scrub->os_rwsem);
568         sf->sf_items_checked += scrub->os_new_checked;
569         scrub->os_new_checked = 0;
570         sf->sf_pos_last_checkpoint = scrub->os_pos_current;
571         sf->sf_time_last_checkpoint = cfs_time_current_sec();
572         sf->sf_run_time += cfs_duration_sec(cfs_time_current() + HALF_SEC -
573                                             scrub->os_time_last_checkpoint);
574         rc = osd_scrub_file_store(scrub);
575         up_write(&scrub->os_rwsem);
576
577         return rc;
578 }
579
580 static void osd_scrub_post(struct osd_scrub *scrub, int result)
581 {
582         struct scrub_file *sf = &scrub->os_file;
583         ENTRY;
584
585         down_write(&scrub->os_rwsem);
586         spin_lock(&scrub->os_lock);
587         thread_set_flags(&scrub->os_thread, SVC_STOPPING);
588         spin_unlock(&scrub->os_lock);
589         if (scrub->os_new_checked > 0) {
590                 sf->sf_items_checked += scrub->os_new_checked;
591                 scrub->os_new_checked = 0;
592                 sf->sf_pos_last_checkpoint = scrub->os_pos_current;
593         }
594         sf->sf_time_last_checkpoint = cfs_time_current_sec();
595         if (result > 0) {
596                 struct osd_device *dev =
597                         container_of0(scrub, struct osd_device, od_scrub);
598
599                 dev->od_igif_inoi = 1;
600                 sf->sf_status = SS_COMPLETED;
601                 memset(sf->sf_oi_bitmap, 0, SCRUB_OI_BITMAP_SIZE);
602                 sf->sf_flags &= ~(SF_RECREATED | SF_INCONSISTENT |
603                                   SF_UPGRADE | SF_AUTO);
604                 sf->sf_time_last_complete = sf->sf_time_last_checkpoint;
605                 sf->sf_success_count++;
606         } else if (result == 0) {
607                 if (scrub->os_paused)
608                         sf->sf_status = SS_PAUSED;
609                 else
610                         sf->sf_status = SS_STOPPED;
611         } else {
612                 sf->sf_status = SS_FAILED;
613         }
614         sf->sf_run_time += cfs_duration_sec(cfs_time_current() + HALF_SEC -
615                                             scrub->os_time_last_checkpoint);
616         result = osd_scrub_file_store(scrub);
617         if (result < 0)
618                 CERROR("%.16s: fail to osd_scrub_post, rc = %d\n",
619                        LDISKFS_SB(osd_scrub2sb(scrub))->s_es->s_volume_name,
620                        result);
621         up_write(&scrub->os_rwsem);
622
623         EXIT;
624 }
625
626 /* iteration engine */
627
628 struct osd_iit_param {
629         struct super_block *sb;
630         struct buffer_head *bitmap;
631         ldiskfs_group_t bg;
632         __u32 gbase;
633         __u32 offset;
634 };
635
636 typedef int (*osd_iit_next_policy)(struct osd_thread_info *info,
637                                    struct osd_device *dev,
638                                    struct osd_iit_param *param,
639                                    struct osd_idmap_cache **oic,
640                                    int noslot);
641
642 typedef int (*osd_iit_exec_policy)(struct osd_thread_info *info,
643                                    struct osd_device *dev,
644                                    struct osd_iit_param *param,
645                                    struct osd_idmap_cache *oic,
646                                    int *noslot, int rc);
647
648 static int osd_iit_next(struct osd_iit_param *param, __u32 *pos)
649 {
650         param->offset = ldiskfs_find_next_bit(param->bitmap->b_data,
651                         LDISKFS_INODES_PER_GROUP(param->sb), param->offset);
652         if (param->offset >= LDISKFS_INODES_PER_GROUP(param->sb)) {
653                 *pos = 1 + (param->bg+1) * LDISKFS_INODES_PER_GROUP(param->sb);
654                 return SCRUB_NEXT_BREAK;
655         } else {
656                 *pos = param->gbase + param->offset;
657                 return 0;
658         }
659 }
660
661 static int osd_iit_iget(struct osd_thread_info *info, struct osd_device *dev,
662                         struct lu_fid *fid, struct osd_inode_id *lid, __u32 pos,
663                         struct super_block *sb, bool scrub)
664 {
665         struct lustre_mdt_attrs *lma   = &info->oti_mdt_attrs;
666         struct inode            *inode;
667         int                      rc;
668
669         osd_id_gen(lid, pos, OSD_OII_NOGEN);
670         inode = osd_iget(info, dev, lid);
671         if (IS_ERR(inode)) {
672                 rc = PTR_ERR(inode);
673                 /* The inode may be removed after bitmap searching, or the
674                  * file is new created without inode initialized yet. */
675                 if (rc == -ENOENT || rc == -ESTALE)
676                         return SCRUB_NEXT_CONTINUE;
677
678                 CERROR("%.16s: fail to read inode, ino# = %u, rc = %d\n",
679                        LDISKFS_SB(sb)->s_es->s_volume_name, pos, rc);
680                 return rc;
681         }
682
683         /* If the inode has no OI mapping, then it is special locally used,
684          * should be invisible to OI scrub or up layer LFSCK. */
685         if (ldiskfs_test_inode_state(inode, LDISKFS_STATE_LUSTRE_NO_OI)) {
686                 iput(inode);
687                 return SCRUB_NEXT_CONTINUE;
688         }
689
690         if (scrub &&
691             ldiskfs_test_inode_state(inode, LDISKFS_STATE_LUSTRE_NOSCRUB)) {
692                 /* Only skip it for the first OI scrub accessing. */
693                 ldiskfs_clear_inode_state(inode, LDISKFS_STATE_LUSTRE_NOSCRUB);
694                 iput(inode);
695                 return SCRUB_NEXT_NOSCRUB;
696         }
697
698         rc = osd_get_lma(info, inode, &info->oti_obj_dentry, lma);
699         if (rc == 0) {
700                 if (fid_is_llog(&lma->lma_self_fid) ||
701                     (!scrub && fid_is_internal(&lma->lma_self_fid)) ||
702                     (scrub && (lma->lma_incompat & LMAI_AGENT)))
703                         rc = SCRUB_NEXT_CONTINUE;
704                 else
705                         *fid = lma->lma_self_fid;
706         } else if (rc == -ENODATA) {
707                 lu_igif_build(fid, inode->i_ino, inode->i_generation);
708                 if (scrub)
709                         rc = SCRUB_NEXT_NOLMA;
710                 else
711                         rc = 0;
712         }
713         iput(inode);
714         return rc;
715 }
716
717 static int osd_scrub_next(struct osd_thread_info *info, struct osd_device *dev,
718                           struct osd_iit_param *param,
719                           struct osd_idmap_cache **oic, int noslot)
720 {
721         struct osd_scrub     *scrub  = &dev->od_scrub;
722         struct ptlrpc_thread *thread = &scrub->os_thread;
723         struct lu_fid        *fid;
724         struct osd_inode_id  *lid;
725         int                   rc;
726
727         if (OBD_FAIL_CHECK(OBD_FAIL_OSD_SCRUB_DELAY) && cfs_fail_val > 0) {
728                 struct l_wait_info lwi;
729
730                 lwi = LWI_TIMEOUT(cfs_time_seconds(cfs_fail_val), NULL, NULL);
731                 l_wait_event(thread->t_ctl_waitq,
732                              !cfs_list_empty(&scrub->os_inconsistent_items) ||
733                              !thread_is_running(thread),
734                              &lwi);
735         }
736
737         if (OBD_FAIL_CHECK(OBD_FAIL_OSD_SCRUB_CRASH)) {
738                 spin_lock(&scrub->os_lock);
739                 thread_set_flags(thread, SVC_STOPPING);
740                 spin_unlock(&scrub->os_lock);
741                 return SCRUB_NEXT_CRASH;
742         }
743
744         if (OBD_FAIL_CHECK(OBD_FAIL_OSD_SCRUB_FATAL))
745                 return SCRUB_NEXT_FATAL;
746
747         if (unlikely(!thread_is_running(thread)))
748                 return SCRUB_NEXT_EXIT;
749
750         if (!cfs_list_empty(&scrub->os_inconsistent_items)) {
751                 struct osd_inconsistent_item *oii;
752
753                 oii = cfs_list_entry(scrub->os_inconsistent_items.next,
754                                      struct osd_inconsistent_item, oii_list);
755                 *oic = &oii->oii_cache;
756                 scrub->os_in_prior = 1;
757                 return 0;
758         }
759
760         if (noslot != 0)
761                 return SCRUB_NEXT_WAIT;
762
763         rc = osd_iit_next(param, &scrub->os_pos_current);
764         if (rc != 0)
765                 return rc;
766
767         *oic = &scrub->os_oic;
768         fid = &(*oic)->oic_fid;
769         lid = &(*oic)->oic_lid;
770         rc = osd_iit_iget(info, dev, fid, lid,
771                           scrub->os_pos_current, param->sb, true);
772         return rc;
773 }
774
775 static int osd_preload_next(struct osd_thread_info *info,
776                             struct osd_device *dev, struct osd_iit_param *param,
777                             struct osd_idmap_cache **oic, int noslot)
778 {
779         struct osd_otable_cache *ooc    = &dev->od_otable_it->ooi_cache;
780         struct osd_scrub        *scrub;
781         struct ptlrpc_thread    *thread;
782         int                      rc;
783
784         rc = osd_iit_next(param, &ooc->ooc_pos_preload);
785         if (rc != 0)
786                 return rc;
787
788         scrub = &dev->od_scrub;
789         thread = &scrub->os_thread;
790         if (thread_is_running(thread) &&
791             ooc->ooc_pos_preload >= scrub->os_pos_current)
792                 return SCRUB_NEXT_EXIT;
793
794         rc = osd_iit_iget(info, dev,
795                           &ooc->ooc_cache[ooc->ooc_producer_idx].oic_fid,
796                           &ooc->ooc_cache[ooc->ooc_producer_idx].oic_lid,
797                           ooc->ooc_pos_preload, param->sb, false);
798         /* If succeed, it needs to move forward; otherwise up layer LFSCK may
799          * ignore the failure, so it still need to skip the inode next time. */
800         ooc->ooc_pos_preload = param->gbase + ++(param->offset);
801         return rc;
802 }
803
804 static inline int
805 osd_scrub_wakeup(struct osd_scrub *scrub, struct osd_otable_it *it)
806 {
807         spin_lock(&scrub->os_lock);
808         if (osd_scrub_has_window(scrub, &it->ooi_cache) ||
809             !cfs_list_empty(&scrub->os_inconsistent_items) ||
810             it->ooi_waiting || !thread_is_running(&scrub->os_thread))
811                 scrub->os_waiting = 0;
812         else
813                 scrub->os_waiting = 1;
814         spin_unlock(&scrub->os_lock);
815
816         return !scrub->os_waiting;
817 }
818
819 static int osd_scrub_exec(struct osd_thread_info *info, struct osd_device *dev,
820                           struct osd_iit_param *param,
821                           struct osd_idmap_cache *oic, int *noslot, int rc)
822 {
823         struct l_wait_info       lwi    = { 0 };
824         struct osd_scrub        *scrub  = &dev->od_scrub;
825         struct scrub_file       *sf     = &scrub->os_file;
826         struct ptlrpc_thread    *thread = &scrub->os_thread;
827         struct osd_otable_it    *it     = dev->od_otable_it;
828         struct osd_otable_cache *ooc    = it ? &it->ooi_cache : NULL;
829
830         switch (rc) {
831         case SCRUB_NEXT_CONTINUE:
832                 goto next;
833         case SCRUB_NEXT_WAIT:
834                 goto wait;
835         case SCRUB_NEXT_NOSCRUB:
836                 down_write(&scrub->os_rwsem);
837                 scrub->os_new_checked++;
838                 sf->sf_items_noscrub++;
839                 up_write(&scrub->os_rwsem);
840                 goto next;
841         }
842
843         rc = osd_scrub_check_update(info, dev, oic, rc);
844         if (rc != 0)
845                 return rc;
846
847         rc = osd_scrub_checkpoint(scrub);
848         if (rc != 0) {
849                 CERROR("%.16s: fail to checkpoint, pos = %u, rc = %d\n",
850                        LDISKFS_SB(param->sb)->s_es->s_volume_name,
851                        scrub->os_pos_current, rc);
852                 /* Continue, as long as the scrub itself can go ahead. */
853         }
854
855         if (scrub->os_in_prior) {
856                 scrub->os_in_prior = 0;
857                 return 0;
858         }
859
860 next:
861         scrub->os_pos_current = param->gbase + ++(param->offset);
862
863 wait:
864         if (it != NULL && it->ooi_waiting &&
865             ooc->ooc_pos_preload < scrub->os_pos_current) {
866                 spin_lock(&scrub->os_lock);
867                 it->ooi_waiting = 0;
868                 cfs_waitq_broadcast(&thread->t_ctl_waitq);
869                 spin_unlock(&scrub->os_lock);
870         }
871
872         if (scrub->os_full_speed || rc == SCRUB_NEXT_CONTINUE)
873                 return 0;
874
875         if (osd_scrub_has_window(scrub, ooc)) {
876                 *noslot = 0;
877                 return 0;
878         }
879
880         l_wait_event(thread->t_ctl_waitq,
881                      osd_scrub_wakeup(scrub, it),
882                      &lwi);
883
884         if (osd_scrub_has_window(scrub, ooc))
885                 *noslot = 0;
886         else
887                 *noslot = 1;
888         return 0;
889 }
890
891 static int osd_preload_exec(struct osd_thread_info *info,
892                             struct osd_device *dev, struct osd_iit_param *param,
893                             struct osd_idmap_cache *oic, int *noslot, int rc)
894 {
895         struct osd_otable_cache *ooc = &dev->od_otable_it->ooi_cache;
896
897         if (rc == 0) {
898                 ooc->ooc_cached_items++;
899                 ooc->ooc_producer_idx = (ooc->ooc_producer_idx + 1) &
900                                         ~OSD_OTABLE_IT_CACHE_MASK;
901         }
902         return rc > 0 ? 0 : rc;
903 }
904
905 #define SCRUB_IT_ALL    1
906 #define SCRUB_IT_CRASH  2
907
908 static int osd_inode_iteration(struct osd_thread_info *info,
909                                struct osd_device *dev, __u32 max, bool preload)
910 {
911         osd_iit_next_policy   next;
912         osd_iit_exec_policy   exec;
913         __u32                *pos;
914         __u32                *count;
915         struct osd_iit_param  param;
916         __u32                 limit;
917         int                   noslot = 0;
918         int                   rc;
919         ENTRY;
920
921         if (!preload) {
922                 struct osd_scrub *scrub = &dev->od_scrub;
923
924                 next = osd_scrub_next;
925                 exec = osd_scrub_exec;
926                 pos = &scrub->os_pos_current;
927                 count = &scrub->os_new_checked;
928         } else {
929                 struct osd_otable_cache *ooc = &dev->od_otable_it->ooi_cache;
930
931                 next = osd_preload_next;
932                 exec = osd_preload_exec;
933                 pos = &ooc->ooc_pos_preload;
934                 count = &ooc->ooc_cached_items;
935         }
936         param.sb = osd_sb(dev);
937         limit = le32_to_cpu(LDISKFS_SB(param.sb)->s_es->s_inodes_count);
938
939         while (*pos <= limit && *count < max) {
940                 struct osd_idmap_cache *oic = NULL;
941
942                 param.bg = (*pos - 1) / LDISKFS_INODES_PER_GROUP(param.sb);
943                 param.offset = (*pos - 1) % LDISKFS_INODES_PER_GROUP(param.sb);
944                 param.gbase = 1 + param.bg * LDISKFS_INODES_PER_GROUP(param.sb);
945                 param.bitmap = ldiskfs_read_inode_bitmap(param.sb, param.bg);
946                 if (param.bitmap == NULL) {
947                         CERROR("%.16s: fail to read bitmap for %u, "
948                                "scrub will stop, urgent mode\n",
949                                LDISKFS_SB(param.sb)->s_es->s_volume_name,
950                                (__u32)param.bg);
951                         RETURN(-EIO);
952                 }
953
954                 while (param.offset < LDISKFS_INODES_PER_GROUP(param.sb) &&
955                        *count < max) {
956                         rc = next(info, dev, &param, &oic, noslot);
957                         switch (rc) {
958                         case SCRUB_NEXT_BREAK:
959                                 goto next_group;
960                         case SCRUB_NEXT_EXIT:
961                                 brelse(param.bitmap);
962                                 RETURN(0);
963                         case SCRUB_NEXT_CRASH:
964                                 brelse(param.bitmap);
965                                 RETURN(SCRUB_IT_CRASH);
966                         case SCRUB_NEXT_FATAL:
967                                 brelse(param.bitmap);
968                                 RETURN(-EINVAL);
969                         }
970
971                         rc = exec(info, dev, &param, oic, &noslot, rc);
972                         if (rc != 0) {
973                                 brelse(param.bitmap);
974                                 RETURN(rc);
975                         }
976
977                         if (preload && dev->od_otable_it->ooi_stopping) {
978                                 brelse(param.bitmap);
979                                 RETURN(0);
980                         }
981                 }
982
983 next_group:
984                 brelse(param.bitmap);
985
986                 if (preload && dev->od_otable_it->ooi_stopping)
987                         RETURN(0);
988         }
989
990         if (*pos > limit)
991                 RETURN(SCRUB_IT_ALL);
992         RETURN(0);
993 }
994
995 static int osd_otable_it_preload(const struct lu_env *env,
996                                  struct osd_otable_it *it)
997 {
998         struct osd_device       *dev   = it->ooi_dev;
999         struct osd_scrub        *scrub = &dev->od_scrub;
1000         struct osd_otable_cache *ooc   = &it->ooi_cache;
1001         int                      rc;
1002         ENTRY;
1003
1004         rc = osd_inode_iteration(osd_oti_get(env), dev,
1005                                  OSD_OTABLE_IT_CACHE_SIZE, true);
1006         if (rc == SCRUB_IT_ALL)
1007                 it->ooi_all_cached = 1;
1008
1009         CDEBUG(D_LFSCK, "OSD pre-loaded: max = %u, preload = %u, rc = %d\n",
1010                le32_to_cpu(LDISKFS_SB(osd_sb(dev))->s_es->s_inodes_count),
1011                ooc->ooc_pos_preload, rc);
1012
1013         if (scrub->os_waiting && osd_scrub_has_window(scrub, ooc)) {
1014                 scrub->os_waiting = 0;
1015                 cfs_waitq_broadcast(&scrub->os_thread.t_ctl_waitq);
1016         }
1017
1018         RETURN(rc < 0 ? rc : ooc->ooc_cached_items);
1019 }
1020
1021 static int osd_scrub_main(void *args)
1022 {
1023         struct lu_env         env;
1024         struct osd_device    *dev    = (struct osd_device *)args;
1025         struct osd_scrub     *scrub  = &dev->od_scrub;
1026         struct ptlrpc_thread *thread = &scrub->os_thread;
1027         struct super_block   *sb     = osd_sb(dev);
1028         int                   rc;
1029         ENTRY;
1030
1031         cfs_daemonize("OI_scrub");
1032         rc = lu_env_init(&env, LCT_DT_THREAD);
1033         if (rc != 0) {
1034                 CERROR("%.16s: OI scrub, fail to init env, rc = %d\n",
1035                        LDISKFS_SB(sb)->s_es->s_volume_name, rc);
1036                 GOTO(noenv, rc);
1037         }
1038
1039         rc = osd_scrub_prep(dev);
1040         if (rc != 0) {
1041                 CERROR("%.16s: OI scrub, fail to scrub prep, rc = %d\n",
1042                        LDISKFS_SB(sb)->s_es->s_volume_name, rc);
1043                 GOTO(out, rc);
1044         }
1045
1046         if (!scrub->os_full_speed) {
1047                 struct l_wait_info lwi = { 0 };
1048                 struct osd_otable_it *it = dev->od_otable_it;
1049                 struct osd_otable_cache *ooc = &it->ooi_cache;
1050
1051                 l_wait_event(thread->t_ctl_waitq,
1052                              it->ooi_user_ready || !thread_is_running(thread),
1053                              &lwi);
1054                 if (unlikely(!thread_is_running(thread)))
1055                         GOTO(post, rc = 0);
1056
1057                 scrub->os_pos_current = ooc->ooc_pos_preload;
1058         }
1059
1060         CDEBUG(D_LFSCK, "OI scrub: flags = 0x%x, pos = %u\n",
1061                scrub->os_start_flags, scrub->os_pos_current);
1062
1063         rc = osd_inode_iteration(osd_oti_get(&env), dev, ~0U, false);
1064         if (unlikely(rc == SCRUB_IT_CRASH))
1065                 GOTO(out, rc = -EINVAL);
1066         GOTO(post, rc);
1067
1068 post:
1069         osd_scrub_post(scrub, rc);
1070         CDEBUG(D_LFSCK, "OI scrub: stop, rc = %d, pos = %u\n",
1071                rc, scrub->os_pos_current);
1072
1073 out:
1074         while (!cfs_list_empty(&scrub->os_inconsistent_items)) {
1075                 struct osd_inconsistent_item *oii;
1076
1077                 oii = cfs_list_entry(scrub->os_inconsistent_items.next,
1078                                      struct osd_inconsistent_item, oii_list);
1079                 cfs_list_del_init(&oii->oii_list);
1080                 OBD_FREE_PTR(oii);
1081         }
1082         lu_env_fini(&env);
1083
1084 noenv:
1085         spin_lock(&scrub->os_lock);
1086         thread_set_flags(thread, SVC_STOPPED);
1087         cfs_waitq_broadcast(&thread->t_ctl_waitq);
1088         spin_unlock(&scrub->os_lock);
1089         return rc;
1090 }
1091
1092 /* initial OI scrub */
1093
1094 typedef int (*scandir_t)(struct osd_thread_info *, struct osd_device *,
1095                          struct dentry *, filldir_t filldir);
1096
1097 static int osd_ios_varfid_fill(void *buf, const char *name, int namelen,
1098                                loff_t offset, __u64 ino, unsigned d_type);
1099
1100 static int
1101 osd_ios_general_scan(struct osd_thread_info *info, struct osd_device *dev,
1102                      struct dentry *dentry, filldir_t filldir);
1103 static int
1104 osd_ios_ROOT_scan(struct osd_thread_info *info, struct osd_device *dev,
1105                   struct dentry *dentry, filldir_t filldir);
1106
1107 static int
1108 osd_ios_OBJECTS_scan(struct osd_thread_info *info, struct osd_device *dev,
1109                      struct dentry *dentry, filldir_t filldir);
1110
1111 enum osd_lf_flags {
1112         OLF_SCAN_SUBITEMS       = 0x0001,
1113         OLF_HIDE_FID            = 0x0002,
1114         OLF_SHOW_NAME           = 0x0004,
1115 };
1116
1117 struct osd_lf_map {
1118         char            *olm_name;
1119         struct lu_fid    olm_fid;
1120         __u16            olm_flags;
1121         scandir_t        olm_scandir;
1122         filldir_t        olm_filldir;
1123 };
1124
1125 /* Add the new introduced local files in the list in the future. */
1126 static const struct osd_lf_map osd_lf_maps[] = {
1127         /* CATALOGS */
1128         { CATLIST, { FID_SEQ_LOCAL_FILE, LLOG_CATALOGS_OID, 0 }, OLF_SHOW_NAME,
1129                 NULL, NULL },
1130
1131         /* CONFIGS */
1132         { MOUNT_CONFIGS_DIR, { FID_SEQ_LOCAL_FILE, MGS_CONFIGS_OID, 0 },
1133                 OLF_SCAN_SUBITEMS, osd_ios_general_scan,
1134                 osd_ios_varfid_fill },
1135
1136         /* NIDTBL_VERSIONS */
1137         { MGS_NIDTBL_DIR, { 0, 0, 0 }, OLF_SCAN_SUBITEMS,
1138                 osd_ios_general_scan, osd_ios_varfid_fill },
1139
1140         /* PENDING */
1141         { "PENDING", { 0, 0, 0 }, 0, NULL, NULL },
1142
1143         /* ROOT */
1144         { "ROOT", { FID_SEQ_ROOT, 1, 0 },
1145                 OLF_SCAN_SUBITEMS | OLF_HIDE_FID, osd_ios_ROOT_scan, NULL },
1146
1147         /* changelog_catalog */
1148         { CHANGELOG_CATALOG, { 0, 0, 0 }, 0, NULL, NULL },
1149
1150         /* changelog_users */
1151         { CHANGELOG_USERS, { 0, 0, 0 }, 0, NULL, NULL },
1152
1153         /* fld */
1154         { "fld", { FID_SEQ_LOCAL_FILE, FLD_INDEX_OID, 0 }, OLF_SHOW_NAME,
1155                 NULL, NULL },
1156
1157         /* last_rcvd */
1158         { LAST_RCVD, { FID_SEQ_LOCAL_FILE, LAST_RECV_OID, 0 }, OLF_SHOW_NAME,
1159                 NULL, NULL },
1160
1161         /* lfsck_bookmark */
1162         { "lfsck_bookmark", { 0, 0, 0 }, 0, NULL, NULL },
1163
1164         /* lov_objid */
1165         { LOV_OBJID, { FID_SEQ_LOCAL_FILE, MDD_LOV_OBJ_OID, 0 }, OLF_SHOW_NAME,
1166                 NULL, NULL },
1167
1168         /* lov_objseq */
1169         { LOV_OBJSEQ, { FID_SEQ_LOCAL_FILE, MDD_LOV_OBJ_OSEQ, 0 },
1170                 OLF_SHOW_NAME, NULL, NULL },
1171
1172         /* quota_master */
1173         { QMT_DIR, { 0, 0, 0 }, OLF_SCAN_SUBITEMS,
1174                 osd_ios_general_scan, osd_ios_varfid_fill },
1175
1176         /* quota_slave */
1177         { QSD_DIR, { 0, 0, 0 }, OLF_SCAN_SUBITEMS,
1178                 osd_ios_general_scan, osd_ios_varfid_fill },
1179
1180         /* seq_ctl */
1181         { "seq_ctl", { FID_SEQ_LOCAL_FILE, FID_SEQ_CTL_OID, 0 },
1182                 OLF_SHOW_NAME, NULL, NULL },
1183
1184         /* seq_srv */
1185         { "seq_srv", { FID_SEQ_LOCAL_FILE, FID_SEQ_SRV_OID, 0 },
1186                 OLF_SHOW_NAME, NULL, NULL },
1187
1188         /* health_check */
1189         { HEALTH_CHECK, { FID_SEQ_LOCAL_FILE, OFD_HEALTH_CHECK_OID, 0 },
1190                 OLF_SHOW_NAME, NULL, NULL },
1191
1192         /* lfsck_namespace */
1193         { "lfsck_namespace", { 0, 0, 0 }, 0, NULL, NULL },
1194
1195         /* OBJECTS, upgrade from old device */
1196         { OBJECTS, { 0, 0, 0 }, OLF_SCAN_SUBITEMS, osd_ios_OBJECTS_scan, NULL },
1197
1198         /* lquota_v2.user, upgrade from old device */
1199         { "lquota_v2.user", { 0, 0, 0 }, 0, NULL, NULL },
1200
1201         /* lquota_v2.group, upgrade from old device */
1202         { "lquota_v2.group", { 0, 0, 0 }, 0, NULL, NULL },
1203
1204         /* LAST_GROUP, upgrade from old device */
1205         { "LAST_GROUP", { FID_SEQ_LOCAL_FILE, OFD_LAST_GROUP_OID, 0 },
1206                 OLF_SHOW_NAME, NULL, NULL },
1207
1208         { NULL, { 0, 0, 0 }, 0, NULL, NULL }
1209 };
1210
1211 struct osd_ios_item {
1212         cfs_list_t       oii_list;
1213         struct dentry   *oii_dentry;
1214         scandir_t        oii_scandir;
1215         filldir_t        oii_filldir;
1216 };
1217
1218 struct osd_ios_filldir_buf {
1219         struct osd_thread_info  *oifb_info;
1220         struct osd_device       *oifb_dev;
1221         struct dentry           *oifb_dentry;
1222 };
1223
1224 static inline struct dentry *
1225 osd_ios_lookup_one_len(const char *name, struct dentry *parent, int namelen)
1226 {
1227         struct dentry *dentry;
1228
1229         dentry = ll_lookup_one_len(name, parent, namelen);
1230         if (!IS_ERR(dentry) && dentry->d_inode == NULL) {
1231                 dput(dentry);
1232                 return ERR_PTR(-ENOENT);
1233         }
1234
1235         return dentry;
1236 }
1237
1238 static inline void
1239 osd_ios_llogname2fid(struct lu_fid *fid, const char *name, int namelen)
1240 {
1241         obd_id id = 0;
1242         int    i  = 0;
1243
1244         fid->f_seq = FID_SEQ_LLOG;
1245         while (i < namelen)
1246                 id = id * 10 + name[i++] - '0';
1247
1248         fid->f_oid = id & 0x00000000ffffffffULL;
1249         fid->f_ver = id >> 32;
1250 }
1251
1252 static inline void
1253 osd_ios_Oname2fid(struct lu_fid *fid, const char *name, int namelen)
1254 {
1255         __u64 seq = 0;
1256         int   i   = 0;
1257
1258         while (i < namelen)
1259                 seq = seq * 10 + name[i++] - '0';
1260
1261         lu_last_id_fid(fid, seq);
1262 }
1263
1264 static int
1265 osd_ios_new_item(struct osd_device *dev, struct dentry *dentry,
1266                  scandir_t scandir, filldir_t filldir)
1267 {
1268         struct osd_ios_item *item;
1269
1270         OBD_ALLOC_PTR(item);
1271         if (item == NULL)
1272                 return -ENOMEM;
1273
1274         CFS_INIT_LIST_HEAD(&item->oii_list);
1275         item->oii_dentry = dget(dentry);
1276         item->oii_scandir = scandir;
1277         item->oii_filldir = filldir;
1278         cfs_list_add_tail(&item->oii_list, &dev->od_ios_list);
1279         return 0;
1280 }
1281
1282 /**
1283  * osd_ios_scan_one() - check/fix LMA FID and OI entry for one inode
1284  *
1285  * The passed \a inode's \a fid is verified against the LMA FID. If the \a fid
1286  * is NULL or is empty the IGIF FID is used. The FID is verified in the OI to
1287  * reference the inode, or fixed if it is missing or references another inode.
1288  */
1289 static int
1290 osd_ios_scan_one(struct osd_thread_info *info, struct osd_device *dev,
1291                  struct inode *inode, const struct lu_fid *fid, int flags)
1292 {
1293         struct lustre_mdt_attrs *lma    = &info->oti_mdt_attrs;
1294         struct osd_inode_id     *id     = &info->oti_id;
1295         struct osd_inode_id     *id2    = &info->oti_id2;
1296         struct osd_scrub        *scrub  = &dev->od_scrub;
1297         struct scrub_file       *sf     = &scrub->os_file;
1298         struct lu_fid            tfid;
1299         int                      rc;
1300         ENTRY;
1301
1302         rc = osd_get_lma(info, inode, &info->oti_obj_dentry, lma);
1303         if (rc != 0 && rc != -ENODATA)
1304                 RETURN(rc);
1305
1306         osd_id_gen(id, inode->i_ino, inode->i_generation);
1307         if (rc == -ENODATA) {
1308                 if (fid == NULL || fid_is_zero(fid) || flags & OLF_HIDE_FID)
1309                         lu_igif_build(&tfid, inode->i_ino, inode->i_generation);
1310                 else
1311                         tfid = *fid;
1312                 rc = osd_ea_fid_set(info, inode, &tfid, 0);
1313                 if (rc != 0)
1314                         RETURN(rc);
1315         } else {
1316                 tfid = lma->lma_self_fid;
1317         }
1318
1319         rc = __osd_oi_lookup(info, dev, &tfid, id2);
1320         if (rc != 0) {
1321                 if (rc != -ENOENT)
1322                         RETURN(rc);
1323
1324                 rc = osd_scrub_refresh_mapping(info, dev, &tfid, id,
1325                                                DTO_INDEX_INSERT);
1326                 RETURN(rc);
1327         }
1328
1329         if (osd_id_eq_strict(id, id2))
1330                 RETURN(0);
1331
1332         if (!(sf->sf_flags & SF_INCONSISTENT)) {
1333                 osd_scrub_file_reset(scrub,
1334                                      LDISKFS_SB(osd_sb(dev))->s_es->s_uuid,
1335                                      SF_INCONSISTENT);
1336                 rc = osd_scrub_file_store(scrub);
1337                 if (rc != 0)
1338                         RETURN(rc);
1339         }
1340
1341         rc = osd_scrub_refresh_mapping(info, dev, &tfid, id, DTO_INDEX_UPDATE);
1342
1343         RETURN(rc);
1344 }
1345
1346 static int osd_ios_varfid_fill(void *buf, const char *name, int namelen,
1347                                loff_t offset, __u64 ino, unsigned d_type)
1348 {
1349         struct osd_ios_filldir_buf *fill_buf = buf;
1350         struct osd_device          *dev      = fill_buf->oifb_dev;
1351         struct dentry              *child;
1352         int                         rc;
1353         ENTRY;
1354
1355         /* skip any '.' started names */
1356         if (name[0] == '.')
1357                 RETURN(0);
1358
1359         child = osd_ios_lookup_one_len(name, fill_buf->oifb_dentry, namelen);
1360         if (IS_ERR(child))
1361                 RETURN(PTR_ERR(child));
1362
1363         rc = osd_ios_scan_one(fill_buf->oifb_info, dev, child->d_inode,
1364                               NULL, 0);
1365         if (rc == 0 && S_ISDIR(child->d_inode->i_mode))
1366                 rc = osd_ios_new_item(dev, child, osd_ios_general_scan,
1367                                       osd_ios_varfid_fill);
1368         dput(child);
1369
1370         RETURN(rc);
1371 }
1372
1373 static int osd_ios_root_fill(void *buf, const char *name, int namelen,
1374                              loff_t offset, __u64 ino, unsigned d_type)
1375 {
1376         struct osd_ios_filldir_buf *fill_buf = buf;
1377         struct osd_device          *dev      = fill_buf->oifb_dev;
1378         const struct osd_lf_map    *map;
1379         struct dentry              *child;
1380         int                         rc       = 0;
1381         ENTRY;
1382
1383         /* skip any '.' started names */
1384         if (name[0] == '.')
1385                 RETURN(0);
1386
1387         for (map = osd_lf_maps; map->olm_name != NULL; map++) {
1388                 if (strlen(map->olm_name) != namelen)
1389                         continue;
1390
1391                 if (strncmp(map->olm_name, name, namelen) == 0)
1392                         break;
1393         }
1394
1395         if (map->olm_name == NULL)
1396                 RETURN(0);
1397
1398         child = osd_ios_lookup_one_len(name, fill_buf->oifb_dentry, namelen);
1399         if (IS_ERR(child))
1400                 RETURN(PTR_ERR(child));
1401
1402         rc = osd_ios_scan_one(fill_buf->oifb_info, dev, child->d_inode,
1403                               &map->olm_fid, map->olm_flags);
1404         if (rc == 0 && map->olm_flags & OLF_SCAN_SUBITEMS)
1405                 rc = osd_ios_new_item(dev, child, map->olm_scandir,
1406                                       map->olm_filldir);
1407         dput(child);
1408
1409         RETURN(rc);
1410 }
1411
1412 static int
1413 osd_ios_general_scan(struct osd_thread_info *info, struct osd_device *dev,
1414                      struct dentry *dentry, filldir_t filldir)
1415 {
1416         struct osd_ios_filldir_buf    buf   = { info, dev, dentry };
1417         struct file                  *filp  = &info->oti_it_ea.oie_file;
1418         struct inode                 *inode = dentry->d_inode;
1419         const struct file_operations *fops  = inode->i_fop;
1420         int                           rc;
1421         ENTRY;
1422
1423         LASSERT(filldir != NULL);
1424
1425         filp->f_pos = 0;
1426         filp->f_dentry = dentry;
1427         filp->f_mode = FMODE_64BITHASH;
1428         filp->f_mapping = inode->i_mapping;
1429         filp->f_op = fops;
1430         filp->private_data = NULL;
1431
1432         rc = fops->readdir(filp, &buf, filldir);
1433         fops->release(inode, filp);
1434
1435         RETURN(rc);
1436 }
1437
1438 static int
1439 osd_ios_ROOT_scan(struct osd_thread_info *info, struct osd_device *dev,
1440                   struct dentry *dentry, filldir_t filldir)
1441 {
1442         struct osd_scrub  *scrub  = &dev->od_scrub;
1443         struct scrub_file *sf     = &scrub->os_file;
1444         struct dentry     *child;
1445         int                rc;
1446         ENTRY;
1447
1448         /* It is existing MDT device. */
1449         dev->od_handle_nolma = 1;
1450         child = osd_ios_lookup_one_len(dot_lustre_name, dentry,
1451                                        strlen(dot_lustre_name));
1452         if (IS_ERR(child)) {
1453                 rc = PTR_ERR(child);
1454                 if (rc == -ENOENT) {
1455                         /* It is 1.8 MDT device. */
1456                         if (!(sf->sf_flags & SF_UPGRADE)) {
1457                                 osd_scrub_file_reset(scrub,
1458                                         LDISKFS_SB(osd_sb(dev))->s_es->s_uuid,
1459                                         SF_UPGRADE);
1460                                 rc = osd_scrub_file_store(scrub);
1461                         } else {
1462                                 rc = 0;
1463                         }
1464                 }
1465         } else {
1466                 /* For lustre-2.x (x <= 3), the ".lustre" has NO FID-in-LMA,
1467                  * so the client will get IGIF for the ".lustre" object when
1468                  * the MDT restart.
1469                  *
1470                  * From the OI scrub view, when the MDT upgrade to Lustre-2.4,
1471                  * it does not know whether there are some old clients cached
1472                  * the ".lustre" IGIF during the upgrading. Two choices:
1473                  *
1474                  * 1) Generate IGIF-in-LMA and IGIF-in-OI for the ".lustre".
1475                  *    It will allow the old connected clients to access the
1476                  *    ".lustre" with cached IGIF. But it will cause others
1477                  *    on the MDT failed to check "fid_is_dot_lustre()".
1478                  *
1479                  * 2) Use fixed FID {FID_SEQ_DOT_LUSTRE, FID_OID_DOT_LUSTRE, 0}
1480                  *    for ".lustre" in spite of whether there are some clients
1481                  *    cached the ".lustre" IGIF or not. It enables the check
1482                  *    "fid_is_dot_lustre()" on the MDT, although it will cause
1483                  *    that the old connected clients cannot access the ".lustre"
1484                  *    with the cached IGIF.
1485                  *
1486                  * Usually, it is rare case for the old connected clients
1487                  * to access the ".lustre" with cached IGIF. So we prefer
1488                  * to the solution 2). */
1489                 rc = osd_ios_scan_one(info, dev, child->d_inode,
1490                                       &LU_DOT_LUSTRE_FID, 0);
1491                 dput(child);
1492         }
1493
1494         RETURN(rc);
1495 }
1496
1497 static int
1498 osd_ios_OBJECTS_scan(struct osd_thread_info *info, struct osd_device *dev,
1499                      struct dentry *dentry, filldir_t filldir)
1500 {
1501         struct dentry *child;
1502         int            rc;
1503         ENTRY;
1504
1505         child = osd_ios_lookup_one_len(ADMIN_USR, dentry, strlen(ADMIN_USR));
1506         if (!IS_ERR(child)) {
1507                 rc = osd_ios_scan_one(info, dev, child->d_inode, NULL, 0);
1508                 dput(child);
1509         } else {
1510                 rc = PTR_ERR(child);
1511         }
1512
1513         if (rc != 0 && rc != -ENOENT)
1514                 RETURN(rc);
1515
1516         child = osd_ios_lookup_one_len(ADMIN_GRP, dentry, strlen(ADMIN_GRP));
1517         if (!IS_ERR(child)) {
1518                 rc = osd_ios_scan_one(info, dev, child->d_inode, NULL, 0);
1519                 dput(child);
1520         } else {
1521                 rc = PTR_ERR(child);
1522         }
1523
1524         if (rc == -ENOENT)
1525                 rc = 0;
1526
1527         RETURN(rc);
1528 }
1529
1530 static int osd_initial_OI_scrub(struct osd_thread_info *info,
1531                                 struct osd_device *dev)
1532 {
1533         struct osd_ios_item *item    = NULL;
1534         scandir_t            scandir = osd_ios_general_scan;
1535         filldir_t            filldir = osd_ios_root_fill;
1536         struct dentry       *dentry  = osd_sb(dev)->s_root;
1537         int                  rc;
1538         ENTRY;
1539
1540         while (1) {
1541                 rc = scandir(info, dev, dentry, filldir);
1542                 if (item != NULL) {
1543                         dput(item->oii_dentry);
1544                         OBD_FREE_PTR(item);
1545                 }
1546
1547                 if (rc != 0)
1548                         break;
1549
1550                 if (cfs_list_empty(&dev->od_ios_list))
1551                         break;
1552
1553                 item = cfs_list_entry(dev->od_ios_list.next,
1554                                       struct osd_ios_item, oii_list);
1555                 cfs_list_del_init(&item->oii_list);
1556
1557                 LASSERT(item->oii_scandir != NULL);
1558                 scandir = item->oii_scandir;
1559                 filldir = item->oii_filldir;
1560                 dentry = item->oii_dentry;
1561         }
1562
1563         while (!cfs_list_empty(&dev->od_ios_list)) {
1564                 item = cfs_list_entry(dev->od_ios_list.next,
1565                                       struct osd_ios_item, oii_list);
1566                 cfs_list_del_init(&item->oii_list);
1567                 dput(item->oii_dentry);
1568                 OBD_FREE_PTR(item);
1569         }
1570
1571         RETURN(rc);
1572 }
1573
1574 char *osd_lf_fid2name(const struct lu_fid *fid)
1575 {
1576         const struct osd_lf_map *map = osd_lf_maps;
1577
1578         while (map->olm_name != NULL) {
1579                 if (!lu_fid_eq(fid, &map->olm_fid)) {
1580                         map++;
1581                         continue;
1582                 }
1583
1584                 if (map->olm_flags & OLF_SHOW_NAME)
1585                         return map->olm_name;
1586                 else
1587                         return "";
1588         }
1589
1590         return NULL;
1591 }
1592
1593 /* OI scrub start/stop */
1594
1595 static int do_osd_scrub_start(struct osd_device *dev, __u32 flags)
1596 {
1597         struct osd_scrub     *scrub  = &dev->od_scrub;
1598         struct ptlrpc_thread *thread = &scrub->os_thread;
1599         struct l_wait_info    lwi    = { 0 };
1600         int                   rc;
1601         ENTRY;
1602
1603 again:
1604         /* os_lock: sync status between stop and scrub thread */
1605         spin_lock(&scrub->os_lock);
1606         if (thread_is_running(thread)) {
1607                 spin_unlock(&scrub->os_lock);
1608                 RETURN(-EALREADY);
1609         } else if (unlikely(thread_is_stopping(thread))) {
1610                 spin_unlock(&scrub->os_lock);
1611                 l_wait_event(thread->t_ctl_waitq,
1612                              thread_is_stopped(thread),
1613                              &lwi);
1614                 goto again;
1615         }
1616         spin_unlock(&scrub->os_lock);
1617
1618         if (scrub->os_file.sf_status == SS_COMPLETED)
1619                 flags |= SS_RESET;
1620
1621         scrub->os_start_flags = flags;
1622         thread_set_flags(thread, 0);
1623         rc = cfs_create_thread(osd_scrub_main, dev, 0);
1624         if (rc < 0) {
1625                 CERROR("%.16s: cannot start iteration thread, rc = %d\n",
1626                        LDISKFS_SB(osd_sb(dev))->s_es->s_volume_name, rc);
1627                 RETURN(rc);
1628         }
1629
1630         l_wait_event(thread->t_ctl_waitq,
1631                      thread_is_running(thread) || thread_is_stopped(thread),
1632                      &lwi);
1633
1634         RETURN(0);
1635 }
1636
1637 int osd_scrub_start(struct osd_device *dev)
1638 {
1639         int rc;
1640         ENTRY;
1641
1642         /* od_otable_mutex: prevent curcurrent start/stop */
1643         mutex_lock(&dev->od_otable_mutex);
1644         rc = do_osd_scrub_start(dev, SS_AUTO);
1645         mutex_unlock(&dev->od_otable_mutex);
1646
1647         RETURN(rc == -EALREADY ? 0 : rc);
1648 }
1649
1650 static void do_osd_scrub_stop(struct osd_scrub *scrub)
1651 {
1652         struct ptlrpc_thread *thread = &scrub->os_thread;
1653         struct l_wait_info    lwi    = { 0 };
1654
1655         /* os_lock: sync status between stop and scrub thread */
1656         spin_lock(&scrub->os_lock);
1657         if (!thread_is_init(thread) && !thread_is_stopped(thread)) {
1658                 thread_set_flags(thread, SVC_STOPPING);
1659                 spin_unlock(&scrub->os_lock);
1660                 cfs_waitq_broadcast(&thread->t_ctl_waitq);
1661                 l_wait_event(thread->t_ctl_waitq,
1662                              thread_is_stopped(thread),
1663                              &lwi);
1664                 /* Do not skip the last lock/unlock, which can guarantee that
1665                  * the caller cannot return until the OI scrub thread exit. */
1666                 spin_lock(&scrub->os_lock);
1667         }
1668         spin_unlock(&scrub->os_lock);
1669 }
1670
1671 static void osd_scrub_stop(struct osd_device *dev)
1672 {
1673         /* od_otable_mutex: prevent curcurrent start/stop */
1674         mutex_lock(&dev->od_otable_mutex);
1675         dev->od_scrub.os_paused = 1;
1676         do_osd_scrub_stop(&dev->od_scrub);
1677         mutex_unlock(&dev->od_otable_mutex);
1678 }
1679
1680 /* OI scrub setup/cleanup */
1681
1682 static const char osd_scrub_name[] = "OI_scrub";
1683
1684 int osd_scrub_setup(const struct lu_env *env, struct osd_device *dev)
1685 {
1686         struct osd_thread_info     *info   = osd_oti_get(env);
1687         struct osd_scrub           *scrub  = &dev->od_scrub;
1688         struct lvfs_run_ctxt       *ctxt   = &scrub->os_ctxt;
1689         struct scrub_file          *sf     = &scrub->os_file;
1690         struct super_block         *sb     = osd_sb(dev);
1691         struct ldiskfs_super_block *es     = LDISKFS_SB(sb)->s_es;
1692         struct lvfs_run_ctxt        saved;
1693         struct file                *filp;
1694         int                         dirty  = 0;
1695         int                         rc     = 0;
1696         ENTRY;
1697
1698         memset(scrub, 0, sizeof(*scrub));
1699         OBD_SET_CTXT_MAGIC(ctxt);
1700         ctxt->pwdmnt = dev->od_mnt;
1701         ctxt->pwd = dev->od_mnt->mnt_root;
1702         ctxt->fs = get_ds();
1703
1704         cfs_waitq_init(&scrub->os_thread.t_ctl_waitq);
1705         init_rwsem(&scrub->os_rwsem);
1706         spin_lock_init(&scrub->os_lock);
1707         CFS_INIT_LIST_HEAD(&scrub->os_inconsistent_items);
1708
1709         push_ctxt(&saved, ctxt, NULL);
1710         filp = filp_open(osd_scrub_name, O_RDWR | O_CREAT, 0644);
1711         if (IS_ERR(filp))
1712                 RETURN(PTR_ERR(filp));
1713
1714         scrub->os_inode = igrab(filp->f_dentry->d_inode);
1715         filp_close(filp, 0);
1716         pop_ctxt(&saved, ctxt, NULL);
1717         ldiskfs_set_inode_state(scrub->os_inode,
1718                                 LDISKFS_STATE_LUSTRE_NO_OI);
1719
1720         rc = osd_scrub_file_load(scrub);
1721         if (rc == -ENOENT) {
1722                 osd_scrub_file_init(scrub, es->s_uuid);
1723                 dirty = 1;
1724         } else if (rc != 0) {
1725                 RETURN(rc);
1726         } else {
1727                 if (memcmp(sf->sf_uuid, es->s_uuid, 16) != 0) {
1728                         osd_scrub_file_reset(scrub, es->s_uuid,SF_INCONSISTENT);
1729                         dirty = 1;
1730                 } else if (sf->sf_status == SS_SCANNING) {
1731                         sf->sf_status = SS_CRASHED;
1732                         dirty = 1;
1733                 }
1734         }
1735
1736         if (sf->sf_pos_last_checkpoint != 0)
1737                 scrub->os_pos_current = sf->sf_pos_last_checkpoint + 1;
1738         else
1739                 scrub->os_pos_current = LDISKFS_FIRST_INO(sb) + 1;
1740
1741         if (dirty != 0) {
1742                 rc = osd_scrub_file_store(scrub);
1743                 if (rc != 0)
1744                         RETURN(rc);
1745         }
1746
1747         /* Initialize OI files. */
1748         rc = osd_oi_init(info, dev);
1749         if (rc < 0)
1750                 RETURN(rc);
1751
1752         rc = osd_initial_OI_scrub(info, dev);
1753         if (rc == 0) {
1754                 if ((sf->sf_flags & SF_UPGRADE) &&
1755                    !(sf->sf_flags & SF_INCONSISTENT))
1756                         /* The 'od_igif_inoi' will be set after the
1757                          * upgrading completed, needs NOT remount. */
1758                         dev->od_igif_inoi = 0;
1759                 else
1760                         /* The 'od_igif_inoi' will be set under the
1761                          * following cases:
1762                          * 1) new created system, or
1763                          * 2) restored from file-level backup, or
1764                          * 3) the upgrading completed.
1765                          *
1766                          * The 'od_igif_inoi' may be cleared by OI scrub
1767                          * later if found that the system is upgrading. */
1768                         dev->od_igif_inoi = 1;
1769
1770                 if (!dev->od_noscrub &&
1771                     ((sf->sf_status == SS_PAUSED) ||
1772                      (sf->sf_status == SS_CRASHED &&
1773                       sf->sf_flags & (SF_RECREATED | SF_INCONSISTENT |
1774                                       SF_UPGRADE | SF_AUTO)) ||
1775                      (sf->sf_status == SS_INIT &&
1776                       sf->sf_flags & (SF_RECREATED | SF_INCONSISTENT |
1777                                       SF_UPGRADE))))
1778                         rc = osd_scrub_start(dev);
1779         }
1780
1781         RETURN(rc);
1782 }
1783
1784 void osd_scrub_cleanup(const struct lu_env *env, struct osd_device *dev)
1785 {
1786         struct osd_scrub *scrub = &dev->od_scrub;
1787
1788         LASSERT(dev->od_otable_it == NULL);
1789
1790         if (scrub->os_inode != NULL) {
1791                 osd_scrub_stop(dev);
1792                 iput(scrub->os_inode);
1793                 scrub->os_inode = NULL;
1794         }
1795         if (dev->od_oi_table != NULL)
1796                 osd_oi_fini(osd_oti_get(env), dev);
1797 }
1798
1799 /* object table based iteration APIs */
1800
1801 static struct dt_it *osd_otable_it_init(const struct lu_env *env,
1802                                        struct dt_object *dt, __u32 attr,
1803                                        struct lustre_capa *capa)
1804 {
1805         enum dt_otable_it_flags flags = attr >> DT_OTABLE_IT_FLAGS_SHIFT;
1806         enum dt_otable_it_valid valid = attr & ~DT_OTABLE_IT_FLAGS_MASK;
1807         struct osd_device      *dev   = osd_dev(dt->do_lu.lo_dev);
1808         struct osd_scrub       *scrub = &dev->od_scrub;
1809         struct osd_otable_it   *it;
1810         __u32                   start = 0;
1811         int                     rc;
1812         ENTRY;
1813
1814         /* od_otable_mutex: prevent curcurrent init/fini */
1815         mutex_lock(&dev->od_otable_mutex);
1816         if (dev->od_otable_it != NULL)
1817                 GOTO(out, it = ERR_PTR(-EALREADY));
1818
1819         OBD_ALLOC_PTR(it);
1820         if (it == NULL)
1821                 GOTO(out, it = ERR_PTR(-ENOMEM));
1822
1823         dev->od_otable_it = it;
1824         it->ooi_dev = dev;
1825         it->ooi_pid = cfs_curproc_pid();
1826         it->ooi_cache.ooc_consumer_idx = -1;
1827         if (flags & DOIF_OUTUSED)
1828                 it->ooi_used_outside = 1;
1829
1830         if (flags & DOIF_RESET)
1831                 start |= SS_RESET;
1832
1833         if (valid & DOIV_ERROR_HANDLE) {
1834                 if (flags & DOIF_FAILOUT)
1835                         start |= SS_SET_FAILOUT;
1836                 else
1837                         start |= SS_CLEAR_FAILOUT;
1838         }
1839
1840         rc = do_osd_scrub_start(dev, start);
1841         if (rc < 0 && rc != -EALREADY) {
1842                 dev->od_otable_it = NULL;
1843                 OBD_FREE_PTR(it);
1844                 GOTO(out, it = ERR_PTR(rc));
1845         }
1846
1847         it->ooi_cache.ooc_pos_preload = scrub->os_pos_current;
1848
1849         GOTO(out, it);
1850
1851 out:
1852         mutex_unlock(&dev->od_otable_mutex);
1853         return (struct dt_it *)it;
1854 }
1855
1856 static void osd_otable_it_fini(const struct lu_env *env, struct dt_it *di)
1857 {
1858         struct osd_otable_it *it  = (struct osd_otable_it *)di;
1859         struct osd_device    *dev = it->ooi_dev;
1860
1861         /* od_otable_mutex: prevent curcurrent init/fini */
1862         mutex_lock(&dev->od_otable_mutex);
1863         do_osd_scrub_stop(&dev->od_scrub);
1864         LASSERT(dev->od_otable_it == it);
1865
1866         dev->od_otable_it = NULL;
1867         mutex_unlock(&dev->od_otable_mutex);
1868         OBD_FREE_PTR(it);
1869 }
1870
1871 static int osd_otable_it_get(const struct lu_env *env,
1872                              struct dt_it *di, const struct dt_key *key)
1873 {
1874         return 0;
1875 }
1876
1877 /**
1878  * It is hack here:
1879  *
1880  * Sometimes the otable-based iteration driver (LFSCK) may be blocked in OSD
1881  * layer when someone wants to stop/pause the iteration. Under such case, we
1882  * need some mechanism to notify the event and wakeup the blocker.
1883  */
1884 static void osd_otable_it_put(const struct lu_env *env, struct dt_it *di)
1885 {
1886         struct osd_otable_it *it  = (struct osd_otable_it *)di;
1887         struct osd_device    *dev = it->ooi_dev;
1888
1889         /* od_otable_mutex: prevent curcurrent init/fini */
1890         mutex_lock(&dev->od_otable_mutex);
1891         if (it->ooi_pid == cfs_curproc_pid()) {
1892                 dev->od_scrub.os_paused = 1;
1893         } else {
1894                 struct ptlrpc_thread *thread = &dev->od_scrub.os_thread;
1895
1896                 it->ooi_stopping = 1;
1897                 if (it->ooi_waiting)
1898                         cfs_waitq_broadcast(&thread->t_ctl_waitq);
1899         }
1900         mutex_unlock(&dev->od_otable_mutex);
1901 }
1902
1903 static inline int
1904 osd_otable_it_wakeup(struct osd_scrub *scrub, struct osd_otable_it *it)
1905 {
1906         spin_lock(&scrub->os_lock);
1907         if (it->ooi_cache.ooc_pos_preload < scrub->os_pos_current ||
1908             scrub->os_waiting || it->ooi_stopping ||
1909             !thread_is_running(&scrub->os_thread))
1910                 it->ooi_waiting = 0;
1911         else
1912                 it->ooi_waiting = 1;
1913         spin_unlock(&scrub->os_lock);
1914
1915         return !it->ooi_waiting;
1916 }
1917
1918 static int osd_otable_it_next(const struct lu_env *env, struct dt_it *di)
1919 {
1920         struct osd_otable_it    *it     = (struct osd_otable_it *)di;
1921         struct osd_device       *dev    = it->ooi_dev;
1922         struct osd_scrub        *scrub  = &dev->od_scrub;
1923         struct osd_otable_cache *ooc    = &it->ooi_cache;
1924         struct ptlrpc_thread    *thread = &scrub->os_thread;
1925         struct l_wait_info       lwi    = { 0 };
1926         int                      rc;
1927         ENTRY;
1928
1929         LASSERT(it->ooi_user_ready);
1930
1931 again:
1932         if (!thread_is_running(thread) && !it->ooi_used_outside)
1933                 RETURN(1);
1934
1935         if (ooc->ooc_cached_items > 0) {
1936                 ooc->ooc_cached_items--;
1937                 ooc->ooc_consumer_idx = (ooc->ooc_consumer_idx + 1) &
1938                                         ~OSD_OTABLE_IT_CACHE_MASK;
1939                 RETURN(0);
1940         }
1941
1942         if (it->ooi_all_cached) {
1943                 l_wait_event(thread->t_ctl_waitq,
1944                              !thread_is_running(thread),
1945                              &lwi);
1946                 RETURN(1);
1947         }
1948
1949         if (scrub->os_waiting && osd_scrub_has_window(scrub, ooc)) {
1950                 spin_lock(&scrub->os_lock);
1951                 scrub->os_waiting = 0;
1952                 cfs_waitq_broadcast(&scrub->os_thread.t_ctl_waitq);
1953                 spin_unlock(&scrub->os_lock);
1954         }
1955
1956         if (it->ooi_cache.ooc_pos_preload >= scrub->os_pos_current)
1957                 l_wait_event(thread->t_ctl_waitq,
1958                              osd_otable_it_wakeup(scrub, it),
1959                              &lwi);
1960
1961         if (!thread_is_running(thread) && !it->ooi_used_outside)
1962                 RETURN(1);
1963
1964         if (it->ooi_stopping)
1965                 RETURN(0);
1966
1967         rc = osd_otable_it_preload(env, it);
1968         if (rc >= 0)
1969                 goto again;
1970
1971         RETURN(rc);
1972 }
1973
1974 static struct dt_key *osd_otable_it_key(const struct lu_env *env,
1975                                         const struct dt_it *di)
1976 {
1977         return NULL;
1978 }
1979
1980 static int osd_otable_it_key_size(const struct lu_env *env,
1981                                   const struct dt_it *di)
1982 {
1983         return sizeof(__u64);
1984 }
1985
1986 static int osd_otable_it_rec(const struct lu_env *env, const struct dt_it *di,
1987                              struct dt_rec *rec, __u32 attr)
1988 {
1989         struct osd_otable_it    *it  = (struct osd_otable_it *)di;
1990         struct osd_otable_cache *ooc = &it->ooi_cache;
1991
1992         *(struct lu_fid *)rec = ooc->ooc_cache[ooc->ooc_consumer_idx].oic_fid;
1993
1994         /* Filter out Invald FID already. */
1995         LASSERTF(fid_is_sane((struct lu_fid *)rec),
1996                  "Invalid FID "DFID", p_idx = %d, c_idx = %d\n",
1997                  PFID((struct lu_fid *)rec),
1998                  ooc->ooc_producer_idx, ooc->ooc_consumer_idx);
1999
2000         return 0;
2001 }
2002
2003 static __u64 osd_otable_it_store(const struct lu_env *env,
2004                                  const struct dt_it *di)
2005 {
2006         struct osd_otable_it    *it  = (struct osd_otable_it *)di;
2007         struct osd_otable_cache *ooc = &it->ooi_cache;
2008         __u64                    hash;
2009
2010         if (it->ooi_user_ready && ooc->ooc_consumer_idx != -1)
2011                 hash = ooc->ooc_cache[ooc->ooc_consumer_idx].oic_lid.oii_ino;
2012         else
2013                 hash = ooc->ooc_pos_preload;
2014         return hash;
2015 }
2016
2017 /**
2018  * Set the OSD layer iteration start position as the specified hash.
2019  */
2020 static int osd_otable_it_load(const struct lu_env *env,
2021                               const struct dt_it *di, __u64 hash)
2022 {
2023         struct osd_otable_it    *it    = (struct osd_otable_it *)di;
2024         struct osd_device       *dev   = it->ooi_dev;
2025         struct osd_otable_cache *ooc   = &it->ooi_cache;
2026         struct osd_scrub        *scrub = &dev->od_scrub;
2027         int                      rc;
2028         ENTRY;
2029
2030         /* Forbid to set iteration position after iteration started. */
2031         if (it->ooi_user_ready)
2032                 RETURN(-EPERM);
2033
2034         if (hash > OSD_OTABLE_MAX_HASH)
2035                 hash = OSD_OTABLE_MAX_HASH;
2036
2037         ooc->ooc_pos_preload = hash;
2038         if (ooc->ooc_pos_preload <= LDISKFS_FIRST_INO(osd_sb(dev)))
2039                 ooc->ooc_pos_preload = LDISKFS_FIRST_INO(osd_sb(dev)) + 1;
2040
2041         it->ooi_user_ready = 1;
2042         if (!scrub->os_full_speed)
2043                 cfs_waitq_broadcast(&scrub->os_thread.t_ctl_waitq);
2044
2045         /* Unplug OSD layer iteration by the first next() call. */
2046         rc = osd_otable_it_next(env, (struct dt_it *)it);
2047
2048         RETURN(rc);
2049 }
2050
2051 static int osd_otable_it_key_rec(const struct lu_env *env,
2052                                  const struct dt_it *di, void *key_rec)
2053 {
2054         return 0;
2055 }
2056
2057 const struct dt_index_operations osd_otable_ops = {
2058         .dio_it = {
2059                 .init     = osd_otable_it_init,
2060                 .fini     = osd_otable_it_fini,
2061                 .get      = osd_otable_it_get,
2062                 .put      = osd_otable_it_put,
2063                 .next     = osd_otable_it_next,
2064                 .key      = osd_otable_it_key,
2065                 .key_size = osd_otable_it_key_size,
2066                 .rec      = osd_otable_it_rec,
2067                 .store    = osd_otable_it_store,
2068                 .load     = osd_otable_it_load,
2069                 .key_rec  = osd_otable_it_key_rec,
2070         }
2071 };
2072
2073 /* high priority inconsistent items list APIs */
2074
2075 int osd_oii_insert(struct osd_device *dev, struct osd_idmap_cache *oic,
2076                    int insert)
2077 {
2078         struct osd_inconsistent_item *oii;
2079         struct osd_scrub             *scrub  = &dev->od_scrub;
2080         struct ptlrpc_thread         *thread = &scrub->os_thread;
2081         int                           wakeup = 0;
2082         ENTRY;
2083
2084         OBD_ALLOC_PTR(oii);
2085         if (unlikely(oii == NULL))
2086                 RETURN(-ENOMEM);
2087
2088         CFS_INIT_LIST_HEAD(&oii->oii_list);
2089         oii->oii_cache = *oic;
2090         oii->oii_insert = insert;
2091
2092         spin_lock(&scrub->os_lock);
2093         if (unlikely(!thread_is_running(thread))) {
2094                 spin_unlock(&scrub->os_lock);
2095                 OBD_FREE_PTR(oii);
2096                 RETURN(-EAGAIN);
2097         }
2098
2099         if (cfs_list_empty(&scrub->os_inconsistent_items))
2100                 wakeup = 1;
2101         cfs_list_add_tail(&oii->oii_list, &scrub->os_inconsistent_items);
2102         spin_unlock(&scrub->os_lock);
2103
2104         if (wakeup != 0)
2105                 cfs_waitq_broadcast(&thread->t_ctl_waitq);
2106
2107         RETURN(0);
2108 }
2109
2110 int osd_oii_lookup(struct osd_device *dev, const struct lu_fid *fid,
2111                    struct osd_inode_id *id)
2112 {
2113         struct osd_scrub             *scrub = &dev->od_scrub;
2114         struct osd_inconsistent_item *oii;
2115         ENTRY;
2116
2117         spin_lock(&scrub->os_lock);
2118         cfs_list_for_each_entry(oii, &scrub->os_inconsistent_items, oii_list) {
2119                 if (lu_fid_eq(fid, &oii->oii_cache.oic_fid)) {
2120                         *id = oii->oii_cache.oic_lid;
2121                         spin_unlock(&scrub->os_lock);
2122                         RETURN(0);
2123                 }
2124         }
2125         spin_unlock(&scrub->os_lock);
2126
2127         RETURN(-ENOENT);
2128 }
2129
2130 /* OI scrub dump */
2131
2132 static const char *scrub_status_names[] = {
2133         "init",
2134         "scanning",
2135         "completed",
2136         "failed",
2137         "stopped",
2138         "paused",
2139         "crashed",
2140         NULL
2141 };
2142
2143 static const char *scrub_flags_names[] = {
2144         "recreated",
2145         "inconsistent",
2146         "auto",
2147         "upgrade",
2148         NULL
2149 };
2150
2151 static const char *scrub_param_names[] = {
2152         "failout",
2153         NULL
2154 };
2155
2156 static int scrub_bits_dump(char **buf, int *len, int bits, const char *names[],
2157                            const char *prefix)
2158 {
2159         int save = *len;
2160         int flag;
2161         int rc;
2162         int i;
2163
2164         rc = snprintf(*buf, *len, "%s:%c", prefix, bits != 0 ? ' ' : '\n');
2165         if (rc <= 0)
2166                 return -ENOSPC;
2167
2168         *buf += rc;
2169         *len -= rc;
2170         for (i = 0, flag = 1; bits != 0; i++, flag = 1 << i) {
2171                 if (flag & bits) {
2172                         bits &= ~flag;
2173                         rc = snprintf(*buf, *len, "%s%c", names[i],
2174                                       bits != 0 ? ',' : '\n');
2175                         if (rc <= 0)
2176                                 return -ENOSPC;
2177
2178                         *buf += rc;
2179                         *len -= rc;
2180                 }
2181         }
2182         return save - *len;
2183 }
2184
2185 static int scrub_time_dump(char **buf, int *len, __u64 time, const char *prefix)
2186 {
2187         int rc;
2188
2189         if (time != 0)
2190                 rc = snprintf(*buf, *len, "%s: "LPU64" seconds\n", prefix,
2191                               cfs_time_current_sec() - time);
2192         else
2193                 rc = snprintf(*buf, *len, "%s: N/A\n", prefix);
2194         if (rc <= 0)
2195                 return -ENOSPC;
2196
2197         *buf += rc;
2198         *len -= rc;
2199         return rc;
2200 }
2201
2202 static int scrub_pos_dump(char **buf, int *len, __u64 pos, const char *prefix)
2203 {
2204         int rc;
2205
2206         if (pos != 0)
2207                 rc = snprintf(*buf, *len, "%s: "LPU64"\n", prefix, pos);
2208         else
2209                 rc = snprintf(*buf, *len, "%s: N/A\n", prefix);
2210         if (rc <= 0)
2211                 return -ENOSPC;
2212
2213         *buf += rc;
2214         *len -= rc;
2215         return rc;
2216 }
2217
2218 int osd_scrub_dump(struct osd_device *dev, char *buf, int len)
2219 {
2220         struct osd_scrub  *scrub   = &dev->od_scrub;
2221         struct scrub_file *sf      = &scrub->os_file;
2222         __u64              checked;
2223         __u64              speed;
2224         int                save    = len;
2225         int                ret     = -ENOSPC;
2226         int                rc;
2227
2228         down_read(&scrub->os_rwsem);
2229         rc = snprintf(buf, len,
2230                       "name: OI_scrub\n"
2231                       "magic: 0x%x\n"
2232                       "oi_files: %d\n"
2233                       "status: %s\n",
2234                       sf->sf_magic, (int)sf->sf_oi_count,
2235                       scrub_status_names[sf->sf_status]);
2236         if (rc <= 0)
2237                 goto out;
2238
2239         buf += rc;
2240         len -= rc;
2241         rc = scrub_bits_dump(&buf, &len, sf->sf_flags, scrub_flags_names,
2242                              "flags");
2243         if (rc < 0)
2244                 goto out;
2245
2246         rc = scrub_bits_dump(&buf, &len, sf->sf_param, scrub_param_names,
2247                              "param");
2248         if (rc < 0)
2249                 goto out;
2250
2251         rc = scrub_time_dump(&buf, &len, sf->sf_time_last_complete,
2252                              "time_since_last_completed");
2253         if (rc < 0)
2254                 goto out;
2255
2256         rc = scrub_time_dump(&buf, &len, sf->sf_time_latest_start,
2257                              "time_since_latest_start");
2258         if (rc < 0)
2259                 goto out;
2260
2261         rc = scrub_time_dump(&buf, &len, sf->sf_time_last_checkpoint,
2262                              "time_since_last_checkpoint");
2263         if (rc < 0)
2264                 goto out;
2265
2266         rc = scrub_pos_dump(&buf, &len, sf->sf_pos_latest_start,
2267                             "latest_start_position");
2268         if (rc < 0)
2269                 goto out;
2270
2271         rc = scrub_pos_dump(&buf, &len, sf->sf_pos_last_checkpoint,
2272                             "last_checkpoint_position");
2273         if (rc < 0)
2274                 goto out;
2275
2276         rc = scrub_pos_dump(&buf, &len, sf->sf_pos_first_inconsistent,
2277                             "first_failure_position");
2278         if (rc < 0)
2279                 goto out;
2280
2281         checked = sf->sf_items_checked + scrub->os_new_checked;
2282         rc = snprintf(buf, len,
2283                       "checked: "LPU64"\n"
2284                       "updated: "LPU64"\n"
2285                       "failed: "LPU64"\n"
2286                       "prior_updated: "LPU64"\n"
2287                       "noscrub: "LPU64"\n"
2288                       "igif: "LPU64"\n"
2289                       "success_count: %u\n",
2290                       checked, sf->sf_items_updated, sf->sf_items_failed,
2291                       sf->sf_items_updated_prior, sf->sf_items_noscrub,
2292                       sf->sf_items_igif, sf->sf_success_count);
2293         if (rc <= 0)
2294                 goto out;
2295
2296         buf += rc;
2297         len -= rc;
2298         speed = checked;
2299         if (thread_is_running(&scrub->os_thread)) {
2300                 cfs_duration_t duration = cfs_time_current() -
2301                                           scrub->os_time_last_checkpoint;
2302                 __u64 new_checked = scrub->os_new_checked * CFS_HZ;
2303                 __u32 rtime = sf->sf_run_time +
2304                               cfs_duration_sec(duration + HALF_SEC);
2305
2306                 if (duration != 0)
2307                         do_div(new_checked, duration);
2308                 if (rtime != 0)
2309                         do_div(speed, rtime);
2310                 rc = snprintf(buf, len,
2311                               "run_time: %u seconds\n"
2312                               "average_speed: "LPU64" objects/sec\n"
2313                               "real-time_speed: "LPU64" objects/sec\n"
2314                               "current_position: %u\n",
2315                               rtime, speed, new_checked, scrub->os_pos_current);
2316         } else {
2317                 if (sf->sf_run_time != 0)
2318                         do_div(speed, sf->sf_run_time);
2319                 rc = snprintf(buf, len,
2320                               "run_time: %u seconds\n"
2321                               "average_speed: "LPU64" objects/sec\n"
2322                               "real-time_speed: N/A\n"
2323                               "current_position: N/A\n",
2324                               sf->sf_run_time, speed);
2325         }
2326         if (rc <= 0)
2327                 goto out;
2328
2329         buf += rc;
2330         len -= rc;
2331         ret = save - len;
2332
2333 out:
2334         up_read(&scrub->os_rwsem);
2335         return ret;
2336 }