lustre/include/lclient.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) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2011, 2013, 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  * Definitions shared between vvp and liblustre, and other clients in the
  37  * future.
  38  *
  39  *   Author: Oleg Drokin <oleg.drokin@sun.com>
  40  *   Author: Nikita Danilov <nikita.danilov@sun.com>
  41  */
  42
  43 #ifndef LCLIENT_H
  44 #define LCLIENT_H
  45
  46 #include <lustre/lustre_idl.h>
  47 #include <cl_object.h>
  48
  49 enum obd_notify_event;
  50 struct inode;
  51 struct lov_stripe_md;
  52 struct lustre_md;
  53 struct obd_capa;
  54 struct obd_device;
  55 struct obd_export;
  56 struct page;
  57
  58 blkcnt_t dirty_cnt(struct inode *inode);
  59
  60 int cl_glimpse_size0(struct inode *inode, int agl);
  61 int cl_glimpse_lock(const struct lu_env *env, struct cl_io *io,
  62                     struct inode *inode, struct cl_object *clob, int agl);
  63
  64 static inline int cl_glimpse_size(struct inode *inode)
  65 {
  66         return cl_glimpse_size0(inode, 0);
  67 }
  68
  69 static inline int cl_agl(struct inode *inode)
  70 {
  71         return cl_glimpse_size0(inode, 1);
  72 }
  73
  74 /**
  75  * Locking policy for setattr.
  76  */
  77 enum ccc_setattr_lock_type {
  78         /** Locking is done by server */
  79         SETATTR_NOLOCK,
  80         /** Extent lock is enqueued */
  81         SETATTR_EXTENT_LOCK,
  82         /** Existing local extent lock is used */
  83         SETATTR_MATCH_LOCK
  84 };
  85
  86
  87 /**
  88  * IO state private to vvp or slp layers.
  89  */
  90 struct ccc_io {
  91         /** super class */
  92         struct cl_io_slice     cui_cl;
  93         struct cl_io_lock_link cui_link;
  94         /**
  95          * I/O vector information to or from which read/write is going.
  96          */
  97         struct iovec *cui_iov;
  98         unsigned long cui_nrsegs;
  99         /**
 100          * Total iov count for left IO.
 101          */
 102         unsigned long cui_tot_nrsegs;
 103         /**
 104          * Old length for iov that was truncated partially.
 105          */
 106         size_t cui_iov_olen;
 107         /**
 108          * Total size for the left IO.
 109          */
 110         size_t cui_tot_count;
 111
 112         union {
 113                 struct {
 114                         enum ccc_setattr_lock_type cui_local_lock;
 115                 } setattr;
 116                 struct {
 117                         struct cl_page_list cui_queue;
 118                         unsigned long cui_written;
 119                         int cui_from;
 120                         int cui_to;
 121                 } write;
 122         } u;
 123         /**
 124          * True iff io is processing glimpse right now.
 125          */
 126         int                  cui_glimpse;
 127         /**
 128          * Layout version when this IO is initialized
 129          */
 130         __u32                cui_layout_gen;
 131         /**
 132          * File descriptor against which IO is done.
 133          */
 134         struct ll_file_data *cui_fd;
 135         struct kiocb *cui_iocb;
 136 };
 137
 138 /**
 139  * True, if \a io is a normal io, False for other splice_{read,write}.
 140  * must be impementated in arch specific code.
 141  */
 142 int cl_is_normalio(const struct lu_env *env, const struct cl_io *io);
 143
 144 extern struct lu_context_key ccc_key;
 145 extern struct lu_context_key ccc_session_key;
 146
 147 struct ccc_thread_info {
 148         struct cl_lock_descr cti_descr;
 149         struct cl_io         cti_io;
 150         struct cl_attr       cti_attr;
 151 };
 152
 153 static inline struct ccc_thread_info *ccc_env_info(const struct lu_env *env)
 154 {
 155         struct ccc_thread_info      *info;
 156
 157         info = lu_context_key_get(&env->le_ctx, &ccc_key);
 158         LASSERT(info != NULL);
 159         return info;
 160 }
 161
 162 static inline struct cl_attr *ccc_env_thread_attr(const struct lu_env *env)
 163 {
 164         struct cl_attr *attr = &ccc_env_info(env)->cti_attr;
 165         memset(attr, 0, sizeof(*attr));
 166         return attr;
 167 }
 168
 169 static inline struct cl_io *ccc_env_thread_io(const struct lu_env *env)
 170 {
 171         struct cl_io *io = &ccc_env_info(env)->cti_io;
 172         memset(io, 0, sizeof(*io));
 173         return io;
 174 }
 175
 176 struct ccc_session {
 177         struct ccc_io cs_ios;
 178 };
 179
 180 static inline struct ccc_session *ccc_env_session(const struct lu_env *env)
 181 {
 182         struct ccc_session *ses;
 183
 184         ses = lu_context_key_get(env->le_ses, &ccc_session_key);
 185         LASSERT(ses != NULL);
 186         return ses;
 187 }
 188
 189 static inline struct ccc_io *ccc_env_io(const struct lu_env *env)
 190 {
 191         return &ccc_env_session(env)->cs_ios;
 192 }
 193
 194 /**
 195  * ccc-private object state.
 196  */
 197 struct ccc_object {
 198         struct cl_object_header cob_header;
 199         struct cl_object        cob_cl;
 200         struct inode           *cob_inode;
 201
 202         /**
 203          * A list of dirty pages pending IO in the cache. Used by
 204          * SOM. Protected by ll_inode_info::lli_lock.
 205          *
 206          * \see ccc_page::cpg_pending_linkage
 207          */
 208         cfs_list_t             cob_pending_list;
 209
 210         /**
 211          * Access this counter is protected by inode->i_sem. Now that
 212          * the lifetime of transient pages must be covered by inode sem,
 213          * we don't need to hold any lock..
 214          */
 215         int                     cob_transient_pages;
 216         /**
 217          * Number of outstanding mmaps on this file.
 218          *
 219          * \see ll_vm_open(), ll_vm_close().
 220          */
 221         atomic_t                cob_mmap_cnt;
 222
 223         /**
 224          * various flags
 225          * cob_discard_page_warned
 226          *     if pages belonging to this object are discarded when a client
 227          * is evicted, some debug info will be printed, this flag will be set
 228          * during processing the first discarded page, then avoid flooding
 229          * debug message for lots of discarded pages.
 230          *
 231          * \see ll_dirty_page_discard_warn.
 232          */
 233         unsigned int            cob_discard_page_warned:1;
 234 };
 235
 236 /**
 237  * ccc-private page state.
 238  */
 239 struct ccc_page {
 240         struct cl_page_slice cpg_cl;
 241         int                  cpg_defer_uptodate;
 242         int                  cpg_ra_used;
 243         int                  cpg_write_queued;
 244         /**
 245          * Non-empty iff this page is already counted in
 246          * ccc_object::cob_pending_list. Protected by
 247          * ccc_object::cob_pending_guard. This list is only used as a flag,
 248          * that is, never iterated through, only checked for list_empty(), but
 249          * having a list is useful for debugging.
 250          */
 251         cfs_list_t           cpg_pending_linkage;
 252         /** VM page */
 253         struct page          *cpg_page;
 254 };
 255
 256 static inline struct ccc_page *cl2ccc_page(const struct cl_page_slice *slice)
 257 {
 258         return container_of(slice, struct ccc_page, cpg_cl);
 259 }
 260
 261 static inline pgoff_t ccc_index(struct ccc_page *ccc)
 262 {
 263         return ccc->cpg_cl.cpl_index;
 264 }
 265
 266 struct cl_page    *ccc_vmpage_page_transient(struct page *vmpage);
 267
 268 struct ccc_device {
 269         struct cl_device    cdv_cl;
 270         struct super_block *cdv_sb;
 271         struct cl_device   *cdv_next;
 272 };
 273
 274 struct ccc_lock {
 275         struct cl_lock_slice clk_cl;
 276 };
 277
 278 struct ccc_req {
 279         struct cl_req_slice  crq_cl;
 280 };
 281
 282 void *ccc_key_init        (const struct lu_context *ctx,
 283                            struct lu_context_key *key);
 284 void  ccc_key_fini        (const struct lu_context *ctx,
 285                            struct lu_context_key *key, void *data);
 286 void *ccc_session_key_init(const struct lu_context *ctx,
 287                            struct lu_context_key *key);
 288 void  ccc_session_key_fini(const struct lu_context *ctx,
 289                            struct lu_context_key *key, void *data);
 290
 291 int              ccc_device_init  (const struct lu_env *env,
 292                                    struct lu_device *d,
 293                                    const char *name, struct lu_device *next);
 294 struct lu_device *ccc_device_fini (const struct lu_env *env,
 295                                    struct lu_device *d);
 296 struct lu_device *ccc_device_alloc(const struct lu_env *env,
 297                                    struct lu_device_type *t,
 298                                    struct lustre_cfg *cfg,
 299                                    const struct lu_device_operations *luops,
 300                                    const struct cl_device_operations *clops);
 301 struct lu_device *ccc_device_free (const struct lu_env *env,
 302                                    struct lu_device *d);
 303 struct lu_object *ccc_object_alloc(const struct lu_env *env,
 304                                    const struct lu_object_header *hdr,
 305                                    struct lu_device *dev,
 306                                    const struct cl_object_operations *clops,
 307                                    const struct lu_object_operations *luops);
 308
 309 int ccc_req_init(const struct lu_env *env, struct cl_device *dev,
 310                  struct cl_req *req);
 311 void ccc_umount(const struct lu_env *env, struct cl_device *dev);
 312 int ccc_global_init(struct lu_device_type *device_type);
 313 void ccc_global_fini(struct lu_device_type *device_type);
 314 int ccc_object_init0(const struct lu_env *env,struct ccc_object *vob,
 315                      const struct cl_object_conf *conf);
 316 int ccc_object_init(const struct lu_env *env, struct lu_object *obj,
 317                     const struct lu_object_conf *conf);
 318 void ccc_object_free(const struct lu_env *env, struct lu_object *obj);
 319 int ccc_lock_init(const struct lu_env *env, struct cl_object *obj,
 320                   struct cl_lock *lock, const struct cl_io *io,
 321                   const struct cl_lock_operations *lkops);
 322 int ccc_attr_set(const struct lu_env *env, struct cl_object *obj,
 323                  const struct cl_attr *attr, unsigned valid);
 324 int ccc_object_glimpse(const struct lu_env *env,
 325                        const struct cl_object *obj, struct ost_lvb *lvb);
 326 int ccc_conf_set(const struct lu_env *env, struct cl_object *obj,
 327                  const struct cl_object_conf *conf);
 328 int ccc_fail(const struct lu_env *env, const struct cl_page_slice *slice);
 329 void ccc_transient_page_verify(const struct cl_page *page);
 330 int  ccc_transient_page_own(const struct lu_env *env,
 331                             const struct cl_page_slice *slice,
 332                             struct cl_io *io, int nonblock);
 333 void ccc_transient_page_assume(const struct lu_env *env,
 334                                const struct cl_page_slice *slice,
 335                                struct cl_io *io);
 336 void ccc_transient_page_unassume(const struct lu_env *env,
 337                                  const struct cl_page_slice *slice,
 338                                  struct cl_io *io);
 339 void ccc_transient_page_disown(const struct lu_env *env,
 340                                const struct cl_page_slice *slice,
 341                                struct cl_io *io);
 342 void ccc_transient_page_discard(const struct lu_env *env,
 343                                 const struct cl_page_slice *slice,
 344                                 struct cl_io *io);
 345 int ccc_transient_page_prep(const struct lu_env *env,
 346                             const struct cl_page_slice *slice,
 347                             struct cl_io *io);
 348 void ccc_lock_delete(const struct lu_env *env,
 349                      const struct cl_lock_slice *slice);
 350 void ccc_lock_fini(const struct lu_env *env,struct cl_lock_slice *slice);
 351 int ccc_lock_enqueue(const struct lu_env *env,const struct cl_lock_slice *slice,
 352                      struct cl_io *io, __u32 enqflags);
 353 int ccc_lock_unuse(const struct lu_env *env,const struct cl_lock_slice *slice);
 354 int ccc_lock_wait(const struct lu_env *env,const struct cl_lock_slice *slice);
 355 int ccc_lock_fits_into(const struct lu_env *env,
 356                        const struct cl_lock_slice *slice,
 357                        const struct cl_lock_descr *need,
 358                        const struct cl_io *io);
 359 void ccc_lock_state(const struct lu_env *env,
 360                     const struct cl_lock_slice *slice,
 361                     enum cl_lock_state state);
 362
 363 void ccc_io_fini(const struct lu_env *env, const struct cl_io_slice *ios);
 364 int ccc_io_one_lock_index(const struct lu_env *env, struct cl_io *io,
 365                           __u32 enqflags, enum cl_lock_mode mode,
 366                           pgoff_t start, pgoff_t end);
 367 int ccc_io_one_lock(const struct lu_env *env, struct cl_io *io,
 368                     __u32 enqflags, enum cl_lock_mode mode,
 369                     loff_t start, loff_t end);
 370 void ccc_io_end(const struct lu_env *env, const struct cl_io_slice *ios);
 371 void ccc_io_advance(const struct lu_env *env, const struct cl_io_slice *ios,
 372                     size_t nob);
 373 void ccc_io_update_iov(const struct lu_env *env, struct ccc_io *cio,
 374                        struct cl_io *io);
 375 int ccc_prep_size(const struct lu_env *env, struct cl_object *obj,
 376                   struct cl_io *io, loff_t start, size_t count, int *exceed);
 377 void ccc_req_completion(const struct lu_env *env,
 378                         const struct cl_req_slice *slice, int ioret);
 379 void ccc_req_attr_set(const struct lu_env *env,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, #expr "\n"); \
 415                   LINVRNT(0);                                           \
 416           }                                                             \
 417   } while (0)
 418 #else /* !CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
 419 # define CLOBINVRNT(env, clob, expr)                                    \
 420          ((void)sizeof(env), (void)sizeof(clob), (void)sizeof !!(expr))
 421 #endif /* !CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
 422
 423 int cl_init_ea_size(struct obd_export *md_exp, struct obd_export *dt_exp);
 424 int cl_ocd_update(struct obd_device *host,
 425                   struct obd_device *watched,
 426                   enum obd_notify_event ev, void *owner, void *data);
 427
 428 struct ccc_grouplock {
 429         struct lu_env   *cg_env;
 430         struct cl_io    *cg_io;
 431         struct cl_lock  *cg_lock;
 432         unsigned long    cg_gid;
 433 };
 434
 435 int  cl_get_grouplock(struct cl_object *obj, unsigned long gid, int nonblock,
 436                       struct ccc_grouplock *cg);
 437 void cl_put_grouplock(struct ccc_grouplock *cg);
 438
 439 /**
 440  * New interfaces to get and put lov_stripe_md from lov layer. This violates
 441  * layering because lov_stripe_md is supposed to be a private data in lov.
 442  *
 443  * NB: If you find you have to use these interfaces for your new code, please
 444  * think about it again. These interfaces may be removed in the future for
 445  * better layering. */
 446 struct lov_stripe_md *lov_lsm_get(struct cl_object *clobj);
 447 void lov_lsm_put(struct cl_object *clobj, struct lov_stripe_md *lsm);
 448 int lov_read_and_clear_async_rc(struct cl_object *clob);
 449
 450 struct lov_stripe_md *ccc_inode_lsm_get(struct inode *inode);
 451 void ccc_inode_lsm_put(struct inode *inode, struct lov_stripe_md *lsm);
 452
 453 /**
 454  * Data structure managing a client's cached pages. A count of
 455  * "unstable" pages is maintained, and an LRU of clean pages is
 456  * maintained. "unstable" pages are pages pinned by the ptlrpc
 457  * layer for recovery purposes.
 458  */
 459 struct cl_client_cache {
 460         atomic_t                ccc_users;    /* # of users (OSCs) */
 461         cfs_list_t              ccc_lru;      /* LRU of cached clean pages */
 462         spinlock_t              ccc_lru_lock; /* lock for list */
 463         atomic_t                ccc_lru_left; /* # of LRU entries available */
 464         unsigned long           ccc_lru_max;  /* Max # of LRU entries */
 465         unsigned int            ccc_lru_shrinkers;  /* # of threads shrinking */
 466         atomic_t                ccc_unstable_nr;    /* # of pages pinned */
 467         wait_queue_head_t       ccc_unstable_waitq; /* Signaled on BRW commit */
 468 };
 469
 470 enum {
 471         LUSTRE_OPC_MKDIR    = 0,
 472         LUSTRE_OPC_SYMLINK  = 1,
 473         LUSTRE_OPC_MKNOD    = 2,
 474         LUSTRE_OPC_CREATE   = 3,
 475         LUSTRE_OPC_ANY      = 5
 476 };
 477
 478 enum op_cli_flags {
 479         CLI_SET_MEA     = 1 << 0,
 480         CLI_RM_ENTRY    = 1 << 1,
 481         CLI_HASH64      = 1 << 2,
 482         CLI_API32       = 1 << 3,
 483         CLI_MIGRATE     = 1 << 4,
 484         CLI_NEXT_ENTRY  = 1 << 5,
 485 };
 486
 487 #endif /*LCLIENT_H */