lustre/llite/vvp_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.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2013, 2014, Intel Corporation.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * Internal definitions for VVP layer.
  37  *
  38  *   Author: Nikita Danilov <nikita.danilov@sun.com>
  39  */
  40
  41 #ifndef VVP_INTERNAL_H
  42 #define VVP_INTERNAL_H
  43
  44 #include <lustre/lustre_idl.h>
  45 #include <cl_object.h>
  46
  47 enum obd_notify_event;
  48 struct inode;
  49 struct lov_stripe_md;
  50 struct lustre_md;
  51 struct obd_capa;
  52 struct obd_device;
  53 struct obd_export;
  54 struct page;
  55
  56 blkcnt_t dirty_cnt(struct inode *inode);
  57
  58 int cl_glimpse_size0(struct inode *inode, int agl);
  59 int cl_glimpse_lock(const struct lu_env *env, struct cl_io *io,
  60                     struct inode *inode, struct cl_object *clob, int agl);
  61
  62 static inline int cl_glimpse_size(struct inode *inode)
  63 {
  64         return cl_glimpse_size0(inode, 0);
  65 }
  66
  67 static inline int cl_agl(struct inode *inode)
  68 {
  69         return cl_glimpse_size0(inode, 1);
  70 }
  71
  72 /**
  73  * Locking policy for setattr.
  74  */
  75 enum ccc_setattr_lock_type {
  76         /** Locking is done by server */
  77         SETATTR_NOLOCK,
  78         /** Extent lock is enqueued */
  79         SETATTR_EXTENT_LOCK,
  80         /** Existing local extent lock is used */
  81         SETATTR_MATCH_LOCK
  82 };
  83
  84
  85 /**
  86  * IO state private to vvp or slp layers.
  87  */
  88 struct ccc_io {
  89         /** super class */
  90         struct cl_io_slice     cui_cl;
  91         struct cl_io_lock_link cui_link;
  92         /**
  93          * I/O vector information to or from which read/write is going.
  94          */
  95         struct iovec *cui_iov;
  96         unsigned long cui_nrsegs;
  97         /**
  98          * Total iov count for left IO.
  99          */
 100         unsigned long cui_tot_nrsegs;
 101         /**
 102          * Old length for iov that was truncated partially.
 103          */
 104         size_t cui_iov_olen;
 105         /**
 106          * Total size for the left IO.
 107          */
 108         size_t cui_tot_count;
 109
 110         union {
 111                 struct {
 112                         enum ccc_setattr_lock_type cui_local_lock;
 113                 } setattr;
 114                 struct {
 115                         struct cl_page_list cui_queue;
 116                         unsigned long cui_written;
 117                         int cui_from;
 118                         int cui_to;
 119                 } write;
 120         } u;
 121         /**
 122          * Layout version when this IO is initialized
 123          */
 124         __u32                cui_layout_gen;
 125         /**
 126         * File descriptor against which IO is done.
 127         */
 128         struct ll_file_data *cui_fd;
 129         struct kiocb *cui_iocb;
 130 };
 131
 132 /**
 133  * True, if \a io is a normal io, False for other splice_{read,write}.
 134  * must be impementated in arch specific code.
 135  */
 136 int cl_is_normalio(const struct lu_env *env, const struct cl_io *io);
 137
 138 extern struct lu_context_key ccc_key;
 139 extern struct lu_context_key ccc_session_key;
 140
 141 struct ccc_thread_info {
 142         struct cl_lock          cti_lock;
 143         struct cl_lock_descr    cti_descr;
 144         struct cl_io            cti_io;
 145         struct cl_attr          cti_attr;
 146 };
 147
 148 static inline struct ccc_thread_info *ccc_env_info(const struct lu_env *env)
 149 {
 150         struct ccc_thread_info      *info;
 151
 152         info = lu_context_key_get(&env->le_ctx, &ccc_key);
 153         LASSERT(info != NULL);
 154
 155         return info;
 156 }
 157
 158 static inline struct cl_lock *ccc_env_lock(const struct lu_env *env)
 159 {
 160         struct cl_lock *lock = &ccc_env_info(env)->cti_lock;
 161
 162         memset(lock, 0, sizeof(*lock));
 163
 164         return lock;
 165 }
 166
 167 static inline struct cl_attr *ccc_env_thread_attr(const struct lu_env *env)
 168 {
 169         struct cl_attr *attr = &ccc_env_info(env)->cti_attr;
 170
 171         memset(attr, 0, sizeof(*attr));
 172
 173         return attr;
 174 }
 175
 176 static inline struct cl_io *ccc_env_thread_io(const struct lu_env *env)
 177 {
 178         struct cl_io *io = &ccc_env_info(env)->cti_io;
 179
 180         memset(io, 0, sizeof(*io));
 181
 182         return io;
 183 }
 184
 185 struct ccc_session {
 186         struct ccc_io cs_ios;
 187 };
 188
 189 static inline struct ccc_session *ccc_env_session(const struct lu_env *env)
 190 {
 191         struct ccc_session *ses;
 192
 193         ses = lu_context_key_get(env->le_ses, &ccc_session_key);
 194         LASSERT(ses != NULL);
 195
 196         return ses;
 197 }
 198
 199 static inline struct ccc_io *ccc_env_io(const struct lu_env *env)
 200 {
 201         return &ccc_env_session(env)->cs_ios;
 202 }
 203
 204 /**
 205  * ccc-private object state.
 206  */
 207 struct ccc_object {
 208         struct cl_object_header cob_header;
 209         struct cl_object        cob_cl;
 210         struct inode           *cob_inode;
 211
 212         /**
 213          * A list of dirty pages pending IO in the cache. Used by
 214          * SOM. Protected by ll_inode_info::lli_lock.
 215          *
 216          * \see ccc_page::cpg_pending_linkage
 217          */
 218         struct list_head        cob_pending_list;
 219
 220         /**
 221          * Number of transient pages.  This is no longer protected by i_sem,
 222          * and needs to be atomic.  This is not actually used for anything,
 223          * and can probably be removed.
 224          */
 225         atomic_t                cob_transient_pages;
 226         /**
 227          * Number of outstanding mmaps on this file.
 228          *
 229          * \see ll_vm_open(), ll_vm_close().
 230          */
 231         atomic_t                cob_mmap_cnt;
 232
 233         /**
 234          * various flags
 235          * cob_discard_page_warned
 236          *     if pages belonging to this object are discarded when a client
 237          * is evicted, some debug info will be printed, this flag will be set
 238          * during processing the first discarded page, then avoid flooding
 239          * debug message for lots of discarded pages.
 240          *
 241          * \see ll_dirty_page_discard_warn.
 242          */
 243         unsigned int            cob_discard_page_warned:1;
 244 };
 245
 246 /**
 247  * ccc-private page state.
 248  */
 249 struct ccc_page {
 250         struct cl_page_slice cpg_cl;
 251         unsigned        cpg_defer_uptodate:1,
 252                         cpg_ra_used:1,
 253                         cpg_write_queued:1;
 254         /**
 255          * Non-empty iff this page is already counted in
 256          * ccc_object::cob_pending_list. Protected by
 257          * ccc_object::cob_pending_guard. This list is only used as a flag,
 258          * that is, never iterated through, only checked for list_empty(), but
 259          * having a list is useful for debugging.
 260          */
 261         struct list_head cpg_pending_linkage;
 262         /** VM page */
 263         struct page     *cpg_page;
 264 };
 265
 266 static inline struct ccc_page *cl2ccc_page(const struct cl_page_slice *slice)
 267 {
 268         return container_of(slice, struct ccc_page, cpg_cl);
 269 }
 270
 271 static inline pgoff_t ccc_index(struct ccc_page *ccc)
 272 {
 273         return ccc->cpg_cl.cpl_index;
 274 }
 275
 276 struct cl_page *ccc_vmpage_page_transient(struct page *vmpage);
 277
 278 struct ccc_device {
 279         struct cl_device    cdv_cl;
 280         struct super_block *cdv_sb;
 281         struct cl_device   *cdv_next;
 282 };
 283
 284 struct ccc_lock {
 285         struct cl_lock_slice clk_cl;
 286 };
 287
 288 struct ccc_req {
 289         struct cl_req_slice  crq_cl;
 290 };
 291
 292 void *ccc_key_init(const struct lu_context *ctx, struct lu_context_key *key);
 293 void ccc_key_fini(const struct lu_context *ctx, struct lu_context_key *key,
 294                   void *data);
 295 void *ccc_session_key_init(const struct lu_context *ctx,
 296                            struct lu_context_key *key);
 297 void ccc_session_key_fini(const struct lu_context *ctx,
 298                           struct lu_context_key *key, void *data);
 299
 300 int ccc_device_init(const struct lu_env *env, struct lu_device *d,
 301                     const char *name, struct lu_device *next);
 302 struct lu_device *ccc_device_fini(const struct lu_env *env,
 303                                   struct lu_device *d);
 304 struct lu_device *ccc_device_alloc(const struct lu_env *env,
 305                                    struct lu_device_type *t,
 306                                    struct lustre_cfg *cfg,
 307                                    const struct lu_device_operations *luops,
 308                                    const struct cl_device_operations *clops);
 309 struct lu_device *ccc_device_free(const struct lu_env *env,
 310                                   struct lu_device *d);
 311 struct lu_object *ccc_object_alloc(const struct lu_env *env,
 312                                    const struct lu_object_header *hdr,
 313                                    struct lu_device *dev,
 314                                    const struct cl_object_operations *clops,
 315                                    const struct lu_object_operations *luops);
 316
 317 int ccc_req_init(const struct lu_env *env, struct cl_device *dev,
 318                  struct cl_req *req);
 319 void ccc_umount(const struct lu_env *env, struct cl_device *dev);
 320 int ccc_global_init(struct lu_device_type *device_type);
 321 void ccc_global_fini(struct lu_device_type *device_type);
 322 int ccc_object_init0(const struct lu_env *env, struct ccc_object *vob,
 323                      const struct cl_object_conf *conf);
 324 int ccc_object_init(const struct lu_env *env, struct lu_object *obj,
 325                     const struct lu_object_conf *conf);
 326 void ccc_object_free(const struct lu_env *env, struct lu_object *obj);
 327 int ccc_lock_init(const struct lu_env *env, struct cl_object *obj,
 328                   struct cl_lock *lock, const struct cl_io *io,
 329                   const struct cl_lock_operations *lkops);
 330 int ccc_attr_set(const struct lu_env *env, struct cl_object *obj,
 331                  const struct cl_attr *attr, unsigned valid);
 332 int ccc_object_glimpse(const struct lu_env *env,
 333                        const struct cl_object *obj, struct ost_lvb *lvb);
 334 int ccc_conf_set(const struct lu_env *env, struct cl_object *obj,
 335                  const struct cl_object_conf *conf);
 336 int ccc_fail(const struct lu_env *env, const struct cl_page_slice *slice);
 337 void ccc_transient_page_verify(const struct cl_page *page);
 338 int  ccc_transient_page_own(const struct lu_env *env,
 339                             const struct cl_page_slice *slice,
 340                             struct cl_io *io, int nonblock);
 341 void ccc_transient_page_assume(const struct lu_env *env,
 342                                const struct cl_page_slice *slice,
 343                                struct cl_io *io);
 344 void ccc_transient_page_unassume(const struct lu_env *env,
 345                                  const struct cl_page_slice *slice,
 346                                  struct cl_io *io);
 347 void ccc_transient_page_disown(const struct lu_env *env,
 348                                const struct cl_page_slice *slice,
 349                                struct cl_io *io);
 350 void ccc_transient_page_discard(const struct lu_env *env,
 351                                 const struct cl_page_slice *slice,
 352                                 struct cl_io *io);
 353 int ccc_transient_page_prep(const struct lu_env *env,
 354                             const struct cl_page_slice *slice,
 355                             struct cl_io *io);
 356 void ccc_lock_delete(const struct lu_env *env,
 357                      const struct cl_lock_slice *slice);
 358 void ccc_lock_fini(const struct lu_env *env, struct cl_lock_slice *slice);
 359 int ccc_lock_enqueue(const struct lu_env *env,
 360                      const struct cl_lock_slice *slice,
 361                      struct cl_io *io, struct cl_sync_io *anchor);
 362 void ccc_io_fini(const struct lu_env *env, const struct cl_io_slice *ios);
 363 int ccc_io_one_lock_index(const struct lu_env *env, struct cl_io *io,
 364                           __u32 enqflags, enum cl_lock_mode mode,
 365                           pgoff_t start, pgoff_t end);
 366 int ccc_io_one_lock(const struct lu_env *env, struct cl_io *io,
 367                     __u32 enqflags, enum cl_lock_mode mode,
 368                     loff_t start, loff_t end);
 369 void ccc_io_end(const struct lu_env *env, const struct cl_io_slice *ios);
 370 void ccc_io_advance(const struct lu_env *env, const struct cl_io_slice *ios,
 371                     size_t nob);
 372 void ccc_io_update_iov(const struct lu_env *env, struct ccc_io *cio,
 373                        struct cl_io *io);
 374 int ccc_prep_size(const struct lu_env *env, struct cl_object *obj,
 375                   struct cl_io *io, loff_t start, size_t count, int *exceed);
 376 void ccc_req_completion(const struct lu_env *env,
 377                         const struct cl_req_slice *slice, int ioret);
 378 void ccc_req_attr_set(const struct lu_env *env,
 379                       const struct cl_req_slice *slice,
 380                       const struct cl_object *obj,
 381                       struct cl_req_attr *oa, obd_valid flags);
 382
 383 struct lu_device *ccc2lu_dev(struct ccc_device *vdv);
 384 struct lu_object *ccc2lu(struct ccc_object *vob);
 385 struct ccc_device *lu2ccc_dev(const struct lu_device *d);
 386 struct ccc_device *cl2ccc_dev(const struct cl_device *d);
 387 struct ccc_object *lu2ccc(const struct lu_object *obj);
 388 struct ccc_object *cl2ccc(const struct cl_object *obj);
 389 struct ccc_lock *cl2ccc_lock(const struct cl_lock_slice *slice);
 390 struct ccc_io *cl2ccc_io(const struct lu_env *env,
 391                          const struct cl_io_slice *slice);
 392 struct ccc_req *cl2ccc_req(const struct cl_req_slice *slice);
 393 struct page *cl2vm_page(const struct cl_page_slice *slice);
 394 struct inode *ccc_object_inode(const struct cl_object *obj);
 395 struct ccc_object *cl_inode2ccc(struct inode *inode);
 396
 397 int cl_setattr_ost(struct inode *inode, const struct iattr *attr,
 398                    struct obd_capa *capa);
 399
 400 struct cl_page *ccc_vmpage_page_transient(struct page *vmpage);
 401 int ccc_object_invariant(const struct cl_object *obj);
 402 int cl_file_inode_init(struct inode *inode, struct lustre_md *md);
 403 void cl_inode_fini(struct inode *inode);
 404 int cl_local_size(struct inode *inode);
 405
 406 __u16 ll_dirent_type_get(struct lu_dirent *ent);
 407 __u64 cl_fid_build_ino(const struct lu_fid *fid, int api32);
 408 __u32 cl_fid_build_gen(const struct lu_fid *fid);
 409
 410 #ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
 411 # define CLOBINVRNT(env, clob, expr)                                    \
 412         do {                                                            \
 413                 if (unlikely(!(expr))) {                                \
 414                         LU_OBJECT_DEBUG(D_ERROR, (env), &(clob)->co_lu, \
 415                                         #expr "\n");                    \
 416                         LINVRNT(0);                                     \
 417                 }                                                       \
 418         } while (0)
 419 #else /* !CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
 420 # define CLOBINVRNT(env, clob, expr)                                    \
 421         ((void)sizeof(env), (void)sizeof(clob), (void)sizeof !!(expr))
 422 #endif /* CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
 423
 424 int cl_init_ea_size(struct obd_export *md_exp, struct obd_export *dt_exp);
 425 int cl_ocd_update(struct obd_device *host,
 426                   struct obd_device *watched,
 427                   enum obd_notify_event ev, void *owner, void *data);
 428
 429 struct ccc_grouplock {
 430         struct lu_env   *cg_env;
 431         struct cl_io    *cg_io;
 432         struct cl_lock  *cg_lock;
 433         unsigned long    cg_gid;
 434 };
 435
 436 int cl_get_grouplock(struct cl_object *obj, unsigned long gid, int nonblock,
 437                      struct ccc_grouplock *cg);
 438 void cl_put_grouplock(struct ccc_grouplock *cg);
 439
 440 /**
 441  * New interfaces to get and put lov_stripe_md from lov layer. This violates
 442  * layering because lov_stripe_md is supposed to be a private data in lov.
 443  *
 444  * NB: If you find you have to use these interfaces for your new code, please
 445  * think about it again. These interfaces may be removed in the future for
 446  * better layering. */
 447 struct lov_stripe_md *lov_lsm_get(struct cl_object *clobj);
 448 void lov_lsm_put(struct cl_object *clobj, struct lov_stripe_md *lsm);
 449 int lov_read_and_clear_async_rc(struct cl_object *clob);
 450
 451 struct lov_stripe_md *ccc_inode_lsm_get(struct inode *inode);
 452 void ccc_inode_lsm_put(struct inode *inode, struct lov_stripe_md *lsm);
 453
 454 enum {
 455         LUSTRE_OPC_MKDIR        = 0,
 456         LUSTRE_OPC_SYMLINK      = 1,
 457         LUSTRE_OPC_MKNOD        = 2,
 458         LUSTRE_OPC_CREATE       = 3,
 459         LUSTRE_OPC_ANY          = 5,
 460 };
 461
 462 int vvp_io_init(const struct lu_env *env, struct cl_object *obj,
 463                 struct cl_io *io);
 464 int vvp_lock_init(const struct lu_env *env, struct cl_object *obj,
 465                   struct cl_lock *lock, const struct cl_io *io);
 466 int vvp_page_init(const struct lu_env *env, struct cl_object *obj,
 467                   struct cl_page *page, pgoff_t index);
 468 struct lu_object *vvp_object_alloc(const struct lu_env *env,
 469                                    const struct lu_object_header *hdr,
 470                                    struct lu_device *dev);
 471 struct ccc_object *cl_inode2ccc(struct inode *inode);
 472
 473 extern const struct file_operations vvp_dump_pgcache_file_ops;
 474
 475 #endif /* VVP_INTERNAL_H */