Whamcloud - gitweb
LU-1996 lustre: Flexible changelog format.
[fs/lustre-release.git] / lustre / mdd / mdd_device.c
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 only,
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License version 2 for more details (a copy is included
14  * in the LICENSE file that accompanied this code).
15  *
16  * You should have received a copy of the GNU General Public License
17  * version 2 along with this program; If not, see
18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
19  *
20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21  * CA 95054 USA or visit www.sun.com if you need additional information or
22  * have any questions.
23  *
24  * GPL HEADER END
25  */
26 /*
27  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2011, 2013, Intel Corporation.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  *
36  * lustre/mdd/mdd_device.c
37  *
38  * Lustre Metadata Server (mdd) routines
39  *
40  * Author: Wang Di <wangdi@clusterfs.com>
41  */
42
43 #define DEBUG_SUBSYSTEM S_MDS
44
45 #include <linux/module.h>
46 #include <obd_class.h>
47 #include <lustre_ioctl.h>
48 #include <lustre_mds.h>
49 #include <obd_support.h>
50 #include <lu_object.h>
51 #include <lustre_param.h>
52 #include <lustre_fid.h>
53
54 #include "mdd_internal.h"
55
56 static const struct md_device_operations mdd_ops;
57 static struct lu_device_type mdd_device_type;
58
59 static const char mdd_root_dir_name[] = "ROOT";
60 static const char mdd_obf_dir_name[] = "fid";
61 static const char mdd_lpf_dir_name[] = "lost+found";
62
63 /* Slab for MDD object allocation */
64 struct kmem_cache *mdd_object_kmem;
65
66 static struct lu_kmem_descr mdd_caches[] = {
67         {
68                 .ckd_cache = &mdd_object_kmem,
69                 .ckd_name  = "mdd_obj",
70                 .ckd_size  = sizeof(struct mdd_object)
71         },
72         {
73                 .ckd_cache = NULL
74         }
75 };
76
77 static int mdd_connect_to_next(const struct lu_env *env, struct mdd_device *m,
78                                const char *nextdev)
79 {
80         struct obd_connect_data *data = NULL;
81         struct lu_device        *lud = mdd2lu_dev(m);
82         struct obd_device       *obd;
83         int                      rc;
84         ENTRY;
85
86         LASSERT(m->mdd_child_exp == NULL);
87
88         OBD_ALLOC(data, sizeof(*data));
89         if (data == NULL)
90                 GOTO(out, rc = -ENOMEM);
91
92         obd = class_name2obd(nextdev);
93         if (obd == NULL) {
94                 CERROR("can't locate next device: %s\n", nextdev);
95                 GOTO(out, rc = -ENOTCONN);
96         }
97
98         data->ocd_connect_flags = OBD_CONNECT_VERSION;
99         data->ocd_version = LUSTRE_VERSION_CODE;
100
101         rc = obd_connect(NULL, &m->mdd_child_exp, obd, &obd->obd_uuid, data, NULL);
102         if (rc) {
103                 CERROR("cannot connect to next dev %s (%d)\n", nextdev, rc);
104                 GOTO(out, rc);
105         }
106
107         lud->ld_site = m->mdd_child_exp->exp_obd->obd_lu_dev->ld_site;
108         LASSERT(lud->ld_site);
109         m->mdd_child = lu2dt_dev(m->mdd_child_exp->exp_obd->obd_lu_dev);
110         m->mdd_bottom = lu2dt_dev(lud->ld_site->ls_bottom_dev);
111         lu_dev_add_linkage(lud->ld_site, lud);
112
113 out:
114         if (data)
115                 OBD_FREE(data, sizeof(*data));
116         RETURN(rc);
117 }
118
119 static int mdd_init0(const struct lu_env *env, struct mdd_device *mdd,
120                 struct lu_device_type *t, struct lustre_cfg *lcfg)
121 {
122         int rc;
123         ENTRY;
124
125         mdd->mdd_md_dev.md_lu_dev.ld_ops = &mdd_lu_ops;
126         mdd->mdd_md_dev.md_ops = &mdd_ops;
127
128         rc = mdd_connect_to_next(env, mdd, lustre_cfg_string(lcfg, 3));
129         if (rc)
130                 RETURN(rc);
131
132         mdd->mdd_atime_diff = MAX_ATIME_DIFF;
133         /* sync permission changes */
134         mdd->mdd_sync_permission = 1;
135
136         dt_conf_get(env, mdd->mdd_child, &mdd->mdd_dt_conf);
137
138         /* we are using service name but not mdd obd name
139          * for compatibility reasons.
140          * It is passed from MDT in lustre_cfg[2] buffer */
141         rc = mdd_procfs_init(mdd, lustre_cfg_string(lcfg, 2));
142         if (rc < 0)
143                 obd_disconnect(mdd->mdd_child_exp);
144
145         RETURN(rc);
146 }
147
148 static struct lu_device *mdd_device_fini(const struct lu_env *env,
149                                          struct lu_device *d)
150 {
151         struct mdd_device *mdd = lu2mdd_dev(d);
152
153         if (d->ld_site)
154                 lu_dev_del_linkage(d->ld_site, d);
155
156         mdd_procfs_fini(mdd);
157         return NULL;
158 }
159
160 static int changelog_init_cb(const struct lu_env *env, struct llog_handle *llh,
161                              struct llog_rec_hdr *hdr, void *data)
162 {
163         struct mdd_device *mdd = (struct mdd_device *)data;
164         struct llog_changelog_rec *rec = (struct llog_changelog_rec *)hdr;
165
166         LASSERT(llh->lgh_hdr->llh_flags & LLOG_F_IS_PLAIN);
167         LASSERT(rec->cr_hdr.lrh_type == CHANGELOG_REC);
168
169         CDEBUG(D_INFO,
170                "seeing record at index %d/%d/"LPU64" t=%x %.*s in log"
171                DOSTID"\n", hdr->lrh_index, rec->cr_hdr.lrh_index,
172                rec->cr.cr_index, rec->cr.cr_type, rec->cr.cr_namelen,
173                changelog_rec_name(&rec->cr), POSTID(&llh->lgh_id.lgl_oi));
174
175         mdd->mdd_cl.mc_index = rec->cr.cr_index;
176         return LLOG_PROC_BREAK;
177 }
178
179 static int changelog_user_init_cb(const struct lu_env *env,
180                                   struct llog_handle *llh,
181                                   struct llog_rec_hdr *hdr, void *data)
182 {
183         struct mdd_device *mdd = (struct mdd_device *)data;
184         struct llog_changelog_user_rec *rec =
185                 (struct llog_changelog_user_rec *)hdr;
186
187         LASSERT(llh->lgh_hdr->llh_flags & LLOG_F_IS_PLAIN);
188         LASSERT(rec->cur_hdr.lrh_type == CHANGELOG_USER_REC);
189
190         CDEBUG(D_INFO, "seeing user at index %d/%d id=%d endrec="LPU64
191                " in log "DOSTID"\n", hdr->lrh_index, rec->cur_hdr.lrh_index,
192                rec->cur_id, rec->cur_endrec, POSTID(&llh->lgh_id.lgl_oi));
193
194         spin_lock(&mdd->mdd_cl.mc_user_lock);
195         mdd->mdd_cl.mc_lastuser = rec->cur_id;
196         if (rec->cur_endrec > mdd->mdd_cl.mc_index)
197                 mdd->mdd_cl.mc_index = rec->cur_endrec;
198         spin_unlock(&mdd->mdd_cl.mc_user_lock);
199
200         return LLOG_PROC_BREAK;
201 }
202
203 static int llog_changelog_cancel_cb(const struct lu_env *env,
204                                     struct llog_handle *llh,
205                                     struct llog_rec_hdr *hdr, void *data)
206 {
207         struct llog_changelog_rec *rec = (struct llog_changelog_rec *)hdr;
208         struct llog_cookie       cookie;
209         long long                endrec = *(long long *)data;
210         int                      rc;
211
212         ENTRY;
213
214         /* This is always a (sub)log, not the catalog */
215         LASSERT(llh->lgh_hdr->llh_flags & LLOG_F_IS_PLAIN);
216
217         if (rec->cr.cr_index > endrec)
218                 /* records are in order, so we're done */
219                 RETURN(LLOG_PROC_BREAK);
220
221         cookie.lgc_lgl = llh->lgh_id;
222         cookie.lgc_index = hdr->lrh_index;
223
224         /* cancel them one at a time.  I suppose we could store up the cookies
225          * and cancel them all at once; probably more efficient, but this is
226          * done as a user call, so who cares... */
227         rc = llog_cat_cancel_records(env, llh->u.phd.phd_cat_handle, 1,
228                                      &cookie);
229         RETURN(rc < 0 ? rc : 0);
230 }
231
232 static int llog_changelog_cancel(const struct lu_env *env,
233                                  struct llog_ctxt *ctxt,
234                                  struct llog_cookie *cookies, int flags)
235 {
236         struct llog_handle      *cathandle = ctxt->loc_handle;
237         int                      rc;
238
239         ENTRY;
240
241         /* This should only be called with the catalog handle */
242         LASSERT(cathandle->lgh_hdr->llh_flags & LLOG_F_IS_CAT);
243
244         rc = llog_cat_process(env, cathandle, llog_changelog_cancel_cb,
245                               (void *)cookies, 0, 0);
246         if (rc >= 0)
247                 /* 0 or 1 means we're done */
248                 rc = 0;
249         else
250                 CERROR("%s: cancel idx %u of catalog "DOSTID" rc=%d\n",
251                        ctxt->loc_obd->obd_name, cathandle->lgh_last_idx,
252                        POSTID(&cathandle->lgh_id.lgl_oi), rc);
253
254         RETURN(rc);
255 }
256
257 static struct llog_operations changelog_orig_logops;
258
259 static int
260 mdd_changelog_on(const struct lu_env *env, struct mdd_device *mdd, int on);
261
262 static int mdd_changelog_llog_init(const struct lu_env *env,
263                                    struct mdd_device *mdd)
264 {
265         struct obd_device       *obd = mdd2obd_dev(mdd);
266         struct llog_ctxt        *ctxt = NULL, *uctxt = NULL;
267         int                      rc;
268
269         ENTRY;
270
271         /* LU-2844 mdd setup failure should not cause umount oops */
272         if (OBD_FAIL_CHECK(OBD_FAIL_MDS_CHANGELOG_INIT))
273                 RETURN(-EIO);
274
275         OBD_SET_CTXT_MAGIC(&obd->obd_lvfs_ctxt);
276         obd->obd_lvfs_ctxt.dt = mdd->mdd_bottom;
277         rc = llog_setup(env, obd, &obd->obd_olg, LLOG_CHANGELOG_ORIG_CTXT,
278                         obd, &changelog_orig_logops);
279         if (rc) {
280                 CERROR("%s: changelog llog setup failed: rc = %d\n",
281                        obd->obd_name, rc);
282                 RETURN(rc);
283         }
284
285         ctxt = llog_get_context(obd, LLOG_CHANGELOG_ORIG_CTXT);
286         LASSERT(ctxt);
287
288         rc = llog_open_create(env, ctxt, &ctxt->loc_handle, NULL,
289                               CHANGELOG_CATALOG);
290         if (rc)
291                 GOTO(out_cleanup, rc);
292
293         rc = llog_cat_init_and_process(env, ctxt->loc_handle);
294         if (rc)
295                 GOTO(out_close, rc);
296
297         rc = llog_cat_reverse_process(env, ctxt->loc_handle,
298                                       changelog_init_cb, mdd);
299
300         if (rc < 0) {
301                 CERROR("%s: changelog init failed: rc = %d\n", obd->obd_name,
302                        rc);
303                 GOTO(out_close, rc);
304         }
305
306         CDEBUG(D_IOCTL, "changelog starting index="LPU64"\n",
307                mdd->mdd_cl.mc_index);
308
309         /* setup user changelog */
310         rc = llog_setup(env, obd, &obd->obd_olg, LLOG_CHANGELOG_USER_ORIG_CTXT,
311                         obd, &changelog_orig_logops);
312         if (rc) {
313                 CERROR("%s: changelog users llog setup failed: rc = %d\n",
314                        obd->obd_name, rc);
315                 GOTO(out_close, rc);
316         }
317
318         uctxt = llog_get_context(obd, LLOG_CHANGELOG_USER_ORIG_CTXT);
319         LASSERT(ctxt);
320
321         rc = llog_open_create(env, uctxt, &uctxt->loc_handle, NULL,
322                               CHANGELOG_USERS);
323         if (rc)
324                 GOTO(out_ucleanup, rc);
325
326         uctxt->loc_handle->lgh_logops->lop_add = llog_cat_add_rec;
327         uctxt->loc_handle->lgh_logops->lop_declare_add = llog_cat_declare_add_rec;
328
329         rc = llog_cat_init_and_process(env, uctxt->loc_handle);
330         if (rc)
331                 GOTO(out_uclose, rc);
332
333         rc = llog_cat_reverse_process(env, uctxt->loc_handle,
334                                       changelog_user_init_cb, mdd);
335         if (rc < 0) {
336                 CERROR("%s: changelog user init failed: rc = %d\n",
337                        obd->obd_name, rc);
338                 GOTO(out_uclose, rc);
339         }
340
341         /* If we have registered users, assume we want changelogs on */
342         if (mdd->mdd_cl.mc_lastuser > 0) {
343                 rc = mdd_changelog_on(env, mdd, 1);
344                 if (rc < 0)
345                         GOTO(out_uclose, rc);
346         }
347         llog_ctxt_put(ctxt);
348         llog_ctxt_put(uctxt);
349         RETURN(0);
350 out_uclose:
351         llog_cat_close(env, uctxt->loc_handle);
352 out_ucleanup:
353         llog_cleanup(env, uctxt);
354 out_close:
355         llog_cat_close(env, ctxt->loc_handle);
356 out_cleanup:
357         llog_cleanup(env, ctxt);
358         return rc;
359 }
360
361 static int mdd_changelog_init(const struct lu_env *env, struct mdd_device *mdd)
362 {
363         struct obd_device       *obd = mdd2obd_dev(mdd);
364         int                      rc;
365
366         mdd->mdd_cl.mc_index = 0;
367         spin_lock_init(&mdd->mdd_cl.mc_lock);
368         mdd->mdd_cl.mc_starttime = cfs_time_current_64();
369         mdd->mdd_cl.mc_flags = 0; /* off by default */
370         mdd->mdd_cl.mc_mask = CHANGELOG_DEFMASK;
371         spin_lock_init(&mdd->mdd_cl.mc_user_lock);
372         mdd->mdd_cl.mc_lastuser = 0;
373
374         rc = mdd_changelog_llog_init(env, mdd);
375         if (rc) {
376                 CERROR("%s: changelog setup during init failed: rc = %d\n",
377                        obd->obd_name, rc);
378                 mdd->mdd_cl.mc_flags |= CLM_ERR;
379         }
380
381         return rc;
382 }
383
384 static void mdd_changelog_fini(const struct lu_env *env,
385                                struct mdd_device *mdd)
386 {
387         struct obd_device       *obd = mdd2obd_dev(mdd);
388         struct llog_ctxt        *ctxt;
389
390         mdd->mdd_cl.mc_flags = 0;
391
392         ctxt = llog_get_context(obd, LLOG_CHANGELOG_ORIG_CTXT);
393         if (ctxt) {
394                 llog_cat_close(env, ctxt->loc_handle);
395                 llog_cleanup(env, ctxt);
396         }
397         ctxt = llog_get_context(obd, LLOG_CHANGELOG_USER_ORIG_CTXT);
398         if (ctxt) {
399                 llog_cat_close(env, ctxt->loc_handle);
400                 llog_cleanup(env, ctxt);
401         }
402 }
403
404 static int
405 mdd_changelog_write_header(const struct lu_env *env, struct mdd_device *mdd,
406                            int markerflags);
407
408 /* Start / stop recording */
409 static int
410 mdd_changelog_on(const struct lu_env *env, struct mdd_device *mdd, int on)
411 {
412         int rc = 0;
413
414         if ((on == 1) && ((mdd->mdd_cl.mc_flags & CLM_ON) == 0)) {
415                 LCONSOLE_INFO("%s: changelog on\n", mdd2obd_dev(mdd)->obd_name);
416                 if (mdd->mdd_cl.mc_flags & CLM_ERR) {
417                         CERROR("Changelogs cannot be enabled due to error "
418                                "condition (see %s log).\n",
419                                mdd2obd_dev(mdd)->obd_name);
420                         rc = -ESRCH;
421                 } else {
422                         spin_lock(&mdd->mdd_cl.mc_lock);
423                         mdd->mdd_cl.mc_flags |= CLM_ON;
424                         spin_unlock(&mdd->mdd_cl.mc_lock);
425                         rc = mdd_changelog_write_header(env, mdd, CLM_START);
426                 }
427         } else if ((on == 0) && ((mdd->mdd_cl.mc_flags & CLM_ON) == CLM_ON)) {
428                 LCONSOLE_INFO("%s: changelog off\n",mdd2obd_dev(mdd)->obd_name);
429                 rc = mdd_changelog_write_header(env, mdd, CLM_FINI);
430                 spin_lock(&mdd->mdd_cl.mc_lock);
431                 mdd->mdd_cl.mc_flags &= ~CLM_ON;
432                 spin_unlock(&mdd->mdd_cl.mc_lock);
433         }
434         return rc;
435 }
436
437 /** Remove entries with indicies up to and including \a endrec from the
438  *  changelog
439  * \param mdd
440  * \param endrec
441  * \retval 0 ok
442  */
443 static int
444 mdd_changelog_llog_cancel(const struct lu_env *env, struct mdd_device *mdd,
445                           long long endrec)
446 {
447         struct obd_device *obd = mdd2obd_dev(mdd);
448         struct llog_ctxt *ctxt;
449         long long unsigned cur;
450         int rc;
451
452         ctxt = llog_get_context(obd, LLOG_CHANGELOG_ORIG_CTXT);
453         if (ctxt == NULL)
454                 return -ENXIO;
455
456         spin_lock(&mdd->mdd_cl.mc_lock);
457         cur = (long long)mdd->mdd_cl.mc_index;
458         spin_unlock(&mdd->mdd_cl.mc_lock);
459         if (endrec > cur)
460                 endrec = cur;
461
462         /* purge to "0" is shorthand for everything */
463         if (endrec == 0)
464                 endrec = cur;
465
466         /* If purging all records, write a header entry so we don't have an
467            empty catalog and we're sure to have a valid starting index next
468            time.  In case of crash, we just restart with old log so we're
469            allright. */
470         if (endrec == cur) {
471                 /* XXX: transaction is started by llog itself */
472                 rc = mdd_changelog_write_header(env, mdd, CLM_PURGE);
473                 if (rc)
474                       goto out;
475         }
476
477         /* Some records were purged, so reset repeat-access time (so we
478            record new mtime update records, so users can see a file has been
479            changed since the last purge) */
480         mdd->mdd_cl.mc_starttime = cfs_time_current_64();
481
482         rc = llog_cancel(env, ctxt, (struct llog_cookie *)&endrec, 0);
483 out:
484         llog_ctxt_put(ctxt);
485         return rc;
486 }
487
488 /** Add a CL_MARK record to the changelog
489  * \param mdd
490  * \param markerflags - CLM_*
491  * \retval 0 ok
492  */
493 int mdd_changelog_write_header(const struct lu_env *env,
494                                struct mdd_device *mdd, int markerflags)
495 {
496         struct obd_device               *obd = mdd2obd_dev(mdd);
497         struct llog_changelog_rec       *rec;
498         struct lu_buf                   *buf;
499         struct llog_ctxt                *ctxt;
500         int                              reclen;
501         int                              len = strlen(obd->obd_name);
502         int                              rc;
503
504         ENTRY;
505
506         if (mdd->mdd_cl.mc_mask & (1 << CL_MARK)) {
507                 mdd->mdd_cl.mc_starttime = cfs_time_current_64();
508                 RETURN(0);
509         }
510
511         reclen = llog_data_len(sizeof(*rec) + len);
512         buf = lu_buf_check_and_alloc(&mdd_env_info(env)->mti_big_buf, reclen);
513         if (buf->lb_buf == NULL)
514                 RETURN(-ENOMEM);
515         rec = buf->lb_buf;
516
517         rec->cr.cr_flags = CLF_VERSION;
518         rec->cr.cr_type = CL_MARK;
519         rec->cr.cr_namelen = len;
520         memcpy(changelog_rec_name(&rec->cr), obd->obd_name, rec->cr.cr_namelen);
521         /* Status and action flags */
522         rec->cr.cr_markerflags = mdd->mdd_cl.mc_flags | markerflags;
523         rec->cr_hdr.lrh_len = llog_data_len(changelog_rec_size(&rec->cr) +
524                                             rec->cr.cr_namelen);
525         rec->cr_hdr.lrh_type = CHANGELOG_REC;
526         rec->cr.cr_time = cl_time();
527         spin_lock(&mdd->mdd_cl.mc_lock);
528         rec->cr.cr_index = ++mdd->mdd_cl.mc_index;
529         spin_unlock(&mdd->mdd_cl.mc_lock);
530
531         ctxt = llog_get_context(obd, LLOG_CHANGELOG_ORIG_CTXT);
532         LASSERT(ctxt);
533
534         rc = llog_cat_add(env, ctxt->loc_handle, &rec->cr_hdr, NULL);
535         if (rc > 0)
536                 rc = 0;
537         llog_ctxt_put(ctxt);
538
539         /* assume on or off event; reset repeat-access time */
540         mdd->mdd_cl.mc_starttime = cfs_time_current_64();
541         RETURN(rc);
542 }
543
544 /**
545  * Lookup method for "fid" object. Only filenames with correct SEQ:OID format
546  * are valid. We also check if object with passed fid exists or not.
547  */
548 static int obf_lookup(const struct lu_env *env, struct md_object *p,
549                       const struct lu_name *lname, struct lu_fid *f,
550                       struct md_op_spec *spec)
551 {
552         char *name = (char *)lname->ln_name;
553         struct mdd_device *mdd = mdo2mdd(p);
554         struct mdd_object *child;
555         int rc = 0;
556
557         while (*name == '[')
558                 name++;
559
560         sscanf(name, SFID, RFID(f));
561         if (!fid_is_sane(f)) {
562                 CWARN("%s: Trying to lookup invalid FID [%s] in %s/%s, FID "
563                       "format should be "DFID"\n", mdd2obd_dev(mdd)->obd_name,
564                       lname->ln_name, dot_lustre_name, mdd_obf_dir_name,
565                       (__u64)FID_SEQ_NORMAL, 1, 0);
566                 GOTO(out, rc = -EINVAL);
567         }
568
569         if (!fid_is_norm(f) && !fid_is_igif(f) && !fid_is_root(f) &&
570             !fid_seq_is_dot(f->f_seq)) {
571                 CWARN("%s: Trying to lookup invalid FID "DFID" in %s/%s, "
572                       "sequence should be >= "LPX64" or within ["LPX64","
573                       ""LPX64"].\n", mdd2obd_dev(mdd)->obd_name, PFID(f),
574                       dot_lustre_name, mdd_obf_dir_name, (__u64)FID_SEQ_NORMAL,
575                       (__u64)FID_SEQ_IGIF, (__u64)FID_SEQ_IGIF_MAX);
576                 GOTO(out, rc = -EINVAL);
577         }
578
579         /* Check if object with this fid exists */
580         child = mdd_object_find(env, mdd, f);
581         if (child == NULL)
582                 GOTO(out, rc = 0);
583         if (IS_ERR(child))
584                 GOTO(out, rc = PTR_ERR(child));
585
586         if (mdd_object_exists(child) == 0)
587                 rc = -ENOENT;
588
589         mdd_object_put(env, child);
590
591 out:
592         return rc;
593 }
594
595 static int mdd_dummy_create(const struct lu_env *env,
596                             struct md_object *pobj,
597                             const struct lu_name *lname,
598                             struct md_object *child,
599                             struct md_op_spec *spec,
600                             struct md_attr* ma)
601 {
602         return -EPERM;
603 }
604
605 static int mdd_dummy_rename(const struct lu_env *env,
606                             struct md_object *src_pobj,
607                             struct md_object *tgt_pobj,
608                             const struct lu_fid *lf,
609                             const struct lu_name *lsname,
610                             struct md_object *tobj,
611                             const struct lu_name *ltname,
612                             struct md_attr *ma)
613 {
614         return -EPERM;
615 }
616
617 static int mdd_dummy_link(const struct lu_env *env,
618                           struct md_object *tgt_obj,
619                           struct md_object *src_obj,
620                           const struct lu_name *lname,
621                           struct md_attr *ma)
622 {
623         return -EPERM;
624 }
625
626 static int mdd_dummy_unlink(const struct lu_env *env,
627                             struct md_object *pobj,
628                             struct md_object *cobj,
629                             const struct lu_name *lname,
630                             struct md_attr *ma,
631                             int no_name)
632 {
633         return -EPERM;
634 }
635
636 static struct md_dir_operations mdd_obf_dir_ops = {
637         .mdo_lookup = obf_lookup,
638         .mdo_create = mdd_dummy_create,
639         .mdo_rename = mdd_dummy_rename,
640         .mdo_link   = mdd_dummy_link,
641         .mdo_unlink = mdd_dummy_unlink
642 };
643
644 static struct md_dir_operations mdd_lpf_dir_ops = {
645         .mdo_lookup = mdd_lookup,
646         .mdo_create = mdd_dummy_create,
647         .mdo_rename = mdd_dummy_rename,
648         .mdo_link   = mdd_dummy_link,
649         .mdo_unlink = mdd_dummy_unlink
650 };
651
652 static struct md_object *mdo_locate(const struct lu_env *env,
653                                     struct md_device *md,
654                                     const struct lu_fid *fid)
655 {
656         struct lu_object *obj;
657         struct md_object *mdo;
658
659         obj = lu_object_find(env, &md->md_lu_dev, fid, NULL);
660         if (!IS_ERR(obj)) {
661                 obj = lu_object_locate(obj->lo_header, md->md_lu_dev.ld_type);
662                 LASSERT(obj != NULL);
663                 mdo = lu2md(obj);
664         } else {
665                 mdo = ERR_PTR(PTR_ERR(obj));
666         }
667         return mdo;
668 }
669
670 static int mdd_lpf_setup(const struct lu_env *env, struct mdd_device *m)
671 {
672         struct md_object        *mdo;
673         struct mdd_object       *mdd_lpf;
674         struct lu_fid            fid    = LU_LPF_FID;
675         int                      rc;
676         ENTRY;
677
678         rc = mdd_local_file_create(env, m, mdd_object_fid(m->mdd_dot_lustre),
679                                    mdd_lpf_dir_name, S_IFDIR | S_IRUSR | S_IXUSR,
680                                    &fid);
681         if (rc != 0)
682                 RETURN(rc);
683
684         mdo = mdo_locate(env, &m->mdd_md_dev, &fid);
685         if (IS_ERR(mdo))
686                 RETURN(PTR_ERR(mdo));
687
688         LASSERT(lu_object_exists(&mdo->mo_lu));
689
690         mdd_lpf = md2mdd_obj(mdo);
691         mdd_lpf->mod_obj.mo_dir_ops = &mdd_lpf_dir_ops;
692         m->mdd_dot_lustre_objs.mdd_lpf = mdd_lpf;
693
694         RETURN(0);
695 }
696
697 /**
698  * Create special in-memory "fid" object for open-by-fid.
699  */
700 static int mdd_obf_setup(const struct lu_env *env, struct mdd_device *m)
701 {
702         struct md_object        *mdo;
703         struct mdd_object       *mdd_obf;
704         struct lu_fid            fid = LU_OBF_FID;
705         int                      rc;
706
707         rc = mdd_local_file_create(env, m, mdd_object_fid(m->mdd_dot_lustre),
708                                    mdd_obf_dir_name, S_IFDIR | S_IXUSR, &fid);
709         if (rc < 0)
710                 RETURN(rc);
711
712         mdo = mdo_locate(env, &m->mdd_md_dev, &fid);
713         if (IS_ERR(mdo))
714                 RETURN(PTR_ERR(mdo));
715
716         LASSERT(lu_object_exists(&mdo->mo_lu));
717
718         mdd_obf = md2mdd_obj(mdo);
719         mdd_obf->mod_obj.mo_dir_ops = &mdd_obf_dir_ops;
720         m->mdd_dot_lustre_objs.mdd_obf = mdd_obf;
721
722         return 0;
723 }
724
725 static void mdd_dot_lustre_cleanup(const struct lu_env *env,
726                                    struct mdd_device *m)
727 {
728         if (m->mdd_dot_lustre_objs.mdd_lpf != NULL) {
729                 mdd_object_put(env, m->mdd_dot_lustre_objs.mdd_lpf);
730                 m->mdd_dot_lustre_objs.mdd_lpf = NULL;
731         }
732         if (m->mdd_dot_lustre_objs.mdd_obf != NULL) {
733                 mdd_object_put(env, m->mdd_dot_lustre_objs.mdd_obf);
734                 m->mdd_dot_lustre_objs.mdd_obf = NULL;
735         }
736         if (m->mdd_dot_lustre != NULL) {
737                 mdd_object_put(env, m->mdd_dot_lustre);
738                 m->mdd_dot_lustre = NULL;
739         }
740 }
741
742 /** Setup ".lustre" directory object */
743 static int mdd_dot_lustre_setup(const struct lu_env *env, struct mdd_device *m)
744 {
745         struct md_object        *mdo;
746         struct lu_fid            fid;
747         int                      rc;
748
749         ENTRY;
750         /* Create ".lustre" directory in ROOT. */
751         fid = LU_DOT_LUSTRE_FID;
752         rc = mdd_local_file_create(env, m, &m->mdd_root_fid,
753                                    dot_lustre_name,
754                                    S_IFDIR | S_IRUGO | S_IWUSR | S_IXUGO,
755                                    &fid);
756         if (rc < 0)
757                 RETURN(rc);
758         mdo = mdo_locate(env, &m->mdd_md_dev, &fid);
759         if (IS_ERR(mdo))
760                 RETURN(PTR_ERR(mdo));
761         LASSERT(lu_object_exists(&mdo->mo_lu));
762
763         m->mdd_dot_lustre = md2mdd_obj(mdo);
764
765         rc = mdd_obf_setup(env, m);
766         if (rc) {
767                 CERROR("%s: error initializing \"fid\" object: rc = %d.\n",
768                        mdd2obd_dev(m)->obd_name, rc);
769                 GOTO(out, rc);
770         }
771
772         rc = mdd_lpf_setup(env, m);
773         if (rc != 0) {
774                 CERROR("%s: error initializing \"lost+found\": rc = %d.\n",
775                        mdd2obd_dev(m)->obd_name, rc);
776                 GOTO(out, rc);
777         }
778
779         RETURN(0);
780
781 out:
782         mdd_dot_lustre_cleanup(env, m);
783
784         return rc;
785 }
786
787
788 static struct llog_operations hsm_actions_logops;
789
790 /**
791  * set llog methods and create LLOG_AGENT_ORIG_CTXT llog
792  * object in obd_device
793  */
794 static int mdd_hsm_actions_llog_init(const struct lu_env *env,
795                                      struct mdd_device *m)
796 {
797         struct obd_device       *obd = mdd2obd_dev(m);
798         struct llog_ctxt        *ctxt = NULL;
799         int                      rc;
800         ENTRY;
801
802         OBD_SET_CTXT_MAGIC(&obd->obd_lvfs_ctxt);
803         obd->obd_lvfs_ctxt.dt = m->mdd_bottom;
804
805         rc = llog_setup(env, obd, &obd->obd_olg, LLOG_AGENT_ORIG_CTXT,
806                         obd, &hsm_actions_logops);
807         if (rc) {
808                 CERROR("%s: hsm actions llog setup failed: rc = %d\n",
809                         obd->obd_name, rc);
810                 RETURN(rc);
811         }
812
813         ctxt = llog_get_context(obd, LLOG_AGENT_ORIG_CTXT);
814         LASSERT(ctxt);
815
816         rc = llog_open_create(env, ctxt, &ctxt->loc_handle, NULL,
817                               HSM_ACTIONS);
818         if (rc) {
819                 CERROR("%s: hsm actions llog open_create failed: rc = %d\n",
820                         obd->obd_name, rc);
821                 GOTO(out_cleanup, rc);
822         }
823
824         rc = llog_cat_init_and_process(env, ctxt->loc_handle);
825         if (rc)
826                 GOTO(out_close, rc);
827
828         llog_ctxt_put(ctxt);
829         RETURN(0);
830
831 out_close:
832         llog_cat_close(env, ctxt->loc_handle);
833         ctxt->loc_handle = NULL;
834 out_cleanup:
835         llog_cleanup(env, ctxt);
836
837         return rc;
838 }
839
840 /**
841  * cleanup the context created by llog_setup_named()
842  */
843 static int mdd_hsm_actions_llog_fini(const struct lu_env *env,
844                                      struct mdd_device *m)
845 {
846         struct obd_device       *obd = mdd2obd_dev(m);
847         struct llog_ctxt        *lctxt;
848         ENTRY;
849
850         lctxt = llog_get_context(obd, LLOG_AGENT_ORIG_CTXT);
851         if (lctxt) {
852                 llog_cat_close(env, lctxt->loc_handle);
853                 lctxt->loc_handle = NULL;
854                 llog_cleanup(env, lctxt);
855         }
856
857         RETURN(0);
858 }
859
860 static void mdd_device_shutdown(const struct lu_env *env, struct mdd_device *m,
861                                 struct lustre_cfg *cfg)
862 {
863         mdd_generic_thread_stop(&m->mdd_orph_cleanup_thread);
864         lfsck_degister(env, m->mdd_bottom);
865         mdd_hsm_actions_llog_fini(env, m);
866         mdd_changelog_fini(env, m);
867         orph_index_fini(env, m);
868         mdd_dot_lustre_cleanup(env, m);
869         if (m->mdd_los != NULL) {
870                 local_oid_storage_fini(env, m->mdd_los);
871                 m->mdd_los = NULL;
872         }
873         lu_site_purge(env, mdd2lu_dev(m)->ld_site, ~0);
874
875         if (m->mdd_child_exp)
876                 obd_disconnect(m->mdd_child_exp);
877 }
878
879 static int mdd_process_config(const struct lu_env *env,
880                               struct lu_device *d, struct lustre_cfg *cfg)
881 {
882         struct mdd_device *m    = lu2mdd_dev(d);
883         struct dt_device  *dt   = m->mdd_child;
884         struct lu_device  *next = &dt->dd_lu_dev;
885         int rc;
886         ENTRY;
887
888         switch (cfg->lcfg_command) {
889         case LCFG_PARAM: {
890                 struct obd_device *obd = mdd2obd_dev(m);
891
892                 rc = class_process_proc_param(PARAM_MDD, obd->obd_vars, cfg, m);
893                 if (rc > 0 || rc == -ENOSYS)
894                         /* we don't understand; pass it on */
895                         rc = next->ld_ops->ldo_process_config(env, next, cfg);
896                 break;
897         }
898         case LCFG_SETUP:
899                 rc = next->ld_ops->ldo_process_config(env, next, cfg);
900                 if (rc)
901                         GOTO(out, rc);
902                 dt_conf_get(env, dt, &m->mdd_dt_conf);
903                 break;
904         case LCFG_CLEANUP:
905                 rc = next->ld_ops->ldo_process_config(env, next, cfg);
906                 lu_dev_del_linkage(d->ld_site, d);
907                 mdd_device_shutdown(env, m, cfg);
908                 break;
909         default:
910                 rc = next->ld_ops->ldo_process_config(env, next, cfg);
911                 break;
912         }
913 out:
914         RETURN(rc);
915 }
916
917 static int mdd_recovery_complete(const struct lu_env *env,
918                                  struct lu_device *d)
919 {
920         struct mdd_device *mdd = lu2mdd_dev(d);
921         struct lu_device *next;
922         int rc;
923         ENTRY;
924
925         LASSERT(mdd != NULL);
926         next = &mdd->mdd_child->dd_lu_dev;
927
928         /* XXX: orphans handling. */
929         mdd_orphan_cleanup(env, mdd);
930         rc = next->ld_ops->ldo_recovery_complete(env, next);
931
932         RETURN(rc);
933 }
934
935 int mdd_local_file_create(const struct lu_env *env, struct mdd_device *mdd,
936                           const struct lu_fid *pfid, const char *name, __u32 mode,
937                           struct lu_fid *fid)
938 {
939         struct dt_object        *parent, *dto;
940         int                      rc;
941
942         ENTRY;
943
944         LASSERT(!fid_is_zero(pfid));
945         parent = dt_locate(env, mdd->mdd_bottom, pfid);
946         if (unlikely(IS_ERR(parent)))
947                 RETURN(PTR_ERR(parent));
948
949         /* create local file/dir, if @fid is passed then try to use it */
950         if (fid_is_zero(fid))
951                 dto = local_file_find_or_create(env, mdd->mdd_los, parent,
952                                                 name, mode);
953         else
954                 dto = local_file_find_or_create_with_fid(env, mdd->mdd_bottom,
955                                                          fid, parent, name,
956                                                          mode);
957         if (IS_ERR(dto))
958                 GOTO(out_put, rc = PTR_ERR(dto));
959         *fid = *lu_object_fid(&dto->do_lu);
960         /* since stack is not fully set up the local_storage uses own stack
961          * and we should drop its object from cache */
962         lu_object_put_nocache(env, &dto->do_lu);
963         EXIT;
964 out_put:
965         lu_object_put(env, &parent->do_lu);
966         return 0;
967 }
968
969 static int mdd_lfsck_out_notify(const struct lu_env *env, void *data,
970                                 enum lfsck_events event)
971 {
972         return 0;
973 }
974
975 static int mdd_prepare(const struct lu_env *env,
976                        struct lu_device *pdev,
977                        struct lu_device *cdev)
978 {
979         struct mdd_device       *mdd = lu2mdd_dev(cdev);
980         struct lu_device        *next = &mdd->mdd_child->dd_lu_dev;
981         struct lu_fid            fid;
982         int                      rc;
983
984         ENTRY;
985
986         rc = next->ld_ops->ldo_prepare(env, cdev, next);
987         if (rc)
988                 RETURN(rc);
989
990         /* Setup local dirs */
991         fid.f_seq = FID_SEQ_LOCAL_NAME;
992         fid.f_oid = 1;
993         fid.f_ver = 0;
994         rc = local_oid_storage_init(env, mdd->mdd_bottom, &fid,
995                                     &mdd->mdd_los);
996         if (rc)
997                 RETURN(rc);
998
999         rc = dt_root_get(env, mdd->mdd_child, &mdd->mdd_local_root_fid);
1000         if (rc < 0)
1001                 GOTO(out_los, rc);
1002
1003         lu_root_fid(&fid);
1004         if (mdd_seq_site(mdd)->ss_node_id == 0) {
1005                 rc = mdd_local_file_create(env, mdd, &mdd->mdd_local_root_fid,
1006                                            mdd_root_dir_name, S_IFDIR |
1007                                            S_IRUGO | S_IWUSR | S_IXUGO, &fid);
1008                 if (rc != 0) {
1009                         CERROR("%s: create root fid failed: rc = %d\n",
1010                                mdd2obd_dev(mdd)->obd_name, rc);
1011                         GOTO(out_los, rc);
1012                 }
1013
1014                 mdd->mdd_root_fid = fid;
1015                 rc = mdd_dot_lustre_setup(env, mdd);
1016                 if (rc != 0) {
1017                         CERROR("%s: initializing .lustre failed: rc = %d\n",
1018                                mdd2obd_dev(mdd)->obd_name, rc);
1019                         GOTO(out_los, rc);
1020                 }
1021
1022                 rc = mdd_compat_fixes(env, mdd);
1023                 if (rc != 0)
1024                         GOTO(out_dot, rc);
1025         } else {
1026                 /* Normal client usually send root access to MDT0 directly,
1027                  * the root FID on non-MDT0 will only be used by echo client. */
1028                 mdd->mdd_root_fid = fid;
1029         }
1030
1031         rc = orph_index_init(env, mdd);
1032         if (rc < 0)
1033                 GOTO(out_dot, rc);
1034
1035         rc = mdd_changelog_init(env, mdd);
1036         if (rc != 0) {
1037                 CERROR("%s: failed to initialize changelog: rc = %d\n",
1038                        mdd2obd_dev(mdd)->obd_name, rc);
1039                 GOTO(out_orph, rc);
1040         }
1041
1042         rc = mdd_hsm_actions_llog_init(env, mdd);
1043         if (rc != 0)
1044                 GOTO(out_changelog, rc);
1045
1046         rc = lfsck_register(env, mdd->mdd_bottom, mdd->mdd_child,
1047                             mdd2obd_dev(mdd), mdd_lfsck_out_notify,
1048                             mdd, true);
1049         if (rc != 0) {
1050                 CERROR("%s: failed to initialize lfsck: rc = %d\n",
1051                        mdd2obd_dev(mdd)->obd_name, rc);
1052                 GOTO(out_hsm, rc);
1053         }
1054         RETURN(0);
1055 out_hsm:
1056         mdd_hsm_actions_llog_fini(env, mdd);
1057 out_changelog:
1058         mdd_changelog_fini(env, mdd);
1059 out_orph:
1060         orph_index_fini(env, mdd);
1061 out_dot:
1062         if (mdd_seq_site(mdd)->ss_node_id == 0)
1063                 mdd_dot_lustre_cleanup(env, mdd);
1064 out_los:
1065         local_oid_storage_fini(env, mdd->mdd_los);
1066         mdd->mdd_los = NULL;
1067
1068         return rc;
1069 }
1070
1071 const struct lu_device_operations mdd_lu_ops = {
1072         .ldo_object_alloc      = mdd_object_alloc,
1073         .ldo_process_config    = mdd_process_config,
1074         .ldo_recovery_complete = mdd_recovery_complete,
1075         .ldo_prepare           = mdd_prepare,
1076 };
1077
1078 static int mdd_root_get(const struct lu_env *env,
1079                         struct md_device *m, struct lu_fid *f)
1080 {
1081         struct mdd_device *mdd = lu2mdd_dev(&m->md_lu_dev);
1082
1083         ENTRY;
1084         *f = mdd->mdd_root_fid;
1085         RETURN(0);
1086 }
1087
1088 /*
1089  * No permission check is needed.
1090  */
1091 static int mdd_statfs(const struct lu_env *env, struct md_device *m,
1092                       struct obd_statfs *sfs)
1093 {
1094         struct mdd_device *mdd = lu2mdd_dev(&m->md_lu_dev);
1095         int rc;
1096
1097         ENTRY;
1098
1099         rc = mdd_child_ops(mdd)->dt_statfs(env, mdd->mdd_child, sfs);
1100
1101         sfs->os_namelen = min_t(__u32, sfs->os_namelen, NAME_MAX);
1102
1103         RETURN(rc);
1104 }
1105
1106 /*
1107  * No permission check is needed.
1108  */
1109 static int mdd_init_capa_ctxt(const struct lu_env *env, struct md_device *m,
1110                               int mode, unsigned long timeout, __u32 alg,
1111                               struct lustre_capa_key *keys)
1112 {
1113         struct mdd_device *mdd = lu2mdd_dev(&m->md_lu_dev);
1114         int rc;
1115         ENTRY;
1116
1117         /* need barrier for mds_capa_keys access. */
1118
1119         rc = mdd_child_ops(mdd)->dt_init_capa_ctxt(env, mdd->mdd_child, mode,
1120                                                    timeout, alg, keys);
1121         RETURN(rc);
1122 }
1123
1124 static int mdd_maxeasize_get(const struct lu_env *env, struct md_device *m,
1125                                 int *easize)
1126 {
1127         struct mdd_device *mdd = lu2mdd_dev(&m->md_lu_dev);
1128         ENTRY;
1129
1130         *easize = mdd->mdd_dt_conf.ddp_max_ea_size;
1131
1132         RETURN(0);
1133 }
1134
1135 static int mdd_update_capa_key(const struct lu_env *env,
1136                                struct md_device *m,
1137                                struct lustre_capa_key *key)
1138 {
1139         /* we do not support capabilities ... */
1140         return -EINVAL;
1141 }
1142
1143 static int mdd_llog_ctxt_get(const struct lu_env *env, struct md_device *m,
1144                              int idx, void **h)
1145 {
1146         struct mdd_device *mdd = lu2mdd_dev(&m->md_lu_dev);
1147
1148         *h = llog_group_get_ctxt(&mdd2obd_dev(mdd)->obd_olg, idx);
1149         return (*h == NULL ? -ENOENT : 0);
1150 }
1151
1152 static struct lu_device *mdd_device_free(const struct lu_env *env,
1153                                          struct lu_device *lu)
1154 {
1155         struct mdd_device *m = lu2mdd_dev(lu);
1156         ENTRY;
1157
1158         LASSERT(atomic_read(&lu->ld_ref) == 0);
1159         md_device_fini(&m->mdd_md_dev);
1160         OBD_FREE_PTR(m);
1161         RETURN(NULL);
1162 }
1163
1164 static struct lu_device *mdd_device_alloc(const struct lu_env *env,
1165                                           struct lu_device_type *t,
1166                                           struct lustre_cfg *lcfg)
1167 {
1168         struct lu_device  *l;
1169         struct mdd_device *m;
1170
1171         OBD_ALLOC_PTR(m);
1172         if (m == NULL) {
1173                 l = ERR_PTR(-ENOMEM);
1174         } else {
1175                 int rc;
1176
1177                 l = mdd2lu_dev(m);
1178                 md_device_init(&m->mdd_md_dev, t);
1179                 rc = mdd_init0(env, m, t, lcfg);
1180                 if (rc != 0) {
1181                         mdd_device_free(env, l);
1182                         l = ERR_PTR(rc);
1183                 }
1184         }
1185
1186         return l;
1187 }
1188
1189 /*
1190  * we use exports to track all mdd users
1191  */
1192 static int mdd_obd_connect(const struct lu_env *env, struct obd_export **exp,
1193                            struct obd_device *obd, struct obd_uuid *cluuid,
1194                            struct obd_connect_data *data, void *localdata)
1195 {
1196         struct mdd_device    *mdd = lu2mdd_dev(obd->obd_lu_dev);
1197         struct lustre_handle  conn;
1198         int                   rc;
1199         ENTRY;
1200
1201         CDEBUG(D_CONFIG, "connect #%d\n", mdd->mdd_connects);
1202
1203         rc = class_connect(&conn, obd, cluuid);
1204         if (rc)
1205                 RETURN(rc);
1206
1207         *exp = class_conn2export(&conn);
1208
1209         /* Why should there ever be more than 1 connect? */
1210         LASSERT(mdd->mdd_connects == 0);
1211         mdd->mdd_connects++;
1212
1213         RETURN(0);
1214 }
1215
1216 /*
1217  * once last export (we don't count self-export) disappeared
1218  * mdd can be released
1219  */
1220 static int mdd_obd_disconnect(struct obd_export *exp)
1221 {
1222         struct obd_device *obd = exp->exp_obd;
1223         struct mdd_device *mdd = lu2mdd_dev(obd->obd_lu_dev);
1224         int                rc, release = 0;
1225         ENTRY;
1226
1227         mdd->mdd_connects--;
1228         if (mdd->mdd_connects == 0)
1229                 release = 1;
1230
1231         rc = class_disconnect(exp);
1232
1233         if (rc == 0 && release)
1234                 class_manual_cleanup(obd);
1235         RETURN(rc);
1236 }
1237
1238 static int mdd_obd_get_info(const struct lu_env *env, struct obd_export *exp,
1239                             __u32 keylen, void *key, __u32 *vallen, void *val,
1240                             struct lov_stripe_md *lsm)
1241 {
1242         int rc = -EINVAL;
1243
1244         if (KEY_IS(KEY_OSP_CONNECTED)) {
1245                 struct obd_device       *obd = exp->exp_obd;
1246                 struct mdd_device       *mdd;
1247
1248                 if (!obd->obd_set_up || obd->obd_stopping)
1249                         RETURN(-EAGAIN);
1250
1251                 mdd = lu2mdd_dev(obd->obd_lu_dev);
1252                 LASSERT(mdd);
1253                 rc = obd_get_info(env, mdd->mdd_child_exp, keylen, key, vallen,
1254                                   val, lsm);
1255                 RETURN(rc);
1256         }
1257
1258         RETURN(rc);
1259 }
1260
1261 static struct obd_ops mdd_obd_device_ops = {
1262         .o_owner        = THIS_MODULE,
1263         .o_connect      = mdd_obd_connect,
1264         .o_disconnect   = mdd_obd_disconnect,
1265         .o_get_info     = mdd_obd_get_info,
1266 };
1267
1268 static int mdd_changelog_user_register(const struct lu_env *env,
1269                                        struct mdd_device *mdd, int *id)
1270 {
1271         struct llog_ctxt *ctxt;
1272         struct llog_changelog_user_rec *rec;
1273         int rc;
1274         ENTRY;
1275
1276         ctxt = llog_get_context(mdd2obd_dev(mdd),
1277                                 LLOG_CHANGELOG_USER_ORIG_CTXT);
1278         if (ctxt == NULL)
1279                 RETURN(-ENXIO);
1280
1281         OBD_ALLOC_PTR(rec);
1282         if (rec == NULL) {
1283                 llog_ctxt_put(ctxt);
1284                 RETURN(-ENOMEM);
1285         }
1286
1287         /* Assume we want it on since somebody registered */
1288         rc = mdd_changelog_on(env, mdd, 1);
1289         if (rc)
1290                 GOTO(out, rc);
1291
1292         rec->cur_hdr.lrh_len = sizeof(*rec);
1293         rec->cur_hdr.lrh_type = CHANGELOG_USER_REC;
1294         spin_lock(&mdd->mdd_cl.mc_user_lock);
1295         if (mdd->mdd_cl.mc_lastuser == (unsigned int)(-1)) {
1296                 spin_unlock(&mdd->mdd_cl.mc_user_lock);
1297                 CERROR("Maximum number of changelog users exceeded!\n");
1298                 GOTO(out, rc = -EOVERFLOW);
1299         }
1300         *id = rec->cur_id = ++mdd->mdd_cl.mc_lastuser;
1301         rec->cur_endrec = mdd->mdd_cl.mc_index;
1302         spin_unlock(&mdd->mdd_cl.mc_user_lock);
1303
1304         rc = llog_cat_add(env, ctxt->loc_handle, &rec->cur_hdr, NULL);
1305
1306         CDEBUG(D_IOCTL, "Registered changelog user %d\n", *id);
1307 out:
1308         OBD_FREE_PTR(rec);
1309         llog_ctxt_put(ctxt);
1310         RETURN(rc);
1311 }
1312
1313 struct mdd_changelog_user_data {
1314         __u64 mcud_endrec; /**< purge record for this user */
1315         __u64 mcud_minrec; /**< lowest changelog recno still referenced */
1316         __u32 mcud_id;
1317         __u32 mcud_minid;  /**< user id with lowest rec reference */
1318         __u32 mcud_usercount;
1319         unsigned int mcud_found:1;
1320 };
1321 #define MCUD_UNREGISTER -1LL
1322
1323 /** Two things:
1324  * 1. Find the smallest record everyone is willing to purge
1325  * 2. Update the last purgeable record for this user
1326  */
1327 static int mdd_changelog_user_purge_cb(const struct lu_env *env,
1328                                        struct llog_handle *llh,
1329                                        struct llog_rec_hdr *hdr, void *data)
1330 {
1331         struct llog_changelog_user_rec  *rec;
1332         struct mdd_changelog_user_data  *mcud = data;
1333         int                              rc;
1334
1335         ENTRY;
1336
1337         LASSERT(llh->lgh_hdr->llh_flags & LLOG_F_IS_PLAIN);
1338
1339         rec = (struct llog_changelog_user_rec *)hdr;
1340
1341         mcud->mcud_usercount++;
1342
1343         /* If we have a new endrec for this id, use it for the following
1344            min check instead of its old value */
1345         if (rec->cur_id == mcud->mcud_id)
1346                 rec->cur_endrec = max(rec->cur_endrec, mcud->mcud_endrec);
1347
1348         /* Track the minimum referenced record */
1349         if (mcud->mcud_minid == 0 || mcud->mcud_minrec > rec->cur_endrec) {
1350                 mcud->mcud_minid = rec->cur_id;
1351                 mcud->mcud_minrec = rec->cur_endrec;
1352         }
1353
1354         if (rec->cur_id != mcud->mcud_id)
1355                 RETURN(0);
1356
1357         /* Update this user's record */
1358         mcud->mcud_found = 1;
1359
1360         /* Special case: unregister this user */
1361         if (mcud->mcud_endrec == MCUD_UNREGISTER) {
1362                 struct llog_cookie cookie;
1363
1364                 cookie.lgc_lgl = llh->lgh_id;
1365                 cookie.lgc_index = hdr->lrh_index;
1366
1367                 rc = llog_cat_cancel_records(env, llh->u.phd.phd_cat_handle,
1368                                              1, &cookie);
1369                 if (rc == 0)
1370                         mcud->mcud_usercount--;
1371
1372                 RETURN(rc);
1373         }
1374
1375         /* Update the endrec */
1376         CDEBUG(D_IOCTL, "Rewriting changelog user %d endrec to "LPU64"\n",
1377                mcud->mcud_id, rec->cur_endrec);
1378
1379         rc = llog_write(env, llh, hdr, hdr->lrh_index);
1380
1381         RETURN(rc);
1382 }
1383
1384 static int mdd_changelog_user_purge(const struct lu_env *env,
1385                                     struct mdd_device *mdd, int id,
1386                                     long long endrec)
1387 {
1388         struct mdd_changelog_user_data data;
1389         struct llog_ctxt *ctxt;
1390         int rc;
1391         ENTRY;
1392
1393         CDEBUG(D_IOCTL, "Purge request: id=%d, endrec=%lld\n", id, endrec);
1394
1395         data.mcud_id = id;
1396         data.mcud_minid = 0;
1397         data.mcud_minrec = 0;
1398         data.mcud_usercount = 0;
1399         data.mcud_endrec = endrec;
1400         spin_lock(&mdd->mdd_cl.mc_lock);
1401         endrec = mdd->mdd_cl.mc_index;
1402         spin_unlock(&mdd->mdd_cl.mc_lock);
1403         if ((data.mcud_endrec == 0) ||
1404             ((data.mcud_endrec > endrec) &&
1405              (data.mcud_endrec != MCUD_UNREGISTER)))
1406                 data.mcud_endrec = endrec;
1407
1408         ctxt = llog_get_context(mdd2obd_dev(mdd),
1409                                 LLOG_CHANGELOG_USER_ORIG_CTXT);
1410         if (ctxt == NULL)
1411                 return -ENXIO;
1412
1413         LASSERT(ctxt->loc_handle->lgh_hdr->llh_flags & LLOG_F_IS_CAT);
1414
1415         rc = llog_cat_process(env, ctxt->loc_handle,
1416                               mdd_changelog_user_purge_cb, (void *)&data,
1417                               0, 0);
1418         if ((rc >= 0) && (data.mcud_minrec > 0)) {
1419                 CDEBUG(D_IOCTL, "Purging changelog entries up to "LPD64
1420                        ", referenced by "CHANGELOG_USER_PREFIX"%d\n",
1421                        data.mcud_minrec, data.mcud_minid);
1422                 rc = mdd_changelog_llog_cancel(env, mdd, data.mcud_minrec);
1423         } else {
1424                 CWARN("Could not determine changelog records to purge; rc=%d\n",
1425                       rc);
1426         }
1427
1428         llog_ctxt_put(ctxt);
1429
1430         if (!data.mcud_found) {
1431                 CWARN("No entry for user %d.  Last changelog reference is "
1432                       LPD64" by changelog user %d\n", data.mcud_id,
1433                       data.mcud_minrec, data.mcud_minid);
1434                rc = -ENOENT;
1435         }
1436
1437         if (!rc && data.mcud_usercount == 0)
1438                 /* No more users; turn changelogs off */
1439                 rc = mdd_changelog_on(env, mdd, 0);
1440
1441         RETURN (rc);
1442 }
1443
1444 /** mdd_iocontrol
1445  * May be called remotely from mdt_iocontrol_handle or locally from
1446  * mdt_iocontrol. Data may be freeform - remote handling doesn't enforce
1447  * an obd_ioctl_data format (but local ioctl handler does).
1448  * \param cmd - ioc
1449  * \param len - data len
1450  * \param karg - ioctl data, in kernel space
1451  */
1452 static int mdd_iocontrol(const struct lu_env *env, struct md_device *m,
1453                          unsigned int cmd, int len, void *karg)
1454 {
1455         struct mdd_device *mdd;
1456         struct obd_ioctl_data *data = karg;
1457         int rc;
1458         ENTRY;
1459
1460         mdd = lu2mdd_dev(&m->md_lu_dev);
1461
1462         /* Doesn't use obd_ioctl_data */
1463         switch (cmd) {
1464         case OBD_IOC_CHANGELOG_CLEAR: {
1465                 struct changelog_setinfo *cs = karg;
1466                 rc = mdd_changelog_user_purge(env, mdd, cs->cs_id,
1467                                               cs->cs_recno);
1468                 RETURN(rc);
1469         }
1470         case OBD_IOC_GET_MNTOPT: {
1471                 mntopt_t *mntopts = (mntopt_t *)karg;
1472                 *mntopts = mdd->mdd_dt_conf.ddp_mntopts;
1473                 RETURN(0);
1474         }
1475         case OBD_IOC_START_LFSCK: {
1476                 rc = lfsck_start(env, mdd->mdd_bottom,
1477                                  (struct lfsck_start_param *)karg);
1478                 RETURN(rc);
1479         }
1480         case OBD_IOC_STOP_LFSCK: {
1481                 rc = lfsck_stop(env, mdd->mdd_bottom,
1482                                 (struct lfsck_stop *)karg);
1483                 RETURN(rc);
1484         }
1485         }
1486
1487         /* Below ioctls use obd_ioctl_data */
1488         if (len != sizeof(*data)) {
1489                 CERROR("Bad ioctl size %d\n", len);
1490                 RETURN(-EINVAL);
1491         }
1492         if (data->ioc_version != OBD_IOCTL_VERSION) {
1493                 CERROR("Bad magic %x != %x\n", data->ioc_version,
1494                        OBD_IOCTL_VERSION);
1495                 RETURN(-EINVAL);
1496         }
1497
1498         switch (cmd) {
1499         case OBD_IOC_CHANGELOG_REG:
1500                 rc = mdd_changelog_user_register(env, mdd, &data->ioc_u32_1);
1501                 break;
1502         case OBD_IOC_CHANGELOG_DEREG:
1503                 rc = mdd_changelog_user_purge(env, mdd, data->ioc_u32_1,
1504                                               MCUD_UNREGISTER);
1505                 break;
1506         default:
1507                 rc = -ENOTTY;
1508         }
1509
1510         RETURN (rc);
1511 }
1512
1513 /* type constructor/destructor: mdd_type_init, mdd_type_fini */
1514 LU_TYPE_INIT_FINI(mdd, &mdd_thread_key);
1515
1516 static const struct md_device_operations mdd_ops = {
1517         .mdo_statfs         = mdd_statfs,
1518         .mdo_root_get       = mdd_root_get,
1519         .mdo_init_capa_ctxt = mdd_init_capa_ctxt,
1520         .mdo_update_capa_key= mdd_update_capa_key,
1521         .mdo_llog_ctxt_get  = mdd_llog_ctxt_get,
1522         .mdo_iocontrol      = mdd_iocontrol,
1523         .mdo_maxeasize_get  = mdd_maxeasize_get,
1524 };
1525
1526 static struct lu_device_type_operations mdd_device_type_ops = {
1527         .ldto_init = mdd_type_init,
1528         .ldto_fini = mdd_type_fini,
1529
1530         .ldto_start = mdd_type_start,
1531         .ldto_stop  = mdd_type_stop,
1532
1533         .ldto_device_alloc = mdd_device_alloc,
1534         .ldto_device_free  = mdd_device_free,
1535
1536         .ldto_device_fini    = mdd_device_fini
1537 };
1538
1539 static struct lu_device_type mdd_device_type = {
1540         .ldt_tags     = LU_DEVICE_MD,
1541         .ldt_name     = LUSTRE_MDD_NAME,
1542         .ldt_ops      = &mdd_device_type_ops,
1543         .ldt_ctx_tags = LCT_MD_THREAD
1544 };
1545
1546 /* context key constructor: mdd_key_init */
1547 LU_KEY_INIT(mdd, struct mdd_thread_info);
1548
1549 static void mdd_key_fini(const struct lu_context *ctx,
1550                          struct lu_context_key *key, void *data)
1551 {
1552         struct mdd_thread_info *info = data;
1553
1554         lu_buf_free(&info->mti_big_buf);
1555         lu_buf_free(&info->mti_link_buf);
1556
1557         OBD_FREE_PTR(info);
1558 }
1559
1560 /* context key: mdd_thread_key */
1561 LU_CONTEXT_KEY_DEFINE(mdd, LCT_MD_THREAD);
1562
1563 int mdd_generic_thread_start(struct mdd_generic_thread *thread,
1564                              int (*func)(void *), void *data, char *name)
1565 {
1566         struct task_struct      *task;
1567
1568         LASSERT(thread->mgt_init == false);
1569         init_completion(&thread->mgt_started);
1570         init_completion(&thread->mgt_finished);
1571         thread->mgt_data = data;
1572         thread->mgt_abort = false;
1573         thread->mgt_init = true;
1574
1575         task = kthread_run(func, thread, name);
1576         if (IS_ERR(task)) {
1577                 complete(&thread->mgt_finished);
1578                 return PTR_ERR(task);
1579         }
1580         wait_for_completion(&thread->mgt_started);
1581         return 0;
1582 }
1583
1584 void mdd_generic_thread_stop(struct mdd_generic_thread *thread)
1585 {
1586         if (thread->mgt_init == true) {
1587                 thread->mgt_abort = true;
1588                 wait_for_completion(&thread->mgt_finished);
1589         }
1590 }
1591
1592 static int __init mdd_mod_init(void)
1593 {
1594         int rc;
1595
1596         rc = lu_kmem_init(mdd_caches);
1597         if (rc)
1598                 return rc;
1599
1600         changelog_orig_logops = llog_osd_ops;
1601         changelog_orig_logops.lop_cancel = llog_changelog_cancel;
1602         changelog_orig_logops.lop_add = llog_cat_add_rec;
1603         changelog_orig_logops.lop_declare_add = llog_cat_declare_add_rec;
1604
1605         hsm_actions_logops = llog_osd_ops;
1606         hsm_actions_logops.lop_add = llog_cat_add_rec;
1607         hsm_actions_logops.lop_declare_add = llog_cat_declare_add_rec;
1608
1609         rc = class_register_type(&mdd_obd_device_ops, NULL, true, NULL,
1610                                  LUSTRE_MDD_NAME, &mdd_device_type);
1611         if (rc)
1612                 lu_kmem_fini(mdd_caches);
1613         return rc;
1614 }
1615
1616 static void __exit mdd_mod_exit(void)
1617 {
1618         class_unregister_type(LUSTRE_MDD_NAME);
1619         lu_kmem_fini(mdd_caches);
1620 }
1621
1622 MODULE_AUTHOR("Sun Microsystems, Inc. <http://www.lustre.org/>");
1623 MODULE_DESCRIPTION("Lustre Meta-data Device Prototype ("LUSTRE_MDD_NAME")");
1624 MODULE_LICENSE("GPL");
1625
1626 cfs_module(mdd, "0.1.0", mdd_mod_init, mdd_mod_exit);