lustre/mdd/mdd_internal.h

   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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2011, 2017, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  *
  31  * lustre/mdd/mdd_internal.h
  32  *
  33  * Author: Wang Di <wangdi@clusterfs.com>
  34  */
  35
  36 #ifndef _MDD_INTERNAL_H
  37 #define _MDD_INTERNAL_H
  38
  39 #include <lustre_acl.h>
  40 #include <lustre_compat.h>
  41 #include <md_object.h>
  42 #include <dt_object.h>
  43 #include <lustre_lfsck.h>
  44 #include <lustre_fid.h>
  45 #include <lprocfs_status.h>
  46 #include <lustre_log.h>
  47 #include <lustre_linkea.h>
  48
  49 /* ChangeLog params for automatic purge mechanism */
  50 /* max time allowed for a user to stay idle in seconds */
  51 #define CHLOG_MAX_IDLE_TIME 2592000 /* = 30 days */
  52 /* max gap allowed for a user to stay idle in number of ChangeLog records
  53  * this is an evaluation, assuming that chunk-size is LLOG_MIN_CHUNK_SIZE, of
  54  * the indexes gap for half full changelogs */
  55 #define CHLOG_MAX_IDLE_INDEXES (((LLOG_MIN_CHUNK_SIZE - \
  56                                   offsetof(struct llog_log_hdr, \
  57                                            llh_bitmap[0]) - \
  58                                   sizeof(struct llog_rec_tail)) * 4) * \
  59                                 ((LLOG_MIN_CHUNK_SIZE - \
  60                                   offsetof(struct llog_log_hdr, \
  61                                            llh_bitmap[0]) - \
  62                                   sizeof(struct llog_rec_tail)) * 8))
  63 /* min time in seconds between two gc thread runs if none already started */
  64 #define CHLOG_MIN_GC_INTERVAL 3600
  65 /* minimum number of free ChangeLog catalog entries (ie, between cur and
  66  * last indexes) before starting garbage collect */
  67 #define CHLOG_MIN_FREE_CAT_ENTRIES 2
  68
  69 /* Changelog flags */
  70 /** changelog is recording */
  71 #define CLM_ON    0x00001
  72 /** internal error prevented changelogs from starting */
  73 #define CLM_ERR   0x00002
  74 /* Marker flags */
  75 /** changelogs turned on */
  76 #define CLM_START 0x10000
  77 /** changelogs turned off */
  78 #define CLM_FINI  0x20000
  79 /** some changelog records purged */
  80 #define CLM_PURGE 0x40000
  81 /** changelog cleanup done, to prevent double cleanup */
  82 #define CLM_CLEANUP_DONE 0x80000
  83
  84 #define LLOG_CHANGELOG_HDR_SZ (sizeof(struct llog_changelog_rec) - \
  85                                sizeof(struct changelog_rec))
  86 /* mc_gc_task values */
  87 /** no GC thread to be started **/
  88 #define MDD_CHLG_GC_NONE NULL
  89 /** a GC thread need to be started **/
  90 #define MDD_CHLG_GC_NEED (struct task_struct *)(-1)
  91 /** a GC thread will be started now **/
  92 #define MDD_CHLG_GC_START (struct task_struct *)(-2)
  93 /** else the started task_struct address when running **/
  94
  95 struct mdd_changelog {
  96         spinlock_t              mc_lock;        /* for index */
  97         int                     mc_flags;
  98         __u32                   mc_proc_mask; /* per-server mask set via parameters */
  99         __u32                   mc_current_mask; /* combined global+users */
 100         __u32                   mc_mintime; /* the oldest changelog user time */
 101         __u64                   mc_minrec; /* last known minimal used index */
 102         __u64                   mc_index;
 103         ktime_t                 mc_starttime;
 104         spinlock_t              mc_user_lock;
 105         int                     mc_lastuser;
 106         int                     mc_users;      /* registered users number */
 107         struct task_struct      *mc_gc_task;
 108         time64_t                mc_gc_time;    /* last GC check or run time */
 109         unsigned int            mc_deniednext; /* interval for recording denied
 110                                                 * accesses
 111                                                 */
 112 };
 113
 114 static inline __u64 cl_time(void)
 115 {
 116         struct timespec64 time;
 117
 118         ktime_get_real_ts64(&time);
 119         return (((__u64)time.tv_sec) << 30) + time.tv_nsec;
 120 }
 121
 122 /** Objects in .lustre dir */
 123 struct mdd_dot_lustre_objs {
 124         struct mdd_object *mdd_obf;
 125         struct mdd_object *mdd_lpf;
 126 };
 127
 128 struct mdd_generic_thread {
 129         struct completion       mgt_started;
 130         struct completion       mgt_finished;
 131         void                   *mgt_data;
 132         bool                    mgt_abort;
 133         bool                    mgt_init;
 134 };
 135
 136 struct mdd_device {
 137         struct md_device                 mdd_md_dev;
 138         struct obd_export               *mdd_child_exp;
 139         struct dt_device                *mdd_child;
 140         struct dt_device                *mdd_bottom;
 141         struct lu_fid                    mdd_root_fid; /* /ROOT */
 142         struct lu_fid                    mdd_local_root_fid;
 143         struct dt_device_param           mdd_dt_conf;
 144         struct dt_object                *mdd_orphans; /* PENDING directory */
 145         struct mdd_changelog             mdd_cl;
 146         unsigned int                     mdd_changelog_gc;
 147         time64_t                         mdd_changelog_max_idle_time;
 148         unsigned long                    mdd_changelog_max_idle_indexes;
 149         time64_t                         mdd_changelog_min_gc_interval;
 150         unsigned int                     mdd_changelog_min_free_cat_entries;
 151         time64_t                         mdd_atime_diff;
 152         struct mdd_object               *mdd_dot_lustre;
 153         struct mdd_dot_lustre_objs       mdd_dot_lustre_objs;
 154         unsigned int                     mdd_sync_permission;
 155         int                              mdd_connects;
 156         int                              mdd_append_stripe_count;
 157         char                             mdd_append_pool[LOV_MAXPOOLNAME + 1];
 158         struct local_oid_storage        *mdd_los;
 159         struct mdd_generic_thread        mdd_orphan_cleanup_thread;
 160         struct kobject                   mdd_kobj;
 161         struct kobj_type                 mdd_ktype;
 162         struct completion                mdd_kobj_unregister;
 163 };
 164
 165 enum mod_flags {
 166         /* The dir object has been unlinked */
 167         DEAD_OBJ        = BIT(0),
 168         ORPHAN_OBJ      = BIT(1),
 169         VOLATILE_OBJ    = BIT(4),
 170 };
 171
 172 struct mdd_object {
 173         struct md_object        mod_obj;
 174         /* open count */
 175         u32                     mod_count;
 176         u32                     mod_valid;
 177         ktime_t                 mod_cltime;
 178         unsigned long           mod_flags;
 179         struct list_head        mod_users;  /**< unique user opens */
 180 };
 181
 182 #define MDI_KEEP_KEY    0x01
 183
 184 struct mdd_thread_info {
 185         struct lu_fid             mdi_fid;
 186         struct lu_fid             mdi_fid2; /* used for be & cpu converting */
 187         /**
 188         * only be used by MDD interfaces, can be passed into local MDD APIs.
 189         */
 190         struct lu_attr            mdi_pattr;
 191         struct lu_attr            mdi_cattr;
 192         struct lu_attr            mdi_tpattr;
 193         struct lu_attr            mdi_tattr;
 194         /** used to set ctime/mtime */
 195         struct lu_attr            mdi_la_for_fix;
 196         /* Only used in mdd_object_start */
 197         struct lu_attr            mdi_la_for_start;
 198         /* mdi_ent/mdi_key must be together so mdi_ent::lde_name is mdi_key */
 199         struct lu_dirent          mdi_ent;
 200         char                      mdi_key[NAME_MAX + 16];
 201         int                       mdi_flags;
 202         char                      mdi_name[NAME_MAX + 1];
 203         struct lu_buf             mdi_buf[4];
 204         /* persistent buffers, must be handled with lu_buf_alloc/free */
 205         struct lu_buf             mdi_big_buf;
 206         struct lu_buf             mdi_chlg_buf;
 207         struct lu_buf             mdi_link_buf; /* buf for link ea */
 208         struct lu_buf             mdi_xattr_buf;
 209         struct obdo               mdi_oa;
 210         struct dt_allocation_hint mdi_hint;
 211         struct dt_object_format   mdi_dof;
 212         struct linkea_data        mdi_link_data;
 213         struct md_op_spec         mdi_spec;
 214         struct dt_insert_rec      mdi_dt_rec;
 215         struct lu_seq_range       mdi_range;
 216         struct md_layout_change   mdi_mlc;
 217 };
 218
 219 int mdd_la_get(const struct lu_env *env, struct mdd_object *obj,
 220                struct lu_attr *la);
 221 int mdd_attr_get(const struct lu_env *env, struct md_object *obj,
 222                  struct md_attr *ma);
 223 int mdd_attr_set(const struct lu_env *env, struct md_object *obj,
 224                  const struct md_attr *ma);
 225 int mdd_attr_set_internal(const struct lu_env *env,
 226                           struct mdd_object *obj,
 227                           const struct lu_attr *attr,
 228                           struct thandle *handle,
 229                           int needacl);
 230 int mdd_update_time(const struct lu_env *env, struct mdd_object *obj,
 231                     const struct lu_attr *oattr, struct lu_attr *attr,
 232                     struct thandle *handle);
 233 int mdd_create_object_internal(const struct lu_env *env, struct mdd_object *p,
 234                                struct mdd_object *c, struct lu_attr *attr,
 235                                struct thandle *handle,
 236                                const struct md_op_spec *spec,
 237                                struct dt_allocation_hint *hint);
 238
 239 /* mdd_lock.c */
 240 void mdd_write_lock(const struct lu_env *env, struct mdd_object *obj,
 241                     enum dt_object_role role);
 242 void mdd_read_lock(const struct lu_env *env, struct mdd_object *obj,
 243                    enum dt_object_role role);
 244 void mdd_write_unlock(const struct lu_env *env, struct mdd_object *obj);
 245 void mdd_read_unlock(const struct lu_env *env, struct mdd_object *obj);
 246 int mdd_write_locked(const struct lu_env *env, struct mdd_object *obj);
 247
 248 /* mdd_dir.c */
 249 int mdd_may_create(const struct lu_env *env, struct mdd_object *pobj,
 250                    const struct lu_attr *pattr, struct mdd_object *cobj,
 251                    bool check_perm);
 252 int mdd_may_unlink(const struct lu_env *env, struct mdd_object *pobj,
 253                    const struct lu_attr *pattr, const struct lu_attr *attr);
 254 int mdd_may_delete(const struct lu_env *env, struct mdd_object *tpobj,
 255                    const struct lu_attr *tpattr, struct mdd_object *tobj,
 256                    const struct lu_attr *tattr, const struct lu_attr *cattr,
 257                    int check_perm, int check_empty);
 258 int mdd_unlink_sanity_check(const struct lu_env *env, struct mdd_object *pobj,
 259                             const struct lu_attr *pattr,
 260                             struct mdd_object *cobj,
 261                             const struct lu_attr *cattr);
 262 int mdd_finish_unlink(const struct lu_env *env, struct mdd_object *obj,
 263                       struct md_attr *ma, struct mdd_object *pobj,
 264                       const struct lu_name *lname, struct thandle *th);
 265
 266 int mdd_is_root(struct mdd_device *mdd, const struct lu_fid *fid);
 267 int mdd_lookup(const struct lu_env *env,
 268                struct md_object *pobj, const struct lu_name *lname,
 269                struct lu_fid* fid, struct md_op_spec *spec);
 270 int mdd_links_write(const struct lu_env *env, struct mdd_object *mdd_obj,
 271                     struct linkea_data *ldata, struct thandle *handle);
 272 int mdd_links_read(const struct lu_env *env,
 273                    struct mdd_object *mdd_obj,
 274                    struct linkea_data *ldata);
 275 struct lu_buf *mdd_links_get(const struct lu_env *env,
 276                              struct mdd_object *mdd_obj);
 277 int mdd_links_rename(const struct lu_env *env,
 278                      struct mdd_object *mdd_obj,
 279                      const struct lu_fid *oldpfid,
 280                      const struct lu_name *oldlname,
 281                      const struct lu_fid *newpfid,
 282                      const struct lu_name *newlname,
 283                      struct thandle *handle,
 284                      struct linkea_data *ldata,
 285                      int first, int check);
 286 int mdd_dir_layout_shrink(const struct lu_env *env,
 287                           struct md_object *md_obj,
 288                           struct md_layout_change *mlc);
 289 int mdd_dir_layout_split(const struct lu_env *env, struct md_object *o,
 290                          struct md_layout_change *mlc);
 291
 292 int mdd_changelog_write_rec(const struct lu_env *env,
 293                             struct llog_handle *loghandle,
 294                             struct llog_rec_hdr *rec,
 295                             struct llog_cookie *cookie,
 296                             int idx, struct thandle *th);
 297
 298 struct mdd_thread_info *mdd_env_info(const struct lu_env *env);
 299
 300 #define MDD_ENV_VAR(env, var) (&mdd_env_info(env)->mdi_##var)
 301
 302 struct lu_buf *mdd_buf_get(const struct lu_env *env, void *area, ssize_t len);
 303 const struct lu_buf *mdd_buf_get_const(const struct lu_env *env,
 304                                        const void *area, ssize_t len);
 305
 306 int mdd_orphan_cleanup(const struct lu_env *env, struct mdd_device *d);
 307 int mdd_orphan_insert(const struct lu_env *env, struct mdd_object *obj,
 308                       struct thandle *thandle);
 309 int mdd_orphan_delete(const struct lu_env *env, struct mdd_object *obj,
 310                       struct thandle *thandle);
 311 int mdd_orphan_index_init(const struct lu_env *env, struct mdd_device *mdd);
 312 void mdd_orphan_index_fini(const struct lu_env *env, struct mdd_device *mdd);
 313 int mdd_orphan_declare_insert(const struct lu_env *env, struct mdd_object *obj,
 314                               umode_t mode, struct thandle *thandle);
 315 int mdd_orphan_declare_delete(const struct lu_env *env, struct mdd_object *obj,
 316                               struct thandle *thandle);
 317 int mdd_dir_is_empty(const struct lu_env *env, struct mdd_object *dir);
 318
 319 /* mdd_lproc.c */
 320 int mdd_procfs_init(struct mdd_device *mdd, const char *name);
 321 void mdd_procfs_fini(struct mdd_device *mdd);
 322
 323 /* mdd_object.c */
 324 extern struct kmem_cache *mdd_object_kmem;
 325 extern const struct md_dir_operations    mdd_dir_ops;
 326 extern const struct md_object_operations mdd_obj_ops;
 327 int mdd_readlink(const struct lu_env *env, struct md_object *obj,
 328                  struct lu_buf *buf);
 329 extern struct lu_context_key mdd_thread_key;
 330 extern const struct lu_device_operations mdd_lu_ops;
 331
 332 struct mdd_object *mdd_object_find(const struct lu_env *env,
 333                                    struct mdd_device *d,
 334                                    const struct lu_fid *f);
 335 int mdd_readpage(const struct lu_env *env, struct md_object *obj,
 336                  const struct lu_rdpg *rdpg);
 337 int mdd_declare_changelog_store(const struct lu_env *env,
 338                                 struct mdd_device *mdd,
 339                                 enum changelog_rec_type type,
 340                                 const struct lu_name *tname,
 341                                 const struct lu_name *sname,
 342                                 struct thandle *handle);
 343 void mdd_changelog_rec_ext_jobid(struct changelog_rec *rec, const char *jobid);
 344 void mdd_changelog_rec_ext_extra_flags(struct changelog_rec *rec, __u64 eflags);
 345 void mdd_changelog_rec_extra_uidgid(struct changelog_rec *rec,
 346                                     __u64 uid, __u64 gid);
 347 void mdd_changelog_rec_extra_nid(struct changelog_rec *rec,
 348                                  lnet_nid_t nid);
 349 void mdd_changelog_rec_extra_omode(struct changelog_rec *rec, u32 flags);
 350 void mdd_changelog_rec_extra_xattr(struct changelog_rec *rec,
 351                                    const char *xattr_name);
 352 int mdd_changelog_store(const struct lu_env *env, struct mdd_device *mdd,
 353                         struct llog_changelog_rec *rec, struct thandle *th);
 354 int mdd_changelog_data_store(const struct lu_env *env, struct mdd_device *mdd,
 355                              enum changelog_rec_type type,
 356                              enum changelog_rec_flags clf_flags,
 357                              struct mdd_object *mdd_obj,
 358                              struct thandle *handle,
 359                              const struct lu_fid *pfid);
 360 int mdd_changelog_ns_store(const struct lu_env *env, struct mdd_device *mdd,
 361                            enum changelog_rec_type type,
 362                            enum changelog_rec_flags clf_flags,
 363                            struct mdd_object *target,
 364                            const struct lu_fid *tpfid,
 365                            const struct lu_fid *sfid,
 366                            const struct lu_fid *spfid,
 367                            const struct lu_name *tname,
 368                            const struct lu_name *sname,
 369                            struct thandle *handle);
 370 int mdd_invalidate(const struct lu_env *env, struct md_object *obj);
 371 int mdd_declare_create_object_internal(const struct lu_env *env,
 372                                        struct mdd_object *p,
 373                                        struct mdd_object *c,
 374                                        struct lu_attr *attr,
 375                                        struct thandle *handle,
 376                                        const struct md_op_spec *spec,
 377                                        struct dt_allocation_hint *hint);
 378 int mdd_stripe_get(const struct lu_env *env, struct mdd_object *obj,
 379                    struct lu_buf *lmm_buf, const char *name);
 380 int mdd_changelog_data_store_xattr(const struct lu_env *env,
 381                                    struct mdd_device *mdd,
 382                                    enum changelog_rec_type type,
 383                                    enum changelog_rec_flags clf_flags,
 384                                    struct mdd_object *mdd_obj,
 385                                    const char *xattr_name,
 386                                    struct thandle *handle);
 387
 388 /* mdd_trans.c */
 389 void mdd_object_make_hint(const struct lu_env *env, struct mdd_object *parent,
 390                           struct mdd_object *child, const struct lu_attr *attr,
 391                           const struct md_op_spec *spec,
 392                           struct dt_allocation_hint *hint);
 393
 394 static inline void mdd_object_get(struct mdd_object *o)
 395 {
 396         lu_object_get(&o->mod_obj.mo_lu);
 397 }
 398
 399 static inline void mdd_object_put(const struct lu_env *env,
 400                                   struct mdd_object *o)
 401 {
 402         lu_object_put(env, &o->mod_obj.mo_lu);
 403 }
 404
 405 struct thandle *mdd_trans_create(const struct lu_env *env,
 406                                  struct mdd_device *mdd);
 407 int mdd_trans_start(const struct lu_env *env, struct mdd_device *mdd,
 408                     struct thandle *th);
 409 int mdd_trans_stop(const struct lu_env *env, struct mdd_device *mdd,
 410                    int rc, struct thandle *handle);
 411
 412 /* mdd_device.c */
 413 struct lu_object *mdd_object_alloc(const struct lu_env *env,
 414                                    const struct lu_object_header *hdr,
 415                                    struct lu_device *d);
 416 int mdd_local_file_create(const struct lu_env *env, struct mdd_device *mdd,
 417                           const struct lu_fid *pfid, const char *name,
 418                           __u32 mode, struct lu_fid *fid);
 419
 420 int mdd_acl_chmod(const struct lu_env *env, struct mdd_object *o, __u32 mode,
 421                   struct thandle *handle);
 422 int mdd_acl_set(const struct lu_env *env, struct mdd_object *obj,
 423                 struct lu_attr *attr, const struct lu_buf *buf, int fl);
 424 int __mdd_fix_mode_acl(const struct lu_env *env, struct lu_buf *buf,
 425                        __u32 *mode);
 426 int __mdd_permission_internal(const struct lu_env *env, struct mdd_object *obj,
 427                               const struct lu_attr *la, unsigned int may_mask,
 428                               int role);
 429 int mdd_permission(const struct lu_env *env, struct md_object *pobj,
 430                    struct md_object *cobj, struct md_attr *ma,
 431                    unsigned int may_mask);
 432 int mdd_generic_thread_start(struct mdd_generic_thread *thread,
 433                              int (*func)(void *), void *data, char *name);
 434 void mdd_generic_thread_stop(struct mdd_generic_thread *thread);
 435 int mdd_changelog_user_purge(const struct lu_env *env, struct mdd_device *mdd,
 436                              __u32 id);
 437 char *mdd_chlg_username(struct llog_changelog_user_rec2 *rec, char *buf,
 438                         size_t len);
 439 __u32 mdd_chlg_usermask(struct llog_changelog_user_rec2 *rec);
 440 int mdd_changelog_recalc_mask(const struct lu_env *env, struct mdd_device *mdd);
 441
 442 /* mdd_prepare.c */
 443 int mdd_compat_fixes(const struct lu_env *env, struct mdd_device *mdd);
 444
 445 /* acl.c */
 446 extern int lustre_posix_acl_permission(struct lu_ucred *mu,
 447                                        const struct lu_attr *la,
 448                                        unsigned int may_mask,
 449                                        posix_acl_xattr_entry *entry,
 450                                        int count);
 451 extern int lustre_posix_acl_chmod_masq(posix_acl_xattr_entry *entry,
 452                                        __u32 mode, int count);
 453 extern int lustre_posix_acl_create_masq(posix_acl_xattr_entry *entry,
 454                                         __u32 *pmode, int count);
 455 extern int lustre_posix_acl_equiv_mode(posix_acl_xattr_entry *entry,
 456                                        mode_t *mode_p, int count);
 457
 458 /* inline functions */
 459 static inline int lu_device_is_mdd(struct lu_device *d)
 460 {
 461         return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &mdd_lu_ops);
 462 }
 463
 464 static inline struct mdd_device *lu2mdd_dev(struct lu_device *d)
 465 {
 466         LASSERT(lu_device_is_mdd(d));
 467         return container_of_safe(d, struct mdd_device, mdd_md_dev.md_lu_dev);
 468 }
 469
 470 static inline struct lu_device *mdd2lu_dev(struct mdd_device *mdd)
 471 {
 472         return &mdd->mdd_md_dev.md_lu_dev;
 473 }
 474
 475 static inline struct mdd_object *lu2mdd_obj(struct lu_object *o)
 476 {
 477         LASSERT(ergo(o != NULL, lu_device_is_mdd(o->lo_dev)));
 478         return container_of_safe(o, struct mdd_object,
 479                                  mod_obj.mo_lu);
 480 }
 481
 482 static inline struct mdd_device *mdo2mdd(struct md_object *mdo)
 483 {
 484         return lu2mdd_dev(mdo->mo_lu.lo_dev);
 485 }
 486
 487 static inline struct mdd_object *md2mdd_obj(struct md_object *mdo)
 488 {
 489         return container_of_safe(mdo, struct mdd_object, mod_obj);
 490 }
 491
 492 static inline const
 493 struct dt_device_operations *mdd_child_ops(struct mdd_device *mdd)
 494 {
 495         return mdd->mdd_child->dd_ops;
 496 }
 497
 498 static inline struct lu_object *mdd2lu_obj(struct mdd_object *obj)
 499 {
 500         return &obj->mod_obj.mo_lu;
 501 }
 502
 503 static inline struct dt_object *mdd_object_child(struct mdd_object *obj)
 504 {
 505         return container_of(lu_object_next(mdd2lu_obj(obj)),
 506                             struct dt_object, do_lu);
 507 }
 508
 509 static inline struct obd_device *mdd2obd_dev(struct mdd_device *mdd)
 510 {
 511         return (mdd->mdd_md_dev.md_lu_dev.ld_obd);
 512 }
 513
 514 static inline struct mdd_device *mdd_obj2mdd_dev(struct mdd_object *obj)
 515 {
 516         return mdo2mdd(&obj->mod_obj);
 517 }
 518
 519 static inline umode_t mdd_object_type(const struct mdd_object *mdd_obj)
 520 {
 521         return lu_object_attr(&mdd_obj->mod_obj.mo_lu);
 522 }
 523
 524 static inline int mdd_is_dead_obj(struct mdd_object *mdd_obj)
 525 {
 526         return mdd_obj && mdd_obj->mod_flags & DEAD_OBJ;
 527 }
 528
 529 static inline bool mdd_is_volatile_obj(struct mdd_object *mdd_obj)
 530 {
 531         return mdd_obj->mod_flags & VOLATILE_OBJ;
 532 }
 533
 534 static inline bool mdd_is_orphan_obj(struct mdd_object *mdd_obj)
 535 {
 536         return mdd_obj->mod_flags & ORPHAN_OBJ;
 537 }
 538
 539 static inline int mdd_object_exists(struct mdd_object *mdd_obj)
 540 {
 541         return lu_object_exists(mdd2lu_obj(mdd_obj));
 542 }
 543
 544 static inline int mdd_object_remote(struct mdd_object *mdd_obj)
 545 {
 546         return lu_object_remote(mdd2lu_obj(mdd_obj));
 547 }
 548
 549 static inline const struct lu_fid *mdd_object_fid(struct mdd_object *mdd_obj)
 550 {
 551         return lu_object_fid(mdd2lu_obj(mdd_obj));
 552 }
 553
 554 static inline struct seq_server_site *mdd_seq_site(struct mdd_device *mdd)
 555 {
 556         return mdd2lu_dev(mdd)->ld_site->ld_seq_site;
 557 }
 558
 559 static inline const char *mdd_obj_dev_name(const struct mdd_object *mdd_obj)
 560 {
 561         return lu_dev_name(mdd_obj->mod_obj.mo_lu.lo_dev);
 562 }
 563
 564 #define MAX_ATIME_DIFF 60
 565
 566 static inline int mdd_permission_internal(const struct lu_env *env,
 567                                           struct mdd_object *obj,
 568                                           const struct lu_attr *la,
 569                                           unsigned int may_mask)
 570 {
 571         return __mdd_permission_internal(env, obj, la, may_mask, -1);
 572 }
 573
 574 static inline int mdd_permission_internal_locked(const struct lu_env *env,
 575                                                 struct mdd_object *obj,
 576                                                 const struct lu_attr *la,
 577                                                 unsigned int may_mask,
 578                                                 enum dt_object_role role)
 579 {
 580         return __mdd_permission_internal(env, obj, la, may_mask, role);
 581 }
 582
 583 /* mdd inline func for calling osd_dt_object ops */
 584 static inline int mdo_attr_get(const struct lu_env *env, struct mdd_object *obj,
 585                                struct lu_attr *la)
 586 {
 587         struct dt_object *next = mdd_object_child(obj);
 588         return dt_attr_get(env, next, la);
 589 }
 590
 591 static inline int mdo_declare_attr_set(const struct lu_env *env,
 592                                        struct mdd_object *obj,
 593                                        const struct lu_attr *la,
 594                                        struct thandle *handle)
 595 {
 596         struct dt_object *next = mdd_object_child(obj);
 597         return dt_declare_attr_set(env, next, la, handle);
 598 }
 599
 600 static inline int mdo_attr_set(const struct lu_env *env,
 601                                struct mdd_object *obj,
 602                                const struct lu_attr *la,
 603                                struct thandle *handle)
 604 {
 605         struct dt_object *next = mdd_object_child(obj);
 606
 607         if (!mdd_object_exists(obj))
 608                 return -ENOENT;
 609
 610         return dt_attr_set(env, next, la, handle);
 611 }
 612
 613 static inline int mdo_xattr_get(const struct lu_env *env,struct mdd_object *obj,
 614                                 struct lu_buf *buf, const char *name)
 615 {
 616         struct dt_object *next = mdd_object_child(obj);
 617         return dt_xattr_get(env, next, buf, name);
 618 }
 619
 620 static inline int mdo_declare_xattr_set(const struct lu_env *env,
 621                                         struct mdd_object *obj,
 622                                         const struct lu_buf *buf,
 623                                         const char *name,
 624                                         int fl, struct thandle *handle)
 625 {
 626         struct dt_object *next = mdd_object_child(obj);
 627         int rc;
 628
 629         rc = dt_declare_xattr_set(env, next, buf, name, fl, handle);
 630         if (rc >= 0 &&
 631             (strcmp(name, LL_XATTR_NAME_ENCRYPTION_CONTEXT) == 0 ||
 632              strcmp(name, LL_XATTR_NAME_ENCRYPTION_CONTEXT_OLD) == 0)) {
 633                 struct lu_attr la = { 0 };
 634
 635                 la.la_valid = LA_FLAGS;
 636                 la.la_flags = LUSTRE_ENCRYPT_FL;
 637                 rc = dt_declare_attr_set(env, next, &la, handle);
 638         }
 639         return rc;
 640 }
 641
 642 static inline int mdo_xattr_set(const struct lu_env *env,struct mdd_object *obj,
 643                                 const struct lu_buf *buf, const char *name,
 644                                 int fl, struct thandle *handle)
 645 {
 646         struct dt_object *next = mdd_object_child(obj);
 647         int rc = 0;
 648
 649         if (!mdd_object_exists(obj))
 650                 return -ENOENT;
 651
 652         /* If we are about to set the LL_XATTR_NAME_ENCRYPTION_CONTEXT
 653          * xattr, it means the file/dir is encrypted. In that case we want
 654          * to set the LUSTRE_ENCRYPT_FL flag as well: it will be stored
 655          * into the LMA, making it more efficient to recognise we are
 656          * dealing with an encrypted file/dir, as LMA info is cached upon
 657          * object init.
 658          * However, marking a dir as encrypted is only possible if it is
 659          * being created or migrated (LU_XATTR_CREATE flag not set), or
 660          * if it is empty.
 661          */
 662         if ((strcmp(name, LL_XATTR_NAME_ENCRYPTION_CONTEXT) == 0 ||
 663              strcmp(name, LL_XATTR_NAME_ENCRYPTION_CONTEXT_OLD) == 0) &&
 664             (!S_ISDIR(mdd_object_type(obj)) ||
 665              !(fl & LU_XATTR_CREATE) ||
 666              (rc = mdd_dir_is_empty(env, obj)) == 0)) {
 667                 struct lu_attr la = { 0 };
 668
 669                 la.la_valid = LA_FLAGS;
 670                 la.la_flags = LUSTRE_ENCRYPT_FL;
 671                 /* if this is an old client using the old enc xattr name,
 672                  * switch to the new name for consistency
 673                  */
 674                 if (strcmp(name, LL_XATTR_NAME_ENCRYPTION_CONTEXT_OLD) == 0)
 675                         name = LL_XATTR_NAME_ENCRYPTION_CONTEXT;
 676                 rc = dt_attr_set(env, next, &la, handle);
 677         }
 678         if (rc >= 0)
 679                 rc = dt_xattr_set(env, next, buf, name, fl, handle);
 680
 681         return rc;
 682 }
 683
 684 static inline int mdo_declare_xattr_del(const struct lu_env *env,
 685                                         struct mdd_object *obj,
 686                                         const char *name,
 687                                         struct thandle *handle)
 688 {
 689         struct dt_object *next = mdd_object_child(obj);
 690         return dt_declare_xattr_del(env, next, name, handle);
 691 }
 692
 693 static inline int mdo_xattr_del(const struct lu_env *env,struct mdd_object *obj,
 694                                 const char *name, struct thandle *handle)
 695 {
 696         struct dt_object *next = mdd_object_child(obj);
 697
 698         if (!mdd_object_exists(obj))
 699                 return -ENOENT;
 700
 701         return dt_xattr_del(env, next, name, handle);
 702 }
 703
 704 static inline int
 705 mdo_xattr_list(const struct lu_env *env, struct mdd_object *obj,
 706                struct lu_buf *buf)
 707 {
 708         struct dt_object *next = mdd_object_child(obj);
 709
 710         if (!mdd_object_exists(obj))
 711                 return -ENOENT;
 712
 713         return dt_xattr_list(env, next, buf);
 714 }
 715
 716 static inline int
 717 mdo_invalidate(const struct lu_env *env, struct mdd_object *obj)
 718 {
 719         return dt_invalidate(env, mdd_object_child(obj));
 720 }
 721
 722 static inline int
 723 mdo_declare_layout_change(const struct lu_env *env, struct mdd_object *obj,
 724                           struct md_layout_change *mlc, struct thandle *handle)
 725 {
 726         return dt_declare_layout_change(env, mdd_object_child(obj),
 727                                         mlc, handle);
 728 }
 729
 730 static inline int
 731 mdo_layout_change(const struct lu_env *env, struct mdd_object *obj,
 732                   struct md_layout_change *mlc, struct thandle *handle)
 733 {
 734         return dt_layout_change(env, mdd_object_child(obj), mlc, handle);
 735 }
 736
 737 static inline
 738 int mdo_declare_index_insert(const struct lu_env *env, struct mdd_object *obj,
 739                              const struct lu_fid *fid, __u32 type,
 740                              const char *name, struct thandle *handle)
 741 {
 742         struct dt_object *next  = mdd_object_child(obj);
 743         int               rc;
 744
 745         /*
 746          * if the object doesn't exist yet, then it's supposed to be created
 747          * and declaration of the creation should be enough to insert ./..
 748          */
 749
 750         rc = -ENOTDIR;
 751         if (dt_try_as_dir(env, next, false)) {
 752                 struct dt_insert_rec *rec = &mdd_env_info(env)->mdi_dt_rec;
 753
 754                 rec->rec_fid = fid;
 755                 rec->rec_type = type;
 756                 rc = dt_declare_insert(env, next, (const struct dt_rec *)rec,
 757                                        (const struct dt_key *)name, handle);
 758         }
 759
 760          return rc;
 761 }
 762
 763 static inline
 764 int mdo_declare_index_delete(const struct lu_env *env, struct mdd_object *obj,
 765                              const char *name, struct thandle *handle)
 766 {
 767         struct dt_object *next = mdd_object_child(obj);
 768
 769         if (!dt_try_as_dir(env, next, true))
 770                 return -ENOTDIR;
 771
 772         return dt_declare_delete(env, next, (const struct dt_key *)name,
 773                                  handle);
 774 }
 775
 776 static inline int mdo_declare_ref_add(const struct lu_env *env,
 777                                       struct mdd_object *obj,
 778                                       struct thandle *handle)
 779 {
 780         struct dt_object *next = mdd_object_child(obj);
 781         return dt_declare_ref_add(env, next, handle);
 782 }
 783
 784 static inline int mdo_ref_add(const struct lu_env *env, struct mdd_object *obj,
 785                               struct thandle *handle)
 786 {
 787         struct dt_object *next = mdd_object_child(obj);
 788
 789         if (!mdd_object_exists(obj))
 790                 return -ENOENT;
 791
 792         return dt_ref_add(env, next, handle);
 793 }
 794
 795 static inline int mdo_declare_ref_del(const struct lu_env *env,
 796                                       struct mdd_object *obj,
 797                                       struct thandle *handle)
 798 {
 799         struct dt_object *next = mdd_object_child(obj);
 800         return dt_declare_ref_del(env, next, handle);
 801 }
 802
 803 static inline int mdo_ref_del(const struct lu_env *env, struct mdd_object *obj,
 804                               struct thandle *handle)
 805 {
 806         struct dt_object *next = mdd_object_child(obj);
 807
 808         if (!mdd_object_exists(obj))
 809                 return -ENOENT;
 810
 811         return dt_ref_del(env, next, handle);
 812 }
 813
 814 static inline int
 815 mdo_declare_create_object(const struct lu_env *env, struct mdd_object *obj,
 816                           struct lu_attr *attr, struct dt_allocation_hint *hint,
 817                           struct dt_object_format *dof, struct thandle *handle)
 818 {
 819         struct dt_object *next = mdd_object_child(obj);
 820         return dt_declare_create(env, next, attr, hint, dof, handle);
 821 }
 822
 823 static inline int
 824 mdo_create_object(const struct lu_env *env, struct mdd_object *obj,
 825                   struct lu_attr *attr, struct dt_allocation_hint *hint,
 826                   struct dt_object_format *dof, struct thandle *handle)
 827 {
 828         struct dt_object *next = mdd_object_child(obj);
 829         return dt_create(env, next, attr, hint, dof, handle);
 830 }
 831
 832 static inline
 833 int mdo_declare_destroy(const struct lu_env *env, struct mdd_object *o,
 834                         struct thandle *handle)
 835 {
 836         struct dt_object *next = mdd_object_child(o);
 837         return dt_declare_destroy(env, next, handle);
 838 }
 839
 840 static inline
 841 int mdo_destroy(const struct lu_env *env, struct mdd_object *o,
 842                 struct thandle *handle)
 843 {
 844         struct dt_object *next = mdd_object_child(o);
 845         return dt_destroy(env, next, handle);
 846 }
 847
 848 static inline bool mdd_changelog_enabled(const struct lu_env *env,
 849                                         struct mdd_device *mdd,
 850                                         enum changelog_rec_type type)
 851 {
 852         const struct lu_ucred *uc;
 853
 854         if ((mdd->mdd_cl.mc_flags & CLM_ON) &&
 855             (mdd->mdd_cl.mc_current_mask & BIT(type))) {
 856                 uc = lu_ucred_check(env);
 857
 858                 return uc != NULL ? uc->uc_enable_audit : true;
 859         } else {
 860                 return false;
 861         }
 862 }
 863
 864 static inline bool mdd_changelog_is_too_idle(struct mdd_device *mdd,
 865                                              __u64 cl_rec, __u32 cl_time)
 866 {
 867         __u64 idle_indexes = mdd->mdd_cl.mc_index - cl_rec;
 868         __u32 idle_time = (__u32)ktime_get_real_seconds() - cl_time;
 869
 870         return (idle_indexes > mdd->mdd_changelog_max_idle_indexes ||
 871                 idle_time > mdd->mdd_changelog_max_idle_time ||
 872                 idle_time * idle_indexes > (24 * 3600ULL << 32));
 873 }
 874
 875 #endif