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                                          /* emrg GC is in progress */
 148         bool                             mdd_changelog_emrg_gc;
 149                                          /* don't use GC by free space */
 150         bool                             mdd_changelog_free_space_gc;
 151         time64_t                         mdd_changelog_max_idle_time;
 152         unsigned long                    mdd_changelog_max_idle_indexes;
 153         time64_t                         mdd_changelog_min_gc_interval;
 154         unsigned int                     mdd_changelog_min_free_cat_entries;
 155         time64_t                         mdd_atime_diff;
 156         struct mdd_object               *mdd_dot_lustre;
 157         struct mdd_dot_lustre_objs       mdd_dot_lustre_objs;
 158         unsigned int                     mdd_sync_permission;
 159         int                              mdd_connects;
 160         int                              mdd_append_stripe_count;
 161         char                             mdd_append_pool[LOV_MAXPOOLNAME + 1];
 162         struct local_oid_storage        *mdd_los;
 163         struct mdd_generic_thread        mdd_orphan_cleanup_thread;
 164         struct kobject                   mdd_kobj;
 165         struct kobj_type                 mdd_ktype;
 166         struct completion                mdd_kobj_unregister;
 167 };
 168
 169 enum mod_flags {
 170         /* The dir object has been unlinked */
 171         DEAD_OBJ        = BIT(0),
 172         ORPHAN_OBJ      = BIT(1),
 173         VOLATILE_OBJ    = BIT(4),
 174 };
 175
 176 struct mdd_object {
 177         struct md_object        mod_obj;
 178         /* open count */
 179         u32                     mod_count;
 180         u32                     mod_valid;
 181         ktime_t                 mod_cltime;
 182         unsigned long           mod_flags;
 183         struct list_head        mod_users;  /**< unique user opens */
 184 };
 185
 186 #define MDI_KEEP_KEY    0x01
 187
 188 struct mdd_thread_info {
 189         struct lu_fid             mdi_fid;
 190         struct lu_fid             mdi_fid2; /* used for be & cpu converting */
 191         /**
 192         * only be used by MDD interfaces, can be passed into local MDD APIs.
 193         */
 194         struct lu_attr            mdi_pattr;
 195         struct lu_attr            mdi_cattr;
 196         struct lu_attr            mdi_tpattr;
 197         struct lu_attr            mdi_tattr;
 198         /** used to set ctime/mtime */
 199         struct lu_attr            mdi_la_for_fix;
 200         /* Only used in mdd_object_start */
 201         struct lu_attr            mdi_la_for_start;
 202         /* mdi_ent/mdi_key must be together so mdi_ent::lde_name is mdi_key */
 203         struct lu_dirent          mdi_ent;
 204         char                      mdi_key[NAME_MAX + 16];
 205         int                       mdi_flags;
 206         char                      mdi_name[NAME_MAX + 1];
 207         struct lu_buf             mdi_buf[4];
 208         /* persistent buffers, must be handled with lu_buf_alloc/free */
 209         struct lu_buf             mdi_big_buf;
 210         struct lu_buf             mdi_chlg_buf;
 211         struct lu_buf             mdi_link_buf; /* buf for link ea */
 212         struct lu_buf             mdi_xattr_buf;
 213         struct obdo               mdi_oa;
 214         struct dt_allocation_hint mdi_hint;
 215         struct dt_object_format   mdi_dof;
 216         struct linkea_data        mdi_link_data;
 217         struct md_op_spec         mdi_spec;
 218         struct dt_insert_rec      mdi_dt_rec;
 219         struct lu_seq_range       mdi_range;
 220         struct md_layout_change   mdi_mlc;
 221 };
 222
 223 int mdd_la_get(const struct lu_env *env, struct mdd_object *obj,
 224                struct lu_attr *la);
 225 int mdd_attr_get(const struct lu_env *env, struct md_object *obj,
 226                  struct md_attr *ma);
 227 int mdd_attr_set(const struct lu_env *env, struct md_object *obj,
 228                  const struct md_attr *ma);
 229 int mdd_attr_set_internal(const struct lu_env *env,
 230                           struct mdd_object *obj,
 231                           const struct lu_attr *attr,
 232                           struct thandle *handle,
 233                           int needacl);
 234 int mdd_update_time(const struct lu_env *env, struct mdd_object *obj,
 235                     const struct lu_attr *oattr, struct lu_attr *attr,
 236                     struct thandle *handle);
 237 int mdd_create_object_internal(const struct lu_env *env, struct mdd_object *p,
 238                                struct mdd_object *c, struct lu_attr *attr,
 239                                struct thandle *handle,
 240                                const struct md_op_spec *spec,
 241                                struct dt_allocation_hint *hint);
 242
 243 /* mdd_lock.c */
 244 void mdd_write_lock(const struct lu_env *env, struct mdd_object *obj,
 245                     enum dt_object_role role);
 246 void mdd_read_lock(const struct lu_env *env, struct mdd_object *obj,
 247                    enum dt_object_role role);
 248 void mdd_write_unlock(const struct lu_env *env, struct mdd_object *obj);
 249 void mdd_read_unlock(const struct lu_env *env, struct mdd_object *obj);
 250 int mdd_write_locked(const struct lu_env *env, struct mdd_object *obj);
 251
 252 /* mdd_dir.c */
 253 int mdd_may_create(const struct lu_env *env, struct mdd_object *pobj,
 254                    const struct lu_attr *pattr, struct mdd_object *cobj,
 255                    bool check_perm);
 256 int mdd_may_unlink(const struct lu_env *env, struct mdd_object *pobj,
 257                    const struct lu_attr *pattr, const struct lu_attr *attr);
 258 int mdd_may_delete(const struct lu_env *env, struct mdd_object *tpobj,
 259                    const struct lu_attr *tpattr, struct mdd_object *tobj,
 260                    const struct lu_attr *tattr, const struct lu_attr *cattr,
 261                    int check_perm, int check_empty);
 262 int mdd_unlink_sanity_check(const struct lu_env *env, struct mdd_object *pobj,
 263                             const struct lu_attr *pattr,
 264                             struct mdd_object *cobj,
 265                             const struct lu_attr *cattr);
 266 int mdd_finish_unlink(const struct lu_env *env, struct mdd_object *obj,
 267                       struct md_attr *ma, struct mdd_object *pobj,
 268                       const struct lu_name *lname, struct thandle *th);
 269
 270 int mdd_is_root(struct mdd_device *mdd, const struct lu_fid *fid);
 271 int mdd_lookup(const struct lu_env *env,
 272                struct md_object *pobj, const struct lu_name *lname,
 273                struct lu_fid* fid, struct md_op_spec *spec);
 274 int mdd_links_write(const struct lu_env *env, struct mdd_object *mdd_obj,
 275                     struct linkea_data *ldata, struct thandle *handle);
 276 int mdd_links_read(const struct lu_env *env,
 277                    struct mdd_object *mdd_obj,
 278                    struct linkea_data *ldata);
 279 struct lu_buf *mdd_links_get(const struct lu_env *env,
 280                              struct mdd_object *mdd_obj);
 281 int mdd_links_rename(const struct lu_env *env,
 282                      struct mdd_object *mdd_obj,
 283                      const struct lu_fid *oldpfid,
 284                      const struct lu_name *oldlname,
 285                      const struct lu_fid *newpfid,
 286                      const struct lu_name *newlname,
 287                      struct thandle *handle,
 288                      struct linkea_data *ldata,
 289                      int first, int check);
 290 int mdd_dir_layout_shrink(const struct lu_env *env,
 291                           struct md_object *md_obj,
 292                           struct md_layout_change *mlc);
 293 int mdd_dir_layout_split(const struct lu_env *env, struct md_object *o,
 294                          struct md_layout_change *mlc);
 295
 296 int mdd_changelog_write_rec(const struct lu_env *env,
 297                             struct llog_handle *loghandle,
 298                             struct llog_rec_hdr *rec,
 299                             struct llog_cookie *cookie,
 300                             int idx, struct thandle *th);
 301
 302 struct mdd_thread_info *mdd_env_info(const struct lu_env *env);
 303
 304 #define MDD_ENV_VAR(env, var) (&mdd_env_info(env)->mdi_##var)
 305
 306 struct lu_buf *mdd_buf_get(const struct lu_env *env, void *area, ssize_t len);
 307 const struct lu_buf *mdd_buf_get_const(const struct lu_env *env,
 308                                        const void *area, ssize_t len);
 309
 310 int mdd_orphan_cleanup(const struct lu_env *env, struct mdd_device *d);
 311 int mdd_orphan_insert(const struct lu_env *env, struct mdd_object *obj,
 312                       struct thandle *thandle);
 313 int mdd_orphan_delete(const struct lu_env *env, struct mdd_object *obj,
 314                       struct thandle *thandle);
 315 int mdd_orphan_index_init(const struct lu_env *env, struct mdd_device *mdd);
 316 void mdd_orphan_index_fini(const struct lu_env *env, struct mdd_device *mdd);
 317 int mdd_orphan_declare_insert(const struct lu_env *env, struct mdd_object *obj,
 318                               umode_t mode, struct thandle *thandle);
 319 int mdd_orphan_declare_delete(const struct lu_env *env, struct mdd_object *obj,
 320                               struct thandle *thandle);
 321 int mdd_dir_is_empty(const struct lu_env *env, struct mdd_object *dir);
 322
 323 /* mdd_lproc.c */
 324 int mdd_procfs_init(struct mdd_device *mdd, const char *name);
 325 void mdd_procfs_fini(struct mdd_device *mdd);
 326
 327 /* mdd_object.c */
 328 extern struct kmem_cache *mdd_object_kmem;
 329 extern const struct md_dir_operations    mdd_dir_ops;
 330 extern const struct md_object_operations mdd_obj_ops;
 331 int mdd_readlink(const struct lu_env *env, struct md_object *obj,
 332                  struct lu_buf *buf);
 333 extern struct lu_context_key mdd_thread_key;
 334 extern const struct lu_device_operations mdd_lu_ops;
 335
 336 struct mdd_object *mdd_object_find(const struct lu_env *env,
 337                                    struct mdd_device *d,
 338                                    const struct lu_fid *f);
 339 int mdd_readpage(const struct lu_env *env, struct md_object *obj,
 340                  const struct lu_rdpg *rdpg);
 341 int mdd_declare_changelog_store(const struct lu_env *env,
 342                                 struct mdd_device *mdd,
 343                                 enum changelog_rec_type type,
 344                                 const struct lu_name *tname,
 345                                 const struct lu_name *sname,
 346                                 struct thandle *handle);
 347 void mdd_changelog_rec_ext_jobid(struct changelog_rec *rec, const char *jobid);
 348 void mdd_changelog_rec_ext_extra_flags(struct changelog_rec *rec, __u64 eflags);
 349 void mdd_changelog_rec_extra_uidgid(struct changelog_rec *rec,
 350                                     __u64 uid, __u64 gid);
 351 void mdd_changelog_rec_extra_nid(struct changelog_rec *rec,
 352                                  lnet_nid_t nid);
 353 void mdd_changelog_rec_extra_omode(struct changelog_rec *rec, u32 flags);
 354 void mdd_changelog_rec_extra_xattr(struct changelog_rec *rec,
 355                                    const char *xattr_name);
 356 int mdd_changelog_store(const struct lu_env *env, struct mdd_device *mdd,
 357                         struct llog_changelog_rec *rec, struct thandle *th);
 358 int mdd_changelog_data_store(const struct lu_env *env, struct mdd_device *mdd,
 359                              enum changelog_rec_type type,
 360                              enum changelog_rec_flags clf_flags,
 361                              struct mdd_object *mdd_obj,
 362                              struct thandle *handle,
 363                              const struct lu_fid *pfid);
 364 int mdd_changelog_ns_store(const struct lu_env *env, struct mdd_device *mdd,
 365                            enum changelog_rec_type type,
 366                            enum changelog_rec_flags clf_flags,
 367                            struct mdd_object *target,
 368                            const struct lu_fid *tpfid,
 369                            const struct lu_fid *sfid,
 370                            const struct lu_fid *spfid,
 371                            const struct lu_name *tname,
 372                            const struct lu_name *sname,
 373                            struct thandle *handle);
 374 int mdd_invalidate(const struct lu_env *env, struct md_object *obj);
 375 int mdd_declare_create_object_internal(const struct lu_env *env,
 376                                        struct mdd_object *p,
 377                                        struct mdd_object *c,
 378                                        struct lu_attr *attr,
 379                                        struct thandle *handle,
 380                                        const struct md_op_spec *spec,
 381                                        struct dt_allocation_hint *hint);
 382 int mdd_stripe_get(const struct lu_env *env, struct mdd_object *obj,
 383                    struct lu_buf *lmm_buf, const char *name);
 384 int mdd_changelog_data_store_xattr(const struct lu_env *env,
 385                                    struct mdd_device *mdd,
 386                                    enum changelog_rec_type type,
 387                                    enum changelog_rec_flags clf_flags,
 388                                    struct mdd_object *mdd_obj,
 389                                    const char *xattr_name,
 390                                    struct thandle *handle);
 391
 392 /* mdd_trans.c */
 393 void mdd_object_make_hint(const struct lu_env *env, struct mdd_object *parent,
 394                           struct mdd_object *child, const struct lu_attr *attr,
 395                           const struct md_op_spec *spec,
 396                           struct dt_allocation_hint *hint);
 397
 398 static inline void mdd_object_get(struct mdd_object *o)
 399 {
 400         lu_object_get(&o->mod_obj.mo_lu);
 401 }
 402
 403 static inline void mdd_object_put(const struct lu_env *env,
 404                                   struct mdd_object *o)
 405 {
 406         lu_object_put(env, &o->mod_obj.mo_lu);
 407 }
 408
 409 struct thandle *mdd_trans_create(const struct lu_env *env,
 410                                  struct mdd_device *mdd);
 411 int mdd_trans_start(const struct lu_env *env, struct mdd_device *mdd,
 412                     struct thandle *th);
 413 int mdd_trans_stop(const struct lu_env *env, struct mdd_device *mdd,
 414                    int rc, struct thandle *handle);
 415
 416 /* mdd_device.c */
 417 struct lu_object *mdd_object_alloc(const struct lu_env *env,
 418                                    const struct lu_object_header *hdr,
 419                                    struct lu_device *d);
 420 int mdd_local_file_create(const struct lu_env *env, struct mdd_device *mdd,
 421                           const struct lu_fid *pfid, const char *name,
 422                           __u32 mode, struct lu_fid *fid);
 423
 424 int mdd_acl_chmod(const struct lu_env *env, struct mdd_object *o, __u32 mode,
 425                   struct thandle *handle);
 426 int mdd_acl_set(const struct lu_env *env, struct mdd_object *obj,
 427                 struct lu_attr *attr, const struct lu_buf *buf, int fl);
 428 int __mdd_fix_mode_acl(const struct lu_env *env, struct lu_buf *buf,
 429                        __u32 *mode);
 430 int __mdd_permission_internal(const struct lu_env *env, struct mdd_object *obj,
 431                               const struct lu_attr *la, unsigned int may_mask,
 432                               int role);
 433 int mdd_permission(const struct lu_env *env, struct md_object *pobj,
 434                    struct md_object *cobj, struct md_attr *ma,
 435                    unsigned int may_mask);
 436 int mdd_generic_thread_start(struct mdd_generic_thread *thread,
 437                              int (*func)(void *), void *data, char *name);
 438 void mdd_generic_thread_stop(struct mdd_generic_thread *thread);
 439 int mdd_changelog_user_purge(const struct lu_env *env, struct mdd_device *mdd,
 440                              __u32 id);
 441 char *mdd_chlg_username(struct llog_changelog_user_rec2 *rec, char *buf,
 442                         size_t len);
 443 __u32 mdd_chlg_usermask(struct llog_changelog_user_rec2 *rec);
 444 int mdd_changelog_recalc_mask(const struct lu_env *env, struct mdd_device *mdd);
 445
 446 /* mdd_prepare.c */
 447 int mdd_compat_fixes(const struct lu_env *env, struct mdd_device *mdd);
 448
 449 /* acl.c */
 450 extern int lustre_posix_acl_permission(struct lu_ucred *mu,
 451                                        const struct lu_attr *la,
 452                                        unsigned int may_mask,
 453                                        posix_acl_xattr_entry *entry,
 454                                        int count);
 455 extern int lustre_posix_acl_chmod_masq(posix_acl_xattr_entry *entry,
 456                                        __u32 mode, int count);
 457 extern int lustre_posix_acl_create_masq(posix_acl_xattr_entry *entry,
 458                                         __u32 *pmode, int count);
 459 extern int lustre_posix_acl_equiv_mode(posix_acl_xattr_entry *entry,
 460                                        mode_t *mode_p, int count);
 461
 462 /* inline functions */
 463 static inline int lu_device_is_mdd(struct lu_device *d)
 464 {
 465         return ergo(d != NULL && d->ld_ops != NULL, d->ld_ops == &mdd_lu_ops);
 466 }
 467
 468 static inline struct mdd_device *lu2mdd_dev(struct lu_device *d)
 469 {
 470         LASSERT(lu_device_is_mdd(d));
 471         return container_of_safe(d, struct mdd_device, mdd_md_dev.md_lu_dev);
 472 }
 473
 474 static inline struct lu_device *mdd2lu_dev(struct mdd_device *mdd)
 475 {
 476         return &mdd->mdd_md_dev.md_lu_dev;
 477 }
 478
 479 static inline struct mdd_object *lu2mdd_obj(struct lu_object *o)
 480 {
 481         LASSERT(ergo(o != NULL, lu_device_is_mdd(o->lo_dev)));
 482         return container_of_safe(o, struct mdd_object,
 483                                  mod_obj.mo_lu);
 484 }
 485
 486 static inline struct mdd_device *mdo2mdd(struct md_object *mdo)
 487 {
 488         return lu2mdd_dev(mdo->mo_lu.lo_dev);
 489 }
 490
 491 static inline struct mdd_object *md2mdd_obj(struct md_object *mdo)
 492 {
 493         return container_of_safe(mdo, struct mdd_object, mod_obj);
 494 }
 495
 496 static inline const
 497 struct dt_device_operations *mdd_child_ops(struct mdd_device *mdd)
 498 {
 499         return mdd->mdd_child->dd_ops;
 500 }
 501
 502 static inline struct lu_object *mdd2lu_obj(struct mdd_object *obj)
 503 {
 504         return &obj->mod_obj.mo_lu;
 505 }
 506
 507 static inline struct dt_object *mdd_object_child(struct mdd_object *obj)
 508 {
 509         return container_of(lu_object_next(mdd2lu_obj(obj)),
 510                             struct dt_object, do_lu);
 511 }
 512
 513 static inline struct obd_device *mdd2obd_dev(struct mdd_device *mdd)
 514 {
 515         return (mdd->mdd_md_dev.md_lu_dev.ld_obd);
 516 }
 517
 518 static inline struct mdd_device *mdd_obj2mdd_dev(struct mdd_object *obj)
 519 {
 520         return mdo2mdd(&obj->mod_obj);
 521 }
 522
 523 static inline umode_t mdd_object_type(const struct mdd_object *mdd_obj)
 524 {
 525         return lu_object_attr(&mdd_obj->mod_obj.mo_lu);
 526 }
 527
 528 static inline int mdd_is_dead_obj(struct mdd_object *mdd_obj)
 529 {
 530         return mdd_obj && mdd_obj->mod_flags & DEAD_OBJ;
 531 }
 532
 533 static inline bool mdd_is_volatile_obj(struct mdd_object *mdd_obj)
 534 {
 535         return mdd_obj->mod_flags & VOLATILE_OBJ;
 536 }
 537
 538 static inline bool mdd_is_orphan_obj(struct mdd_object *mdd_obj)
 539 {
 540         return mdd_obj->mod_flags & ORPHAN_OBJ;
 541 }
 542
 543 static inline int mdd_object_exists(struct mdd_object *mdd_obj)
 544 {
 545         return lu_object_exists(mdd2lu_obj(mdd_obj));
 546 }
 547
 548 static inline int mdd_object_remote(struct mdd_object *mdd_obj)
 549 {
 550         return lu_object_remote(mdd2lu_obj(mdd_obj));
 551 }
 552
 553 static inline const struct lu_fid *mdd_object_fid(struct mdd_object *mdd_obj)
 554 {
 555         return lu_object_fid(mdd2lu_obj(mdd_obj));
 556 }
 557
 558 static inline struct seq_server_site *mdd_seq_site(struct mdd_device *mdd)
 559 {
 560         return mdd2lu_dev(mdd)->ld_site->ld_seq_site;
 561 }
 562
 563 static inline const char *mdd_obj_dev_name(const struct mdd_object *mdd_obj)
 564 {
 565         return lu_dev_name(mdd_obj->mod_obj.mo_lu.lo_dev);
 566 }
 567
 568 #define MAX_ATIME_DIFF 60
 569
 570 static inline int mdd_permission_internal(const struct lu_env *env,
 571                                           struct mdd_object *obj,
 572                                           const struct lu_attr *la,
 573                                           unsigned int may_mask)
 574 {
 575         return __mdd_permission_internal(env, obj, la, may_mask, -1);
 576 }
 577
 578 static inline int mdd_permission_internal_locked(const struct lu_env *env,
 579                                                 struct mdd_object *obj,
 580                                                 const struct lu_attr *la,
 581                                                 unsigned int may_mask,
 582                                                 enum dt_object_role role)
 583 {
 584         return __mdd_permission_internal(env, obj, la, may_mask, role);
 585 }
 586
 587 /* mdd inline func for calling osd_dt_object ops */
 588 static inline int mdo_attr_get(const struct lu_env *env, struct mdd_object *obj,
 589                                struct lu_attr *la)
 590 {
 591         struct dt_object *next = mdd_object_child(obj);
 592         return dt_attr_get(env, next, la);
 593 }
 594
 595 static inline int mdo_declare_attr_set(const struct lu_env *env,
 596                                        struct mdd_object *obj,
 597                                        const struct lu_attr *la,
 598                                        struct thandle *handle)
 599 {
 600         struct dt_object *next = mdd_object_child(obj);
 601         return dt_declare_attr_set(env, next, la, handle);
 602 }
 603
 604 static inline int mdo_attr_set(const struct lu_env *env,
 605                                struct mdd_object *obj,
 606                                const struct lu_attr *la,
 607                                struct thandle *handle)
 608 {
 609         struct dt_object *next = mdd_object_child(obj);
 610
 611         if (!mdd_object_exists(obj))
 612                 return -ENOENT;
 613
 614         return dt_attr_set(env, next, la, handle);
 615 }
 616
 617 static inline int mdo_xattr_get(const struct lu_env *env,struct mdd_object *obj,
 618                                 struct lu_buf *buf, const char *name)
 619 {
 620         struct dt_object *next = mdd_object_child(obj);
 621         return dt_xattr_get(env, next, buf, name);
 622 }
 623
 624 static inline int mdo_declare_xattr_set(const struct lu_env *env,
 625                                         struct mdd_object *obj,
 626                                         const struct lu_buf *buf,
 627                                         const char *name,
 628                                         int fl, struct thandle *handle)
 629 {
 630         struct dt_object *next = mdd_object_child(obj);
 631         int rc;
 632
 633         rc = dt_declare_xattr_set(env, next, buf, name, fl, handle);
 634         if (rc >= 0 &&
 635             (strcmp(name, LL_XATTR_NAME_ENCRYPTION_CONTEXT) == 0 ||
 636              strcmp(name, LL_XATTR_NAME_ENCRYPTION_CONTEXT_OLD) == 0)) {
 637                 struct lu_attr la = { 0 };
 638
 639                 la.la_valid = LA_FLAGS;
 640                 la.la_flags = LUSTRE_ENCRYPT_FL;
 641                 rc = dt_declare_attr_set(env, next, &la, handle);
 642         }
 643         return rc;
 644 }
 645
 646 static inline int mdo_xattr_set(const struct lu_env *env,struct mdd_object *obj,
 647                                 const struct lu_buf *buf, const char *name,
 648                                 int fl, struct thandle *handle)
 649 {
 650         struct dt_object *next = mdd_object_child(obj);
 651         int rc = 0;
 652
 653         if (!mdd_object_exists(obj))
 654                 return -ENOENT;
 655
 656         /* If we are about to set the LL_XATTR_NAME_ENCRYPTION_CONTEXT
 657          * xattr, it means the file/dir is encrypted. In that case we want
 658          * to set the LUSTRE_ENCRYPT_FL flag as well: it will be stored
 659          * into the LMA, making it more efficient to recognise we are
 660          * dealing with an encrypted file/dir, as LMA info is cached upon
 661          * object init.
 662          * However, marking a dir as encrypted is only possible if it is
 663          * being created or migrated (LU_XATTR_CREATE flag not set), or
 664          * if it is empty.
 665          */
 666         if ((strcmp(name, LL_XATTR_NAME_ENCRYPTION_CONTEXT) == 0 ||
 667              strcmp(name, LL_XATTR_NAME_ENCRYPTION_CONTEXT_OLD) == 0) &&
 668             (!S_ISDIR(mdd_object_type(obj)) ||
 669              !(fl & LU_XATTR_CREATE) ||
 670              (rc = mdd_dir_is_empty(env, obj)) == 0)) {
 671                 struct lu_attr la = { 0 };
 672
 673                 la.la_valid = LA_FLAGS;
 674                 la.la_flags = LUSTRE_ENCRYPT_FL;
 675                 /* if this is an old client using the old enc xattr name,
 676                  * switch to the new name for consistency
 677                  */
 678                 if (strcmp(name, LL_XATTR_NAME_ENCRYPTION_CONTEXT_OLD) == 0)
 679                         name = LL_XATTR_NAME_ENCRYPTION_CONTEXT;
 680                 rc = dt_attr_set(env, next, &la, handle);
 681         }
 682         if (rc >= 0)
 683                 rc = dt_xattr_set(env, next, buf, name, fl, handle);
 684
 685         return rc;
 686 }
 687
 688 static inline int mdo_declare_xattr_del(const struct lu_env *env,
 689                                         struct mdd_object *obj,
 690                                         const char *name,
 691                                         struct thandle *handle)
 692 {
 693         struct dt_object *next = mdd_object_child(obj);
 694         return dt_declare_xattr_del(env, next, name, handle);
 695 }
 696
 697 static inline int mdo_xattr_del(const struct lu_env *env,struct mdd_object *obj,
 698                                 const char *name, struct thandle *handle)
 699 {
 700         struct dt_object *next = mdd_object_child(obj);
 701
 702         if (!mdd_object_exists(obj))
 703                 return -ENOENT;
 704
 705         return dt_xattr_del(env, next, name, handle);
 706 }
 707
 708 static inline int
 709 mdo_xattr_list(const struct lu_env *env, struct mdd_object *obj,
 710                struct lu_buf *buf)
 711 {
 712         struct dt_object *next = mdd_object_child(obj);
 713
 714         if (!mdd_object_exists(obj))
 715                 return -ENOENT;
 716
 717         return dt_xattr_list(env, next, buf);
 718 }
 719
 720 static inline int
 721 mdo_invalidate(const struct lu_env *env, struct mdd_object *obj)
 722 {
 723         return dt_invalidate(env, mdd_object_child(obj));
 724 }
 725
 726 static inline int
 727 mdo_declare_layout_change(const struct lu_env *env, struct mdd_object *obj,
 728                           struct md_layout_change *mlc, struct thandle *handle)
 729 {
 730         return dt_declare_layout_change(env, mdd_object_child(obj),
 731                                         mlc, handle);
 732 }
 733
 734 static inline int
 735 mdo_layout_change(const struct lu_env *env, struct mdd_object *obj,
 736                   struct md_layout_change *mlc, struct thandle *handle)
 737 {
 738         return dt_layout_change(env, mdd_object_child(obj), mlc, handle);
 739 }
 740
 741 static inline
 742 int mdo_declare_index_insert(const struct lu_env *env, struct mdd_object *obj,
 743                              const struct lu_fid *fid, __u32 type,
 744                              const char *name, struct thandle *handle)
 745 {
 746         struct dt_object *next  = mdd_object_child(obj);
 747         int               rc;
 748
 749         /*
 750          * if the object doesn't exist yet, then it's supposed to be created
 751          * and declaration of the creation should be enough to insert ./..
 752          */
 753
 754         rc = -ENOTDIR;
 755         if (dt_try_as_dir(env, next, false)) {
 756                 struct dt_insert_rec *rec = &mdd_env_info(env)->mdi_dt_rec;
 757
 758                 rec->rec_fid = fid;
 759                 rec->rec_type = type;
 760                 rc = dt_declare_insert(env, next, (const struct dt_rec *)rec,
 761                                        (const struct dt_key *)name, handle);
 762         }
 763
 764          return rc;
 765 }
 766
 767 static inline
 768 int mdo_declare_index_delete(const struct lu_env *env, struct mdd_object *obj,
 769                              const char *name, struct thandle *handle)
 770 {
 771         struct dt_object *next = mdd_object_child(obj);
 772
 773         if (!dt_try_as_dir(env, next, true))
 774                 return -ENOTDIR;
 775
 776         return dt_declare_delete(env, next, (const struct dt_key *)name,
 777                                  handle);
 778 }
 779
 780 static inline int mdo_declare_ref_add(const struct lu_env *env,
 781                                       struct mdd_object *obj,
 782                                       struct thandle *handle)
 783 {
 784         struct dt_object *next = mdd_object_child(obj);
 785         return dt_declare_ref_add(env, next, handle);
 786 }
 787
 788 static inline int mdo_ref_add(const struct lu_env *env, struct mdd_object *obj,
 789                               struct thandle *handle)
 790 {
 791         struct dt_object *next = mdd_object_child(obj);
 792
 793         if (!mdd_object_exists(obj))
 794                 return -ENOENT;
 795
 796         return dt_ref_add(env, next, handle);
 797 }
 798
 799 static inline int mdo_declare_ref_del(const struct lu_env *env,
 800                                       struct mdd_object *obj,
 801                                       struct thandle *handle)
 802 {
 803         struct dt_object *next = mdd_object_child(obj);
 804         return dt_declare_ref_del(env, next, handle);
 805 }
 806
 807 static inline int mdo_ref_del(const struct lu_env *env, struct mdd_object *obj,
 808                               struct thandle *handle)
 809 {
 810         struct dt_object *next = mdd_object_child(obj);
 811
 812         if (!mdd_object_exists(obj))
 813                 return -ENOENT;
 814
 815         return dt_ref_del(env, next, handle);
 816 }
 817
 818 static inline int
 819 mdo_declare_create_object(const struct lu_env *env, struct mdd_object *obj,
 820                           struct lu_attr *attr, struct dt_allocation_hint *hint,
 821                           struct dt_object_format *dof, struct thandle *handle)
 822 {
 823         struct dt_object *next = mdd_object_child(obj);
 824         return dt_declare_create(env, next, attr, hint, dof, handle);
 825 }
 826
 827 static inline int
 828 mdo_create_object(const struct lu_env *env, struct mdd_object *obj,
 829                   struct lu_attr *attr, struct dt_allocation_hint *hint,
 830                   struct dt_object_format *dof, struct thandle *handle)
 831 {
 832         struct dt_object *next = mdd_object_child(obj);
 833         return dt_create(env, next, attr, hint, dof, handle);
 834 }
 835
 836 static inline
 837 int mdo_declare_destroy(const struct lu_env *env, struct mdd_object *o,
 838                         struct thandle *handle)
 839 {
 840         struct dt_object *next = mdd_object_child(o);
 841         return dt_declare_destroy(env, next, handle);
 842 }
 843
 844 static inline
 845 int mdo_destroy(const struct lu_env *env, struct mdd_object *o,
 846                 struct thandle *handle)
 847 {
 848         struct dt_object *next = mdd_object_child(o);
 849         return dt_destroy(env, next, handle);
 850 }
 851
 852 static inline bool mdd_changelog_enabled(const struct lu_env *env,
 853                                         struct mdd_device *mdd,
 854                                         enum changelog_rec_type type)
 855 {
 856         const struct lu_ucred *uc;
 857
 858         if ((mdd->mdd_cl.mc_flags & CLM_ON) &&
 859             (mdd->mdd_cl.mc_current_mask & BIT(type))) {
 860                 uc = lu_ucred_check(env);
 861
 862                 return uc != NULL ? uc->uc_enable_audit : true;
 863         } else {
 864                 return false;
 865         }
 866 }
 867
 868 static inline bool mdd_changelog_is_too_idle(struct mdd_device *mdd,
 869                                              __u64 cl_rec, __u32 cl_time)
 870 {
 871         __u64 idle_indexes = mdd->mdd_cl.mc_index - cl_rec;
 872         __u32 idle_time = (__u32)ktime_get_real_seconds() - cl_time;
 873
 874         return (idle_indexes > mdd->mdd_changelog_max_idle_indexes ||
 875                 idle_time > mdd->mdd_changelog_max_idle_time ||
 876                 idle_time * idle_indexes > (24 * 3600ULL << 32));
 877 }
 878
 879 bool mdd_changelog_is_space_safe(const struct lu_env *env,
 880                                  struct mdd_device *mdd,
 881                                  struct llog_handle *lgh,
 882                                  bool estimate);
 883
 884 #endif