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 (c) 2008, 2010, Oracle and/or its affiliates. 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  * Locking policy for setattr.
  52  */
  53 enum ccc_setattr_lock_type {
  54         /** Locking is done by server */
  55         SETATTR_NOLOCK,
  56         /** Extent lock is enqueued */
  57         SETATTR_EXTENT_LOCK,
  58         /** Existing local extent lock is used */
  59         SETATTR_MATCH_LOCK
  60 };
  61
  62
  63 /**
  64  * IO state private to vvp or slp layers.
  65  */
  66 struct ccc_io {
  67         /** super class */
  68         struct cl_io_slice     cui_cl;
  69         struct cl_io_lock_link cui_link;
  70         /**
  71          * I/O vector information to or from which read/write is going.
  72          */
  73         struct iovec *cui_iov;
  74         unsigned long cui_nrsegs;
  75         /**
  76          * Total iov count for left IO.
  77          */
  78         unsigned long cui_tot_nrsegs;
  79         /**
  80          * Old length for iov that was truncated partially.
  81          */
  82         size_t cui_iov_olen;
  83         /**
  84          * Total size for the left IO.
  85          */
  86         size_t cui_tot_count;
  87
  88         union {
  89                 struct {
  90                         int                        cui_locks_released;
  91                         enum ccc_setattr_lock_type cui_local_lock;
  92                 } setattr;
  93         } u;
  94         /**
  95          * True iff io is processing glimpse right now.
  96          */
  97         int                  cui_glimpse;
  98         /**
  99          * File descriptor against which IO is done.
 100          */
 101         struct ll_file_data *cui_fd;
 102 #ifndef HAVE_FILE_WRITEV
 103         struct kiocb *cui_iocb;
 104 #endif
 105 };
 106
 107 /**
 108  * True, if \a io is a normal io, False for other (sendfile, splice*).
 109  * must be impementated in arch specific code.
 110  */
 111 int cl_is_normalio(const struct lu_env *env, const struct cl_io *io);
 112
 113 extern struct lu_context_key ccc_key;
 114 extern struct lu_context_key ccc_session_key;
 115
 116 struct ccc_thread_info {
 117         struct cl_lock_descr cti_descr;
 118         struct cl_io         cti_io;
 119         struct cl_attr       cti_attr;
 120 };
 121
 122 static inline struct ccc_thread_info *ccc_env_info(const struct lu_env *env)
 123 {
 124         struct ccc_thread_info      *info;
 125
 126         info = lu_context_key_get(&env->le_ctx, &ccc_key);
 127         LASSERT(info != NULL);
 128         return info;
 129 }
 130
 131 static inline struct cl_attr *ccc_env_thread_attr(const struct lu_env *env)
 132 {
 133         struct cl_attr *attr = &ccc_env_info(env)->cti_attr;
 134         memset(attr, 0, sizeof(*attr));
 135         return attr;
 136 }
 137
 138 static inline struct cl_io *ccc_env_thread_io(const struct lu_env *env)
 139 {
 140         struct cl_io *io = &ccc_env_info(env)->cti_io;
 141         memset(io, 0, sizeof(*io));
 142         return io;
 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         cfs_list_t             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         cfs_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         cfs_list_t           cpg_pending_linkage;
 209         /** VM page */
 210         cfs_page_t          *cpg_page;
 211 };
 212
 213 static inline struct ccc_page *cl2ccc_page(const struct cl_page_slice *slice)
 214 {
 215         return container_of(slice, struct ccc_page, cpg_cl);
 216 }
 217
 218 struct cl_page    *ccc_vmpage_page_transient(cfs_page_t *vmpage);
 219
 220 struct ccc_device {
 221         struct cl_device    cdv_cl;
 222         struct super_block *cdv_sb;
 223         struct cl_device   *cdv_next;
 224 };
 225
 226 struct ccc_lock {
 227         struct cl_lock_slice clk_cl;
 228 };
 229
 230 struct ccc_req {
 231         struct cl_req_slice  crq_cl;
 232 };
 233
 234 void *ccc_key_init        (const struct lu_context *ctx,
 235                            struct lu_context_key *key);
 236 void  ccc_key_fini        (const struct lu_context *ctx,
 237                            struct lu_context_key *key, void *data);
 238 void *ccc_session_key_init(const struct lu_context *ctx,
 239                            struct lu_context_key *key);
 240 void  ccc_session_key_fini(const struct lu_context *ctx,
 241                            struct lu_context_key *key, void *data);
 242
 243 int              ccc_device_init  (const struct lu_env *env,
 244                                    struct lu_device *d,
 245                                    const char *name, struct lu_device *next);
 246 struct lu_device *ccc_device_fini (const struct lu_env *env,
 247                                    struct lu_device *d);
 248 struct lu_device *ccc_device_alloc(const struct lu_env *env,
 249                                    struct lu_device_type *t,
 250                                    struct lustre_cfg *cfg,
 251                                    const struct lu_device_operations *luops,
 252                                    const struct cl_device_operations *clops);
 253 struct lu_device *ccc_device_free (const struct lu_env *env,
 254                                    struct lu_device *d);
 255 struct lu_object *ccc_object_alloc(const struct lu_env *env,
 256                                    const struct lu_object_header *hdr,
 257                                    struct lu_device *dev,
 258                                    const struct cl_object_operations *clops,
 259                                    const struct lu_object_operations *luops);
 260
 261 int ccc_req_init(const struct lu_env *env, struct cl_device *dev,
 262                  struct cl_req *req);
 263 void ccc_umount(const struct lu_env *env, struct cl_device *dev);
 264 int ccc_global_init(struct lu_device_type *device_type);
 265 void ccc_global_fini(struct lu_device_type *device_type);
 266 int ccc_object_init0(const struct lu_env *env,struct ccc_object *vob,
 267                      const struct cl_object_conf *conf);
 268 int ccc_object_init(const struct lu_env *env, struct lu_object *obj,
 269                     const struct lu_object_conf *conf);
 270 void ccc_object_free(const struct lu_env *env, struct lu_object *obj);
 271 int ccc_lock_init(const struct lu_env *env, struct cl_object *obj,
 272                   struct cl_lock *lock, const struct cl_io *io,
 273                   const struct cl_lock_operations *lkops);
 274 int ccc_attr_set(const struct lu_env *env, struct cl_object *obj,
 275                  const struct cl_attr *attr, unsigned valid);
 276 int ccc_object_glimpse(const struct lu_env *env,
 277                        const struct cl_object *obj, struct ost_lvb *lvb);
 278 int ccc_conf_set(const struct lu_env *env, struct cl_object *obj,
 279                  const struct cl_object_conf *conf);
 280 cfs_page_t *ccc_page_vmpage(const struct lu_env *env,
 281                             const struct cl_page_slice *slice);
 282 int ccc_page_is_under_lock(const struct lu_env *env,
 283                            const struct cl_page_slice *slice, struct cl_io *io);
 284 int ccc_fail(const struct lu_env *env, const struct cl_page_slice *slice);
 285 void ccc_transient_page_verify(const struct cl_page *page);
 286 int  ccc_transient_page_own(const struct lu_env *env,
 287                             const struct cl_page_slice *slice,
 288                             struct cl_io *io, int nonblock);
 289 void ccc_transient_page_assume(const struct lu_env *env,
 290                                const struct cl_page_slice *slice,
 291                                struct cl_io *io);
 292 void ccc_transient_page_unassume(const struct lu_env *env,
 293                                  const struct cl_page_slice *slice,
 294                                  struct cl_io *io);
 295 void ccc_transient_page_disown(const struct lu_env *env,
 296                                const struct cl_page_slice *slice,
 297                                struct cl_io *io);
 298 void ccc_transient_page_discard(const struct lu_env *env,
 299                                 const struct cl_page_slice *slice,
 300                                 struct cl_io *io);
 301 int ccc_transient_page_prep(const struct lu_env *env,
 302                             const struct cl_page_slice *slice,
 303                             struct cl_io *io);
 304 void ccc_lock_delete(const struct lu_env *env,
 305                      const struct cl_lock_slice *slice);
 306 void ccc_lock_fini(const struct lu_env *env,struct cl_lock_slice *slice);
 307 int ccc_lock_enqueue(const struct lu_env *env,const struct cl_lock_slice *slice,
 308                      struct cl_io *io, __u32 enqflags);
 309 int ccc_lock_unuse(const struct lu_env *env,const struct cl_lock_slice *slice);
 310 int ccc_lock_wait(const struct lu_env *env,const struct cl_lock_slice *slice);
 311 int ccc_lock_fits_into(const struct lu_env *env,
 312                        const struct cl_lock_slice *slice,
 313                        const struct cl_lock_descr *need,
 314                        const struct cl_io *io);
 315 void ccc_lock_state(const struct lu_env *env,
 316                     const struct cl_lock_slice *slice,
 317                     enum cl_lock_state state);
 318
 319 void ccc_io_fini(const struct lu_env *env, const struct cl_io_slice *ios);
 320 int ccc_io_one_lock_index(const struct lu_env *env, struct cl_io *io,
 321                           __u32 enqflags, enum cl_lock_mode mode,
 322                           pgoff_t start, pgoff_t end);
 323 int ccc_io_one_lock(const struct lu_env *env, struct cl_io *io,
 324                     __u32 enqflags, enum cl_lock_mode mode,
 325                     loff_t start, loff_t end);
 326 void ccc_io_end(const struct lu_env *env, const struct cl_io_slice *ios);
 327 void ccc_io_advance(const struct lu_env *env, const struct cl_io_slice *ios,
 328                     size_t nob);
 329 void ccc_io_update_iov(const struct lu_env *env, struct ccc_io *cio,
 330                        struct cl_io *io);
 331 int ccc_prep_size(const struct lu_env *env, struct cl_object *obj,
 332                   struct cl_io *io, loff_t start, size_t count, int vfslock,
 333                   int *exceed);
 334 void ccc_req_completion(const struct lu_env *env,
 335                         const struct cl_req_slice *slice, int ioret);
 336 void ccc_req_attr_set(const struct lu_env *env,const struct cl_req_slice *slice,
 337                       const struct cl_object *obj,
 338                       struct cl_req_attr *oa, obd_valid flags);
 339
 340 struct lu_device   *ccc2lu_dev      (struct ccc_device *vdv);
 341 struct lu_object   *ccc2lu          (struct ccc_object *vob);
 342 struct ccc_device  *lu2ccc_dev      (const struct lu_device *d);
 343 struct ccc_device  *cl2ccc_dev      (const struct cl_device *d);
 344 struct ccc_object  *lu2ccc          (const struct lu_object *obj);
 345 struct ccc_object  *cl2ccc          (const struct cl_object *obj);
 346 struct ccc_lock    *cl2ccc_lock     (const struct cl_lock_slice *slice);
 347 struct ccc_io      *cl2ccc_io       (const struct lu_env *env,
 348                                      const struct cl_io_slice *slice);
 349 struct ccc_req     *cl2ccc_req      (const struct cl_req_slice *slice);
 350 cfs_page_t         *cl2vm_page      (const struct cl_page_slice *slice);
 351 struct inode       *ccc_object_inode(const struct cl_object *obj);
 352 struct ccc_object  *cl_inode2ccc    (struct inode *inode);
 353
 354 int cl_setattr_ost(struct inode *inode, const struct iattr *attr,
 355                    struct obd_capa *capa);
 356
 357 struct cl_page *ccc_vmpage_page_transient(cfs_page_t *vmpage);
 358 int ccc_object_invariant(const struct cl_object *obj);
 359 int cl_inode_init(struct inode *inode, struct lustre_md *md);
 360 void cl_inode_fini(struct inode *inode);
 361 int cl_local_size(struct inode *inode);
 362
 363 __u16 ll_dirent_type_get(struct lu_dirent *ent);
 364 __u64 cl_fid_build_ino(const struct lu_fid *fid);
 365 __u32 cl_fid_build_ino32(const struct lu_fid *fid);
 366 __u32 cl_fid_build_gen(const struct lu_fid *fid);
 367
 368 #ifdef INVARIANT_CHECK
 369 # define CLOBINVRNT(env, clob, expr)                                    \
 370   do {                                                                  \
 371           if (unlikely(!(expr))) {                                      \
 372                   LU_OBJECT_DEBUG(D_ERROR, (env), &(clob)->co_lu, #expr "\n"); \
 373                   LINVRNT(0);                                           \
 374           }                                                             \
 375   } while (0)
 376 #else /* !INVARIANT_CHECK */
 377 # define CLOBINVRNT(env, clob, expr)                                    \
 378         ((void)sizeof(env), (void)sizeof(clob), (void)sizeof !!(expr))
 379 #endif /* !INVARIANT_CHECK */
 380
 381 int cl_init_ea_size(struct obd_export *md_exp, struct obd_export *dt_exp);
 382 int cl_ocd_update(struct obd_device *host,
 383                   struct obd_device *watched,
 384                   enum obd_notify_event ev, void *owner, void *data);
 385
 386 struct ccc_grouplock {
 387         struct lu_env   *cg_env;
 388         struct cl_io    *cg_io;
 389         struct cl_lock  *cg_lock;
 390         unsigned long    cg_gid;
 391 };
 392
 393 int  cl_get_grouplock(struct cl_object *obj, unsigned long gid, int nonblock,
 394                       struct ccc_grouplock *cg);
 395 void cl_put_grouplock(struct ccc_grouplock *cg);
 396
 397 #endif /*LCLIENT_H */