4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2014, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/mdd/mdd_internal.h
38 * Author: Wang Di <wangdi@clusterfs.com>
41 #ifndef _MDD_INTERNAL_H
42 #define _MDD_INTERNAL_H
44 #include <lustre_acl.h>
45 #include <lustre_eacl.h>
46 #include <md_object.h>
47 #include <dt_object.h>
48 #include <lustre_lfsck.h>
49 #include <lustre_fid.h>
50 #include <lprocfs_status.h>
51 #include <lustre_log.h>
52 #include <lustre_linkea.h>
55 /** changelog is recording */
56 #define CLM_ON 0x00001
57 /** internal error prevented changelogs from starting */
58 #define CLM_ERR 0x00002
60 /** changelogs turned on */
61 #define CLM_START 0x10000
62 /** changelogs turned off */
63 #define CLM_FINI 0x20000
64 /** some changelog records purged */
65 #define CLM_PURGE 0x40000
67 struct mdd_changelog {
68 spinlock_t mc_lock; /* for index */
73 spinlock_t mc_user_lock;
77 static inline __u64 cl_time(void) {
80 cfs_fs_time_current(&time);
81 return (((__u64)time.tv_sec) << 30) + time.tv_nsec;
84 /** Objects in .lustre dir */
85 struct mdd_dot_lustre_objs {
86 struct mdd_object *mdd_obf;
87 struct mdd_object *mdd_lpf;
90 struct mdd_generic_thread {
91 struct completion mgt_started;
92 struct completion mgt_finished;
99 struct md_device mdd_md_dev;
100 struct obd_export *mdd_child_exp;
101 struct dt_device *mdd_child;
102 struct dt_device *mdd_bottom;
103 struct lu_fid mdd_root_fid; /* /ROOT */
104 struct lu_fid mdd_local_root_fid;
105 struct dt_device_param mdd_dt_conf;
106 struct dt_object *mdd_orphans; /* PENDING directory */
107 struct proc_dir_entry *mdd_proc_entry;
108 struct mdd_changelog mdd_cl;
109 unsigned long mdd_atime_diff;
110 struct mdd_object *mdd_dot_lustre;
111 struct mdd_dot_lustre_objs mdd_dot_lustre_objs;
112 unsigned int mdd_sync_permission;
114 struct local_oid_storage *mdd_los;
115 struct mdd_generic_thread mdd_orph_cleanup_thread;
119 /* The dir object has been unlinked */
125 struct md_object mod_obj;
130 unsigned long mod_flags;
133 struct mdd_thread_info {
134 struct lu_fid mti_fid;
135 struct lu_fid mti_fid2; /* used for be & cpu converting */
137 * only be used by MDD interfaces, can be passed into local MDD APIs.
139 struct lu_attr mti_pattr;
140 struct lu_attr mti_cattr;
141 struct lu_attr mti_tpattr;
142 struct lu_attr mti_tattr;
143 /** used to set c/mtime */
144 struct lu_attr mti_la_for_fix;
145 /* Only used in mdd_object_start */
146 struct lu_attr mti_la_for_start;
147 /* mti_ent and mti_key must be conjoint,
148 * then mti_ent::lde_name will be mti_key. */
149 struct lu_dirent mti_ent;
150 char mti_key[NAME_MAX + 16];
151 struct lu_buf mti_buf[4];
152 struct lu_buf mti_big_buf; /* biggish persistent buf */
153 struct lu_buf mti_link_buf; /* buf for link ea */
155 char mti_xattr_buf[LUSTRE_POSIX_ACL_MAX_SIZE];
156 struct dt_allocation_hint mti_hint;
157 struct dt_object_format mti_dof;
158 struct linkea_data mti_link_data;
159 struct md_op_spec mti_spec;
160 struct dt_insert_rec mti_dt_rec;
161 struct lfsck_request mti_lr;
162 struct lu_seq_range mti_range;
165 enum mdd_links_add_overflow {
170 extern const char orph_index_name[];
172 int mdd_la_get(const struct lu_env *env, struct mdd_object *obj,
174 int mdd_attr_get(const struct lu_env *env, struct md_object *obj,
176 int mdd_attr_set(const struct lu_env *env, struct md_object *obj,
177 const struct md_attr *ma);
178 int mdd_attr_set_internal(const struct lu_env *env,
179 struct mdd_object *obj,
180 const struct lu_attr *attr,
181 struct thandle *handle,
183 int mdd_update_time(const struct lu_env *env, struct mdd_object *obj,
184 const struct lu_attr *oattr, struct lu_attr *attr,
185 struct thandle *handle);
186 int mdd_object_create_internal(const struct lu_env *env, struct mdd_object *p,
187 struct mdd_object *c, struct lu_attr *attr,
188 struct thandle *handle,
189 const struct md_op_spec *spec,
190 struct dt_allocation_hint *hint);
193 void mdd_write_lock(const struct lu_env *env, struct mdd_object *obj,
194 enum mdd_object_role role);
195 void mdd_read_lock(const struct lu_env *env, struct mdd_object *obj,
196 enum mdd_object_role role);
197 void mdd_write_unlock(const struct lu_env *env, struct mdd_object *obj);
198 void mdd_read_unlock(const struct lu_env *env, struct mdd_object *obj);
199 int mdd_write_locked(const struct lu_env *env, struct mdd_object *obj);
202 int mdd_is_subdir(const struct lu_env *env, struct md_object *mo,
203 const struct lu_fid *fid, struct lu_fid *sfid);
204 int mdd_may_create(const struct lu_env *env, struct mdd_object *pobj,
205 const struct lu_attr *pattr, struct mdd_object *cobj,
207 int mdd_may_unlink(const struct lu_env *env, struct mdd_object *pobj,
208 const struct lu_attr *pattr, const struct lu_attr *attr);
209 int mdd_may_delete(const struct lu_env *env, struct mdd_object *tpobj,
210 const struct lu_attr *tpattr, struct mdd_object *tobj,
211 const struct lu_attr *tattr, const struct lu_attr *cattr,
212 int check_perm, int check_empty);
213 int mdd_unlink_sanity_check(const struct lu_env *env, struct mdd_object *pobj,
214 const struct lu_attr *pattr,
215 struct mdd_object *cobj,
216 const struct lu_attr *cattr);
217 int mdd_finish_unlink(const struct lu_env *env, struct mdd_object *obj,
218 struct md_attr *ma, const struct mdd_object *pobj,
219 const struct lu_name *lname, struct thandle *th);
221 int mdd_is_root(struct mdd_device *mdd, const struct lu_fid *fid);
222 int mdd_lookup(const struct lu_env *env,
223 struct md_object *pobj, const struct lu_name *lname,
224 struct lu_fid* fid, struct md_op_spec *spec);
225 int mdd_links_read(const struct lu_env *env, struct mdd_object *mdd_obj,
226 struct linkea_data *ldata);
227 int mdd_declare_links_add(const struct lu_env *env, struct mdd_object *mdd_obj,
228 struct thandle *handle, struct linkea_data *ldata,
229 enum mdd_links_add_overflow overflow);
230 int mdd_links_write(const struct lu_env *env, struct mdd_object *mdd_obj,
231 struct linkea_data *ldata, struct thandle *handle);
232 struct lu_buf *mdd_links_get(const struct lu_env *env,
233 struct mdd_object *mdd_obj);
234 int mdd_links_rename(const struct lu_env *env,
235 struct mdd_object *mdd_obj,
236 const struct lu_fid *oldpfid,
237 const struct lu_name *oldlname,
238 const struct lu_fid *newpfid,
239 const struct lu_name *newlname,
240 struct thandle *handle,
241 struct linkea_data *ldata,
242 int first, int check);
244 struct mdd_thread_info *mdd_env_info(const struct lu_env *env);
246 #define MDD_ENV_VAR(env, var) (&mdd_env_info(env)->mti_##var)
248 struct lu_buf *mdd_buf_get(const struct lu_env *env, void *area, ssize_t len);
249 const struct lu_buf *mdd_buf_get_const(const struct lu_env *env,
250 const void *area, ssize_t len);
252 int mdd_orphan_cleanup(const struct lu_env *env, struct mdd_device *d);
253 int __mdd_orphan_add(const struct lu_env *, struct mdd_object *,
255 int __mdd_orphan_del(const struct lu_env *, struct mdd_object *,
257 int orph_index_init(const struct lu_env *env, struct mdd_device *mdd);
258 void orph_index_fini(const struct lu_env *env, struct mdd_device *mdd);
259 int orph_declare_index_insert(const struct lu_env *, struct mdd_object *,
260 umode_t mode, struct thandle *);
261 int orph_declare_index_delete(const struct lu_env *, struct mdd_object *,
265 int mdd_procfs_init(struct mdd_device *mdd, const char *name);
266 void mdd_procfs_fini(struct mdd_device *mdd);
269 extern struct kmem_cache *mdd_object_kmem;
270 extern const struct md_dir_operations mdd_dir_ops;
271 extern const struct md_object_operations mdd_obj_ops;
272 int mdd_readlink(const struct lu_env *env, struct md_object *obj,
274 int accmode(const struct lu_env *env, const struct lu_attr *la, int flags);
275 extern struct lu_context_key mdd_thread_key;
276 extern const struct lu_device_operations mdd_lu_ops;
278 struct mdd_object *mdd_object_find(const struct lu_env *env,
279 struct mdd_device *d,
280 const struct lu_fid *f);
281 int mdd_readpage(const struct lu_env *env, struct md_object *obj,
282 const struct lu_rdpg *rdpg);
283 int mdd_declare_changelog_store(const struct lu_env *env,
284 struct mdd_device *mdd,
285 const struct lu_name *tname,
286 const struct lu_name *sname,
287 struct thandle *handle);
288 void mdd_changelog_rec_ext_jobid(struct changelog_rec *rec, const char *jobid);
289 int mdd_changelog_store(const struct lu_env *env, struct mdd_device *mdd,
290 struct llog_changelog_rec *rec, struct thandle *th);
291 int mdd_changelog_data_store(const struct lu_env *env, struct mdd_device *mdd,
292 enum changelog_rec_type type, int flags,
293 struct mdd_object *mdd_obj,
294 struct thandle *handle);
295 int mdd_changelog_ns_store(const struct lu_env *env, struct mdd_device *mdd,
296 enum changelog_rec_type type,
297 enum changelog_rec_flags crf,
298 struct mdd_object *target,
299 const struct lu_fid *tpfid,
300 const struct lu_fid *sfid,
301 const struct lu_fid *spfid,
302 const struct lu_name *tname,
303 const struct lu_name *sname,
304 struct thandle *handle);
305 int mdd_invalidate(const struct lu_env *env, struct md_object *obj);
306 int mdd_declare_object_create_internal(const struct lu_env *env,
307 struct mdd_object *p,
308 struct mdd_object *c,
309 struct lu_attr *attr,
310 struct thandle *handle,
311 const struct md_op_spec *spec,
312 struct dt_allocation_hint *hint);
313 int mdd_get_lov_ea(const struct lu_env *env, struct mdd_object *obj,
314 struct lu_buf *lmm_buf);
317 void mdd_object_make_hint(const struct lu_env *env, struct mdd_object *parent,
318 struct mdd_object *child, const struct lu_attr *attr,
319 const struct md_op_spec *spec,
320 struct dt_allocation_hint *hint);
322 static inline void mdd_object_get(struct mdd_object *o)
324 lu_object_get(&o->mod_obj.mo_lu);
327 static inline void mdd_object_put(const struct lu_env *env,
328 struct mdd_object *o)
330 lu_object_put(env, &o->mod_obj.mo_lu);
333 struct thandle *mdd_trans_create(const struct lu_env *env,
334 struct mdd_device *mdd);
335 int mdd_trans_start(const struct lu_env *env, struct mdd_device *mdd,
337 int mdd_trans_stop(const struct lu_env *env, struct mdd_device *mdd,
338 int rc, struct thandle *handle);
341 struct lu_object *mdd_object_alloc(const struct lu_env *env,
342 const struct lu_object_header *hdr,
343 struct lu_device *d);
344 int mdd_local_file_create(const struct lu_env *env, struct mdd_device *mdd,
345 const struct lu_fid *pfid, const char *name,
346 __u32 mode, struct lu_fid *fid);
348 int mdd_acl_chmod(const struct lu_env *env, struct mdd_object *o, __u32 mode,
349 struct thandle *handle);
350 int mdd_acl_set(const struct lu_env *env, struct mdd_object *obj,
351 struct lu_attr *attr, const struct lu_buf *buf, int fl);
352 int __mdd_fix_mode_acl(const struct lu_env *env, struct lu_buf *buf,
354 int __mdd_permission_internal(const struct lu_env *env, struct mdd_object *obj,
355 const struct lu_attr *la, int mask, int role);
356 int mdd_permission(const struct lu_env *env,
357 struct md_object *pobj, struct md_object *cobj,
358 struct md_attr *ma, int mask);
359 int mdd_generic_thread_start(struct mdd_generic_thread *thread,
360 int (*func)(void *), void *data, char *name);
361 void mdd_generic_thread_stop(struct mdd_generic_thread *thread);
364 int mdd_compat_fixes(const struct lu_env *env, struct mdd_device *mdd);
366 /* inline functions */
367 static inline int lu_device_is_mdd(struct lu_device *d)
369 return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &mdd_lu_ops);
372 static inline struct mdd_device* lu2mdd_dev(struct lu_device *d)
374 LASSERT(lu_device_is_mdd(d));
375 return container_of0(d, struct mdd_device, mdd_md_dev.md_lu_dev);
378 static inline struct lu_device *mdd2lu_dev(struct mdd_device *d)
380 return (&d->mdd_md_dev.md_lu_dev);
383 static inline struct mdd_object *lu2mdd_obj(struct lu_object *o)
385 LASSERT(ergo(o != NULL, lu_device_is_mdd(o->lo_dev)));
386 return container_of0(o, struct mdd_object, mod_obj.mo_lu);
389 static inline struct mdd_device* mdo2mdd(struct md_object *mdo)
391 return lu2mdd_dev(mdo->mo_lu.lo_dev);
394 static inline struct mdd_object* md2mdd_obj(struct md_object *mdo)
396 return container_of0(mdo, struct mdd_object, mod_obj);
399 static inline const struct dt_device_operations *
400 mdd_child_ops(struct mdd_device *d)
402 return d->mdd_child->dd_ops;
405 static inline struct lu_object *mdd2lu_obj(struct mdd_object *obj)
407 return &obj->mod_obj.mo_lu;
410 static inline struct dt_object* mdd_object_child(struct mdd_object *o)
412 return container_of0(lu_object_next(mdd2lu_obj(o)),
413 struct dt_object, do_lu);
416 static inline struct obd_device *mdd2obd_dev(struct mdd_device *mdd)
418 return (mdd->mdd_md_dev.md_lu_dev.ld_obd);
421 static inline struct mdd_device *mdd_obj2mdd_dev(struct mdd_object *obj)
423 return mdo2mdd(&obj->mod_obj);
426 static inline const struct lu_fid *mdo2fid(const struct mdd_object *obj)
428 return lu_object_fid(&obj->mod_obj.mo_lu);
431 static inline umode_t mdd_object_type(const struct mdd_object *obj)
433 return lu_object_attr(&obj->mod_obj.mo_lu);
436 static inline int mdd_is_dead_obj(struct mdd_object *obj)
438 return obj && obj->mod_flags & DEAD_OBJ;
441 static inline int mdd_object_exists(struct mdd_object *obj)
443 return lu_object_exists(mdd2lu_obj(obj));
446 static inline int mdd_object_remote(struct mdd_object *obj)
448 return lu_object_remote(mdd2lu_obj(obj));
451 static inline const struct lu_fid *mdd_object_fid(struct mdd_object *obj)
453 return lu_object_fid(mdd2lu_obj(obj));
456 static inline struct seq_server_site *mdd_seq_site(struct mdd_device *mdd)
458 return mdd2lu_dev(mdd)->ld_site->ld_seq_site;
461 static inline const char *mdd_obj_dev_name(const struct mdd_object *obj)
463 return lu_dev_name(obj->mod_obj.mo_lu.lo_dev);
466 #define MAX_ATIME_DIFF 60
468 static inline int mdd_permission_internal(const struct lu_env *env,
469 struct mdd_object *obj,
470 const struct lu_attr *la, int mask)
472 return __mdd_permission_internal(env, obj, la, mask, -1);
475 static inline int mdd_permission_internal_locked(const struct lu_env *env,
476 struct mdd_object *obj,
477 const struct lu_attr *la,
479 enum mdd_object_role role)
481 return __mdd_permission_internal(env, obj, la, mask, role);
484 /* mdd inline func for calling osd_dt_object ops */
485 static inline int mdo_attr_get(const struct lu_env *env, struct mdd_object *obj,
488 struct dt_object *next = mdd_object_child(obj);
489 return dt_attr_get(env, next, la);
492 static inline int mdo_declare_attr_set(const struct lu_env *env,
493 struct mdd_object *obj,
494 const struct lu_attr *la,
495 struct thandle *handle)
497 struct dt_object *next = mdd_object_child(obj);
498 return dt_declare_attr_set(env, next, la, handle);
501 static inline int mdo_attr_set(const struct lu_env *env,
502 struct mdd_object *obj,
503 const struct lu_attr *la,
504 struct thandle *handle)
506 struct dt_object *next = mdd_object_child(obj);
508 if (!mdd_object_exists(obj))
511 return dt_attr_set(env, next, la, handle);
514 static inline int mdo_xattr_get(const struct lu_env *env,struct mdd_object *obj,
515 struct lu_buf *buf, const char *name)
517 struct dt_object *next = mdd_object_child(obj);
518 return dt_xattr_get(env, next, buf, name);
521 static inline int mdo_declare_xattr_set(const struct lu_env *env,
522 struct mdd_object *obj,
523 const struct lu_buf *buf,
525 int fl, struct thandle *handle)
527 struct dt_object *next = mdd_object_child(obj);
528 return dt_declare_xattr_set(env, next, buf, name, fl, handle);
531 static inline int mdo_xattr_set(const struct lu_env *env,struct mdd_object *obj,
532 const struct lu_buf *buf, const char *name,
533 int fl, struct thandle *handle)
535 struct dt_object *next = mdd_object_child(obj);
537 if (!mdd_object_exists(obj))
540 return dt_xattr_set(env, next, buf, name, fl, handle);
543 static inline int mdo_declare_xattr_del(const struct lu_env *env,
544 struct mdd_object *obj,
546 struct thandle *handle)
548 struct dt_object *next = mdd_object_child(obj);
549 return dt_declare_xattr_del(env, next, name, handle);
552 static inline int mdo_xattr_del(const struct lu_env *env,struct mdd_object *obj,
553 const char *name, struct thandle *handle)
555 struct dt_object *next = mdd_object_child(obj);
557 if (!mdd_object_exists(obj))
560 return dt_xattr_del(env, next, name, handle);
564 mdo_xattr_list(const struct lu_env *env, struct mdd_object *obj,
567 struct dt_object *next = mdd_object_child(obj);
569 if (!mdd_object_exists(obj))
572 return dt_xattr_list(env, next, buf);
576 mdo_invalidate(const struct lu_env *env, struct mdd_object *obj)
578 return dt_invalidate(env, mdd_object_child(obj));
582 int mdo_declare_index_insert(const struct lu_env *env, struct mdd_object *obj,
583 const struct lu_fid *fid, __u32 type,
584 const char *name, struct thandle *handle)
586 struct dt_object *next = mdd_object_child(obj);
590 * if the object doesn't exist yet, then it's supposed to be created
591 * and declaration of the creation should be enough to insert ./..
595 if (dt_try_as_dir(env, next)) {
596 struct dt_insert_rec *rec = &mdd_env_info(env)->mti_dt_rec;
599 rec->rec_type = type;
600 rc = dt_declare_insert(env, next, (const struct dt_rec *)rec,
601 (const struct dt_key *)name, handle);
608 int mdo_declare_index_delete(const struct lu_env *env, struct mdd_object *obj,
609 const char *name, struct thandle *handle)
611 struct dt_object *next = mdd_object_child(obj);
613 if (!dt_try_as_dir(env, next))
616 return dt_declare_delete(env, next, (const struct dt_key *)name,
620 static inline int mdo_declare_ref_add(const struct lu_env *env,
621 struct mdd_object *obj,
622 struct thandle *handle)
624 struct dt_object *next = mdd_object_child(obj);
625 return dt_declare_ref_add(env, next, handle);
628 static inline int mdo_ref_add(const struct lu_env *env, struct mdd_object *obj,
629 struct thandle *handle)
631 struct dt_object *next = mdd_object_child(obj);
633 if (!mdd_object_exists(obj))
636 return dt_ref_add(env, next, handle);
639 static inline int mdo_declare_ref_del(const struct lu_env *env,
640 struct mdd_object *obj,
641 struct thandle *handle)
643 struct dt_object *next = mdd_object_child(obj);
644 return dt_declare_ref_del(env, next, handle);
647 static inline int mdo_ref_del(const struct lu_env *env, struct mdd_object *obj,
648 struct thandle *handle)
650 struct dt_object *next = mdd_object_child(obj);
652 if (!mdd_object_exists(obj))
655 return dt_ref_del(env, next, handle);
659 mdo_declare_create_obj(const struct lu_env *env, struct mdd_object *o,
660 struct lu_attr *attr,
661 struct dt_allocation_hint *hint,
662 struct dt_object_format *dof,
663 struct thandle *handle)
665 struct dt_object *next = mdd_object_child(o);
666 return dt_declare_create(env, next, attr, hint, dof, handle);
670 mdo_create_obj(const struct lu_env *env, struct mdd_object *o,
671 struct lu_attr *attr,
672 struct dt_allocation_hint *hint,
673 struct dt_object_format *dof,
674 struct thandle *handle)
676 struct dt_object *next = mdd_object_child(o);
677 return dt_create(env, next, attr, hint, dof, handle);
681 int mdo_declare_destroy(const struct lu_env *env, struct mdd_object *o,
682 struct thandle *handle)
684 struct dt_object *next = mdd_object_child(o);
685 return dt_declare_destroy(env, next, handle);
689 int mdo_destroy(const struct lu_env *env, struct mdd_object *o,
690 struct thandle *handle)
692 struct dt_object *next = mdd_object_child(o);
693 return dt_destroy(env, next, handle);