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, 2012, Whamcloud, Inc.
  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 blkcnt_t dirty_cnt(struct inode *inode);
  47
  48 int cl_glimpse_size0(struct inode *inode, int agl);
  49 int cl_glimpse_lock(const struct lu_env *env, struct cl_io *io,
  50                     struct inode *inode, struct cl_object *clob, int agl);
  51
  52 static inline int cl_glimpse_size(struct inode *inode)
  53 {
  54         return cl_glimpse_size0(inode, 0);
  55 }
  56
  57 static inline int cl_agl(struct inode *inode)
  58 {
  59         return cl_glimpse_size0(inode, 1);
  60 }
  61
  62 /**
  63  * Locking policy for setattr.
  64  */
  65 enum ccc_setattr_lock_type {
  66         /** Locking is done by server */
  67         SETATTR_NOLOCK,
  68         /** Extent lock is enqueued */
  69         SETATTR_EXTENT_LOCK,
  70         /** Existing local extent lock is used */
  71         SETATTR_MATCH_LOCK
  72 };
  73
  74
  75 /**
  76  * IO state private to vvp or slp layers.
  77  */
  78 struct ccc_io {
  79         /** super class */
  80         struct cl_io_slice     cui_cl;
  81         struct cl_io_lock_link cui_link;
  82         /**
  83          * I/O vector information to or from which read/write is going.
  84          */
  85         struct iovec *cui_iov;
  86         unsigned long cui_nrsegs;
  87         /**
  88          * Total iov count for left IO.
  89          */
  90         unsigned long cui_tot_nrsegs;
  91         /**
  92          * Old length for iov that was truncated partially.
  93          */
  94         size_t cui_iov_olen;
  95         /**
  96          * Total size for the left IO.
  97          */
  98         size_t cui_tot_count;
  99
 100         union {
 101                 struct {
 102                         int                        cui_locks_released;
 103                         enum ccc_setattr_lock_type cui_local_lock;
 104                 } setattr;
 105         } u;
 106         /**
 107          * True iff io is processing glimpse right now.
 108          */
 109         int                  cui_glimpse;
 110         /**
 111          * File descriptor against which IO is done.
 112          */
 113         struct ll_file_data *cui_fd;
 114 #ifndef HAVE_FILE_WRITEV
 115         struct kiocb *cui_iocb;
 116 #endif
 117 };
 118
 119 /**
 120  * True, if \a io is a normal io, False for other (sendfile, splice*).
 121  * must be impementated in arch specific code.
 122  */
 123 int cl_is_normalio(const struct lu_env *env, const struct cl_io *io);
 124
 125 extern struct lu_context_key ccc_key;
 126 extern struct lu_context_key ccc_session_key;
 127
 128 struct ccc_thread_info {
 129         struct cl_lock_descr cti_descr;
 130         struct cl_io         cti_io;
 131         struct cl_attr       cti_attr;
 132 };
 133
 134 static inline struct ccc_thread_info *ccc_env_info(const struct lu_env *env)
 135 {
 136         struct ccc_thread_info      *info;
 137
 138         info = lu_context_key_get(&env->le_ctx, &ccc_key);
 139         LASSERT(info != NULL);
 140         return info;
 141 }
 142
 143 static inline struct cl_attr *ccc_env_thread_attr(const struct lu_env *env)
 144 {
 145         struct cl_attr *attr = &ccc_env_info(env)->cti_attr;
 146         memset(attr, 0, sizeof(*attr));
 147         return attr;
 148 }
 149
 150 static inline struct cl_io *ccc_env_thread_io(const struct lu_env *env)
 151 {
 152         struct cl_io *io = &ccc_env_info(env)->cti_io;
 153         memset(io, 0, sizeof(*io));
 154         return io;
 155 }
 156
 157 struct ccc_session {
 158         struct ccc_io cs_ios;
 159 };
 160
 161 static inline struct ccc_session *ccc_env_session(const struct lu_env *env)
 162 {
 163         struct ccc_session *ses;
 164
 165         ses = lu_context_key_get(env->le_ses, &ccc_session_key);
 166         LASSERT(ses != NULL);
 167         return ses;
 168 }
 169
 170 static inline struct ccc_io *ccc_env_io(const struct lu_env *env)
 171 {
 172         return &ccc_env_session(env)->cs_ios;
 173 }
 174
 175 /**
 176  * ccc-private object state.
 177  */
 178 struct ccc_object {
 179         struct cl_object_header cob_header;
 180         struct cl_object        cob_cl;
 181         struct inode           *cob_inode;
 182
 183         /**
 184          * A list of dirty pages pending IO in the cache. Used by
 185          * SOM. Protected by ll_inode_info::lli_lock.
 186          *
 187          * \see ccc_page::cpg_pending_linkage
 188          */
 189         cfs_list_t             cob_pending_list;
 190
 191         /**
 192          * Access this counter is protected by inode->i_sem. Now that
 193          * the lifetime of transient pages must be covered by inode sem,
 194          * we don't need to hold any lock..
 195          */
 196         int                     cob_transient_pages;
 197         /**
 198          * Number of outstanding mmaps on this file.
 199          *
 200          * \see ll_vm_open(), ll_vm_close().
 201          */
 202         cfs_atomic_t            cob_mmap_cnt;
 203 };
 204
 205 /**
 206  * ccc-private page state.
 207  */
 208 struct ccc_page {
 209         struct cl_page_slice cpg_cl;
 210         int                  cpg_defer_uptodate;
 211         int                  cpg_ra_used;
 212         int                  cpg_write_queued;
 213         /**
 214          * Non-empty iff this page is already counted in
 215          * ccc_object::cob_pending_list. Protected by
 216          * ccc_object::cob_pending_guard. This list is only used as a flag,
 217          * that is, never iterated through, only checked for list_empty(), but
 218          * having a list is useful for debugging.
 219          */
 220         cfs_list_t           cpg_pending_linkage;
 221         /** VM page */
 222         cfs_page_t          *cpg_page;
 223 };
 224
 225 static inline struct ccc_page *cl2ccc_page(const struct cl_page_slice *slice)
 226 {
 227         return container_of(slice, struct ccc_page, cpg_cl);
 228 }
 229
 230 struct cl_page    *ccc_vmpage_page_transient(cfs_page_t *vmpage);
 231
 232 struct ccc_device {
 233         struct cl_device    cdv_cl;
 234         struct super_block *cdv_sb;
 235         struct cl_device   *cdv_next;
 236 };
 237
 238 struct ccc_lock {
 239         struct cl_lock_slice clk_cl;
 240 };
 241
 242 struct ccc_req {
 243         struct cl_req_slice  crq_cl;
 244 };
 245
 246 void *ccc_key_init        (const struct lu_context *ctx,
 247                            struct lu_context_key *key);
 248 void  ccc_key_fini        (const struct lu_context *ctx,
 249                            struct lu_context_key *key, void *data);
 250 void *ccc_session_key_init(const struct lu_context *ctx,
 251                            struct lu_context_key *key);
 252 void  ccc_session_key_fini(const struct lu_context *ctx,
 253                            struct lu_context_key *key, void *data);
 254
 255 int              ccc_device_init  (const struct lu_env *env,
 256                                    struct lu_device *d,
 257                                    const char *name, struct lu_device *next);
 258 struct lu_device *ccc_device_fini (const struct lu_env *env,
 259                                    struct lu_device *d);
 260 struct lu_device *ccc_device_alloc(const struct lu_env *env,
 261                                    struct lu_device_type *t,
 262                                    struct lustre_cfg *cfg,
 263                                    const struct lu_device_operations *luops,
 264                                    const struct cl_device_operations *clops);
 265 struct lu_device *ccc_device_free (const struct lu_env *env,
 266                                    struct lu_device *d);
 267 struct lu_object *ccc_object_alloc(const struct lu_env *env,
 268                                    const struct lu_object_header *hdr,
 269                                    struct lu_device *dev,
 270                                    const struct cl_object_operations *clops,
 271                                    const struct lu_object_operations *luops);
 272
 273 int ccc_req_init(const struct lu_env *env, struct cl_device *dev,
 274                  struct cl_req *req);
 275 void ccc_umount(const struct lu_env *env, struct cl_device *dev);
 276 int ccc_global_init(struct lu_device_type *device_type);
 277 void ccc_global_fini(struct lu_device_type *device_type);
 278 int ccc_object_init0(const struct lu_env *env,struct ccc_object *vob,
 279                      const struct cl_object_conf *conf);
 280 int ccc_object_init(const struct lu_env *env, struct lu_object *obj,
 281                     const struct lu_object_conf *conf);
 282 void ccc_object_free(const struct lu_env *env, struct lu_object *obj);
 283 int ccc_lock_init(const struct lu_env *env, struct cl_object *obj,
 284                   struct cl_lock *lock, const struct cl_io *io,
 285                   const struct cl_lock_operations *lkops);
 286 int ccc_attr_set(const struct lu_env *env, struct cl_object *obj,
 287                  const struct cl_attr *attr, unsigned valid);
 288 int ccc_object_glimpse(const struct lu_env *env,
 289                        const struct cl_object *obj, struct ost_lvb *lvb);
 290 int ccc_conf_set(const struct lu_env *env, struct cl_object *obj,
 291                  const struct cl_object_conf *conf);
 292 cfs_page_t *ccc_page_vmpage(const struct lu_env *env,
 293                             const struct cl_page_slice *slice);
 294 int ccc_page_is_under_lock(const struct lu_env *env,
 295                            const struct cl_page_slice *slice, struct cl_io *io);
 296 int ccc_fail(const struct lu_env *env, const struct cl_page_slice *slice);
 297 void ccc_transient_page_verify(const struct cl_page *page);
 298 int  ccc_transient_page_own(const struct lu_env *env,
 299                             const struct cl_page_slice *slice,
 300                             struct cl_io *io, int nonblock);
 301 void ccc_transient_page_assume(const struct lu_env *env,
 302                                const struct cl_page_slice *slice,
 303                                struct cl_io *io);
 304 void ccc_transient_page_unassume(const struct lu_env *env,
 305                                  const struct cl_page_slice *slice,
 306                                  struct cl_io *io);
 307 void ccc_transient_page_disown(const struct lu_env *env,
 308                                const struct cl_page_slice *slice,
 309                                struct cl_io *io);
 310 void ccc_transient_page_discard(const struct lu_env *env,
 311                                 const struct cl_page_slice *slice,
 312                                 struct cl_io *io);
 313 int ccc_transient_page_prep(const struct lu_env *env,
 314                             const struct cl_page_slice *slice,
 315                             struct cl_io *io);
 316 void ccc_lock_delete(const struct lu_env *env,
 317                      const struct cl_lock_slice *slice);
 318 void ccc_lock_fini(const struct lu_env *env,struct cl_lock_slice *slice);
 319 int ccc_lock_enqueue(const struct lu_env *env,const struct cl_lock_slice *slice,
 320                      struct cl_io *io, __u32 enqflags);
 321 int ccc_lock_unuse(const struct lu_env *env,const struct cl_lock_slice *slice);
 322 int ccc_lock_wait(const struct lu_env *env,const struct cl_lock_slice *slice);
 323 int ccc_lock_fits_into(const struct lu_env *env,
 324                        const struct cl_lock_slice *slice,
 325                        const struct cl_lock_descr *need,
 326                        const struct cl_io *io);
 327 void ccc_lock_state(const struct lu_env *env,
 328                     const struct cl_lock_slice *slice,
 329                     enum cl_lock_state state);
 330
 331 void ccc_io_fini(const struct lu_env *env, const struct cl_io_slice *ios);
 332 int ccc_io_one_lock_index(const struct lu_env *env, struct cl_io *io,
 333                           __u32 enqflags, enum cl_lock_mode mode,
 334                           pgoff_t start, pgoff_t end);
 335 int ccc_io_one_lock(const struct lu_env *env, struct cl_io *io,
 336                     __u32 enqflags, enum cl_lock_mode mode,
 337                     loff_t start, loff_t end);
 338 void ccc_io_end(const struct lu_env *env, const struct cl_io_slice *ios);
 339 void ccc_io_advance(const struct lu_env *env, const struct cl_io_slice *ios,
 340                     size_t nob);
 341 void ccc_io_update_iov(const struct lu_env *env, struct ccc_io *cio,
 342                        struct cl_io *io);
 343 int ccc_prep_size(const struct lu_env *env, struct cl_object *obj,
 344                   struct cl_io *io, loff_t start, size_t count, int *exceed);
 345 void ccc_req_completion(const struct lu_env *env,
 346                         const struct cl_req_slice *slice, int ioret);
 347 void ccc_req_attr_set(const struct lu_env *env,const struct cl_req_slice *slice,
 348                       const struct cl_object *obj,
 349                       struct cl_req_attr *oa, obd_valid flags);
 350
 351 struct lu_device   *ccc2lu_dev      (struct ccc_device *vdv);
 352 struct lu_object   *ccc2lu          (struct ccc_object *vob);
 353 struct ccc_device  *lu2ccc_dev      (const struct lu_device *d);
 354 struct ccc_device  *cl2ccc_dev      (const struct cl_device *d);
 355 struct ccc_object  *lu2ccc          (const struct lu_object *obj);
 356 struct ccc_object  *cl2ccc          (const struct cl_object *obj);
 357 struct ccc_lock    *cl2ccc_lock     (const struct cl_lock_slice *slice);
 358 struct ccc_io      *cl2ccc_io       (const struct lu_env *env,
 359                                      const struct cl_io_slice *slice);
 360 struct ccc_req     *cl2ccc_req      (const struct cl_req_slice *slice);
 361 cfs_page_t         *cl2vm_page      (const struct cl_page_slice *slice);
 362 struct inode       *ccc_object_inode(const struct cl_object *obj);
 363 struct ccc_object  *cl_inode2ccc    (struct inode *inode);
 364
 365 int cl_setattr_ost(struct inode *inode, const struct iattr *attr,
 366                    struct obd_capa *capa);
 367
 368 struct cl_page *ccc_vmpage_page_transient(cfs_page_t *vmpage);
 369 int ccc_object_invariant(const struct cl_object *obj);
 370 int cl_file_inode_init(struct inode *inode, struct lustre_md *md);
 371 void cl_inode_fini(struct inode *inode);
 372 int cl_local_size(struct inode *inode);
 373
 374 __u16 ll_dirent_type_get(struct lu_dirent *ent);
 375 __u64 cl_fid_build_ino(const struct lu_fid *fid, int api32);
 376 __u32 cl_fid_build_gen(const struct lu_fid *fid);
 377
 378 #ifdef INVARIANT_CHECK
 379 # define CLOBINVRNT(env, clob, expr)                                    \
 380   do {                                                                  \
 381           if (unlikely(!(expr))) {                                      \
 382                   LU_OBJECT_DEBUG(D_ERROR, (env), &(clob)->co_lu, #expr "\n"); \
 383                   LINVRNT(0);                                           \
 384           }                                                             \
 385   } while (0)
 386 #else /* !INVARIANT_CHECK */
 387 # define CLOBINVRNT(env, clob, expr)                                    \
 388         ((void)sizeof(env), (void)sizeof(clob), (void)sizeof !!(expr))
 389 #endif /* !INVARIANT_CHECK */
 390
 391 int cl_init_ea_size(struct obd_export *md_exp, struct obd_export *dt_exp);
 392 int cl_ocd_update(struct obd_device *host,
 393                   struct obd_device *watched,
 394                   enum obd_notify_event ev, void *owner, void *data);
 395
 396 struct ccc_grouplock {
 397         struct lu_env   *cg_env;
 398         struct cl_io    *cg_io;
 399         struct cl_lock  *cg_lock;
 400         unsigned long    cg_gid;
 401 };
 402
 403 int  cl_get_grouplock(struct cl_object *obj, unsigned long gid, int nonblock,
 404                       struct ccc_grouplock *cg);
 405 void cl_put_grouplock(struct ccc_grouplock *cg);
 406
 407 /**
 408  * New interfaces to get and put lov_stripe_md from lov layer. This violates
 409  * layering because lov_stripe_md is supposed to be a private data in lov.
 410  *
 411  * NB: If you find you have to use these interfaces for your new code, please
 412  * think about it again. These interfaces may be removed in the future for
 413  * better layering. */
 414 struct lov_stripe_md *lov_lsm_get(struct cl_object *clobj);
 415 void lov_lsm_put(struct cl_object *clobj, struct lov_stripe_md *lsm);
 416 int lov_read_and_clear_async_rc(struct cl_object *clob);
 417
 418 struct lov_stripe_md *ccc_inode_lsm_get(struct inode *inode);
 419 void ccc_inode_lsm_put(struct inode *inode, struct lov_stripe_md *lsm);
 420
 421 #endif /*LCLIENT_H */