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