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