lustre/include/lclient.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
  30  * Use is subject to license terms.
  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 int cl_glimpse_size(struct inode *inode);
  47 int cl_glimpse_lock(const struct lu_env *env, struct cl_io *io,
  48                     struct inode *inode, struct cl_object *clob);
  49
  50 /**
  51  * Common IO arguments for various VFS I/O interfaces.
  52  */
  53 struct ccc_io_args {
  54         int           cia_is_sendfile;
  55 #ifndef HAVE_FILE_WRITEV
  56         struct kiocb *cia_iocb;
  57 #endif
  58         struct iovec *cia_iov;
  59         unsigned long cia_nrsegs;
  60         read_actor_t  cia_actor;
  61         void         *cia_target;
  62 };
  63
  64 /**
  65  * Locking policy for truncate.
  66  */
  67 enum ccc_trunc_lock_type {
  68         /** Locking is done by server */
  69         TRUNC_NOLOCK,
  70         /** Extent lock is enqueued */
  71         TRUNC_EXTENT,
  72         /** Existing local extent lock is used */
  73         TRUNC_MATCH
  74 };
  75
  76 /**
  77  * IO state private to vvp or slp layers.
  78  */
  79 struct ccc_io {
  80         /** super class */
  81         struct cl_io_slice     cui_cl;
  82         struct cl_io_lock_link cui_link;
  83         /**
  84          * I/O vector information to or from which read/write is going.
  85          */
  86         struct iovec *cui_iov;
  87         unsigned long cui_nrsegs;
  88         /**
  89          * Total iov count for left IO.
  90          */
  91         unsigned long cui_tot_nrsegs;
  92         /**
  93          * Old length for iov that was truncated partially.
  94          */
  95         size_t cui_iov_olen;
  96         /**
  97          * Total size for the left IO.
  98          */
  99         size_t cui_tot_count;
 100
 101         union {
 102                 struct {
 103                         int                      cui_locks_released;
 104                         enum ccc_trunc_lock_type cui_local_lock;
 105                 } trunc;
 106         } u;
 107         /**
 108          * True iff io is processing glimpse right now.
 109          */
 110         int                  cui_glimpse;
 111         /**
 112          * File descriptor against which IO is done.
 113          */
 114         struct ll_file_data *cui_fd;
 115 #ifndef HAVE_FILE_WRITEV
 116         struct kiocb *cui_iocb;
 117 #endif
 118 };
 119
 120 extern struct lu_context_key ccc_key;
 121 extern struct lu_context_key ccc_session_key;
 122
 123 struct ccc_thread_info {
 124         struct cl_lock_descr cti_descr;
 125         struct cl_io         cti_io;
 126         struct cl_attr       cti_attr;
 127 };
 128
 129 static inline struct ccc_thread_info *ccc_env_info(const struct lu_env *env)
 130 {
 131         struct ccc_thread_info      *info;
 132
 133         info = lu_context_key_get(&env->le_ctx, &ccc_key);
 134         LASSERT(info != NULL);
 135         return info;
 136 }
 137
 138 static inline struct cl_attr *ccc_env_thread_attr(const struct lu_env *env)
 139 {
 140         struct cl_attr *attr = &ccc_env_info(env)->cti_attr;
 141         memset(attr, 0, sizeof(*attr));
 142         return attr;
 143 }
 144
 145 struct ccc_session {
 146         struct ccc_io cs_ios;
 147 };
 148
 149 static inline struct ccc_session *ccc_env_session(const struct lu_env *env)
 150 {
 151         struct ccc_session *ses;
 152
 153         ses = lu_context_key_get(env->le_ses, &ccc_session_key);
 154         LASSERT(ses != NULL);
 155         return ses;
 156 }
 157
 158 static inline struct ccc_io *ccc_env_io(const struct lu_env *env)
 159 {
 160         return &ccc_env_session(env)->cs_ios;
 161 }
 162
 163 /**
 164  * ccc-private object state.
 165  */
 166 struct ccc_object {
 167         struct cl_object_header cob_header;
 168         struct cl_object        cob_cl;
 169         struct inode           *cob_inode;
 170
 171         /**
 172          * A list of dirty pages pending IO in the cache. Used by
 173          * SOM. Protected by ll_inode_info::lli_lock.
 174          *
 175          * \see ccc_page::cpg_pending_linkage
 176          */
 177         struct list_head        cob_pending_list;
 178
 179         /**
 180          * Access this counter is protected by inode->i_sem. Now that
 181          * the lifetime of transient pages must be covered by inode sem,
 182          * we don't need to hold any lock..
 183          */
 184         int                     cob_transient_pages;
 185         /**
 186          * Number of outstanding mmaps on this file.
 187          *
 188          * \see ll_vm_open(), ll_vm_close().
 189          */
 190         atomic_t                cob_mmap_cnt;
 191 };
 192
 193 /**
 194  * ccc-private page state.
 195  */
 196 struct ccc_page {
 197         struct cl_page_slice cpg_cl;
 198         int                  cpg_defer_uptodate;
 199         int                  cpg_ra_used;
 200         int                  cpg_write_queued;
 201         /**
 202          * Non-empty iff this page is already counted in
 203          * ccc_object::cob_pending_list. Protected by
 204          * ccc_object::cob_pending_guard. This list is only used as a flag,
 205          * that is, never iterated through, only checked for list_empty(), but
 206          * having a list is useful for debugging.
 207          */
 208         struct list_head     cpg_pending_linkage;
 209         /** VM page */
 210         cfs_page_t          *cpg_page;
 211         /**
 212          * checksum for paranoid I/O debugging enabled by
 213          * ENABLE_LLITE_CHECKSUM configuration option.
 214          *
 215          * XXX This cannot be implemented reliably because checksum cannot be
 216          * updated from ->set_page_dirty() that is called without page VM
 217          * lock.
 218          */
 219         __u32                cpg_checksum;
 220 };
 221
 222 static inline struct ccc_page *cl2ccc_page(const struct cl_page_slice *slice)
 223 {
 224         return container_of(slice, struct ccc_page, cpg_cl);
 225 }
 226
 227 struct cl_page    *ccc_vmpage_page_transient(cfs_page_t *vmpage);
 228
 229 struct ccc_device {
 230         struct cl_device    cdv_cl;
 231         struct super_block *cdv_sb;
 232         struct cl_device   *cdv_next;
 233 };
 234
 235 struct ccc_lock {
 236         struct cl_lock_slice clk_cl;
 237 };
 238
 239 struct ccc_req {
 240         struct cl_req_slice  crq_cl;
 241 };
 242
 243 void *ccc_key_init        (const struct lu_context *ctx,
 244                            struct lu_context_key *key);
 245 void  ccc_key_fini        (const struct lu_context *ctx,
 246                            struct lu_context_key *key, void *data);
 247 void *ccc_session_key_init(const struct lu_context *ctx,
 248                            struct lu_context_key *key);
 249 void  ccc_session_key_fini(const struct lu_context *ctx,
 250                            struct lu_context_key *key, void *data);
 251
 252 int              ccc_device_init  (const struct lu_env *env,
 253                                    struct lu_device *d,
 254                                    const char *name, struct lu_device *next);
 255 struct lu_device *ccc_device_fini (const struct lu_env *env,
 256                                    struct lu_device *d);
 257 struct lu_device *ccc_device_alloc(const struct lu_env *env,
 258                                    struct lu_device_type *t,
 259                                    struct lustre_cfg *cfg,
 260                                    const struct lu_device_operations *luops,
 261                                    const struct cl_device_operations *clops);
 262 struct lu_device *ccc_device_free (const struct lu_env *env,
 263                                    struct lu_device *d);
 264 struct lu_object *ccc_object_alloc(const struct lu_env *env,
 265                                    const struct lu_object_header *hdr,
 266                                    struct lu_device *dev,
 267                                    const struct cl_object_operations *clops,
 268                                    const struct lu_object_operations *luops);
 269
 270 int ccc_req_init(const struct lu_env *env, struct cl_device *dev,
 271                  struct cl_req *req);
 272 void ccc_umount(const struct lu_env *env, struct cl_device *dev);
 273 int ccc_global_init(struct lu_device_type *device_type);
 274 void ccc_global_fini(struct lu_device_type *device_type);
 275 int ccc_object_init0(const struct lu_env *env,struct ccc_object *vob,
 276                      const struct cl_object_conf *conf);
 277 int ccc_object_init(const struct lu_env *env, struct lu_object *obj,
 278                     const struct lu_object_conf *conf);
 279 void ccc_object_free(const struct lu_env *env, struct lu_object *obj);
 280 int ccc_lock_init(const struct lu_env *env, struct cl_object *obj,
 281                   struct cl_lock *lock, const struct cl_io *io,
 282                   const struct cl_lock_operations *lkops);
 283 int ccc_attr_set(const struct lu_env *env, struct cl_object *obj,
 284                  const struct cl_attr *attr, unsigned valid);
 285 int ccc_object_glimpse(const struct lu_env *env,
 286                        const struct cl_object *obj, struct ost_lvb *lvb);
 287 int ccc_conf_set(const struct lu_env *env, struct cl_object *obj,
 288                  const struct cl_object_conf *conf);
 289 cfs_page_t *ccc_page_vmpage(const struct lu_env *env,
 290                             const struct cl_page_slice *slice);
 291 int ccc_page_is_under_lock(const struct lu_env *env,
 292                            const struct cl_page_slice *slice, struct cl_io *io);
 293 int ccc_fail(const struct lu_env *env, const struct cl_page_slice *slice);
 294 void ccc_transient_page_verify(const struct cl_page *page);
 295 void ccc_transient_page_own(const struct lu_env *env,
 296                             const struct cl_page_slice *slice,
 297                             struct cl_io *io);
 298 void ccc_transient_page_assume(const struct lu_env *env,
 299                                const struct cl_page_slice *slice,
 300                                struct cl_io *io);
 301 void ccc_transient_page_unassume(const struct lu_env *env,
 302                                  const struct cl_page_slice *slice,
 303                                  struct cl_io *io);
 304 void ccc_transient_page_disown(const struct lu_env *env,
 305                                const struct cl_page_slice *slice,
 306                                struct cl_io *io);
 307 void ccc_transient_page_discard(const struct lu_env *env,
 308                                 const struct cl_page_slice *slice,
 309                                 struct cl_io *io);
 310 int ccc_transient_page_prep(const struct lu_env *env,
 311                             const struct cl_page_slice *slice,
 312                             struct cl_io *io);
 313 void ccc_lock_delete(const struct lu_env *env,
 314                      const struct cl_lock_slice *slice);
 315 void ccc_lock_fini(const struct lu_env *env,struct cl_lock_slice *slice);
 316 int ccc_lock_enqueue(const struct lu_env *env,const struct cl_lock_slice *slice,
 317                      struct cl_io *io, __u32 enqflags);
 318 int ccc_lock_unuse(const struct lu_env *env,const struct cl_lock_slice *slice);
 319 int ccc_lock_wait(const struct lu_env *env,const struct cl_lock_slice *slice);
 320 int ccc_lock_fits_into(const struct lu_env *env,
 321                        const struct cl_lock_slice *slice,
 322                        const struct cl_lock_descr *need,
 323                        const struct cl_io *io);
 324 void ccc_lock_state(const struct lu_env *env,
 325                     const struct cl_lock_slice *slice,
 326                     enum cl_lock_state state);
 327
 328 void ccc_io_fini(const struct lu_env *env, const struct cl_io_slice *ios);
 329 int ccc_io_one_lock_index(const struct lu_env *env, struct cl_io *io,
 330                           __u32 enqflags, enum cl_lock_mode mode,
 331                           pgoff_t start, pgoff_t end);
 332 int ccc_io_one_lock(const struct lu_env *env, struct cl_io *io,
 333                     __u32 enqflags, enum cl_lock_mode mode,
 334                     loff_t start, loff_t end);
 335 void ccc_io_end(const struct lu_env *env, const struct cl_io_slice *ios);
 336 void ccc_io_advance(const struct lu_env *env, const struct cl_io_slice *ios,
 337                     size_t nob);
 338 void ccc_io_update_iov(const struct lu_env *env, struct ccc_io *cio,
 339                        struct cl_io *io);
 340 int ccc_prep_size(const struct lu_env *env, struct cl_object *obj,
 341                   struct cl_io *io, loff_t start, size_t count, int vfslock,
 342                   int *exceed);
 343 void ccc_req_completion(const struct lu_env *env,
 344                         const struct cl_req_slice *slice, int ioret);
 345 void ccc_req_attr_set(const struct lu_env *env,const struct cl_req_slice *slice,
 346                       const struct cl_object *obj,
 347                       struct cl_req_attr *oa, obd_valid flags);
 348
 349 struct lu_device   *ccc2lu_dev      (struct ccc_device *vdv);
 350 struct lu_object   *ccc2lu          (struct ccc_object *vob);
 351 struct ccc_device  *lu2ccc_dev      (const struct lu_device *d);
 352 struct ccc_device  *cl2ccc_dev      (const struct cl_device *d);
 353 struct ccc_object  *lu2ccc          (const struct lu_object *obj);
 354 struct ccc_object  *cl2ccc          (const struct cl_object *obj);
 355 struct ccc_lock    *cl2ccc_lock     (const struct cl_lock_slice *slice);
 356 struct ccc_io      *cl2ccc_io       (const struct lu_env *env,
 357                                      const struct cl_io_slice *slice);
 358 struct ccc_req     *cl2ccc_req      (const struct cl_req_slice *slice);
 359 cfs_page_t         *cl2vm_page      (const struct cl_page_slice *slice);
 360 struct inode       *ccc_object_inode(const struct cl_object *obj);
 361 struct ccc_object  *cl_inode2ccc    (struct inode *inode);
 362
 363 int cl_setattr_do_truncate(struct inode *inode, loff_t size,
 364                            struct obd_capa *capa);
 365 int cl_setattr_ost(struct inode *inode, struct obd_capa *capa);
 366
 367 struct cl_page *ccc_vmpage_page_transient(cfs_page_t *vmpage);
 368 int ccc_object_invariant(const struct cl_object *obj);
 369 int cl_inode_init(struct inode *inode, struct lustre_md *md);
 370 void cl_inode_fini(struct inode *inode);
 371 int cl_local_size(struct inode *inode);
 372
 373 __u16 ll_dirent_type_get(struct lu_dirent *ent);
 374
 375 #ifdef INVARIANT_CHECK
 376 # define CLOBINVRNT(env, clob, expr)                                    \
 377   do {                                                                  \
 378           if (unlikely(!(expr))) {                                      \
 379                   LU_OBJECT_DEBUG(D_ERROR, (env), &(clob)->co_lu, #expr "\n"); \
 380                   LINVRNT(0);                                           \
 381           }                                                             \
 382   } while (0)
 383 #else /* !INVARIANT_CHECK */
 384 # define CLOBINVRNT(env, clob, expr)                                    \
 385         ((void)sizeof(env), (void)sizeof(clob), (void)sizeof !!(expr))
 386 #endif /* !INVARIANT_CHECK */
 387
 388 int cl_init_ea_size(struct obd_export *md_exp, struct obd_export *dt_exp);
 389 int cl_ocd_update(struct obd_device *host,
 390                   struct obd_device *watched,
 391                   enum obd_notify_event ev, void *owner, void *data);
 392
 393 struct ccc_grouplock {
 394         struct lu_env   *cg_env;
 395         struct cl_lock  *cg_lock;
 396         unsigned long    cg_gid;
 397 };
 398
 399 int  cl_get_grouplock(struct cl_object *obj, unsigned long gid, int nonblock,
 400                       struct ccc_grouplock *cg);
 401 void cl_put_grouplock(struct ccc_grouplock *cg);
 402
 403 #endif /*LCLIENT_H */