Whamcloud - gitweb
LU-3963 obdclass: convert to linux list api
[fs/lustre-release.git] / lustre / include / lclient.h
index 8b86063..afa462c 100644 (file)
@@ -1,6 +1,4 @@
-/* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
- * vim:expandtab:shiftwidth=8:tabstop=8:
- *
+/*
  * GPL HEADER START
  *
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  * GPL HEADER END
  */
 /*
- * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
+ * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  * Use is subject to license terms.
+ *
+ * Copyright (c) 2011, 2013, Intel Corporation.
  */
 /*
  * This file is part of Lustre, http://www.lustre.org/
 #ifndef LCLIENT_H
 #define LCLIENT_H
 
-int cl_glimpse_size(struct inode *inode);
+#include <lustre/lustre_idl.h>
+#include <cl_object.h>
+
+enum obd_notify_event;
+struct inode;
+struct lov_stripe_md;
+struct lustre_md;
+struct obd_capa;
+struct obd_device;
+struct obd_export;
+struct page;
+
+blkcnt_t dirty_cnt(struct inode *inode);
+
+int cl_glimpse_size0(struct inode *inode, int agl);
 int cl_glimpse_lock(const struct lu_env *env, struct cl_io *io,
-                    struct inode *inode, struct cl_object *clob);
+                    struct inode *inode, struct cl_object *clob, int agl);
 
-/**
- * Common IO arguments for various VFS I/O interfaces.
- */
-struct ccc_io_args {
-        int           cia_is_sendfile;
-#ifndef HAVE_FILE_WRITEV
-        struct kiocb *cia_iocb;
-#endif
-        struct iovec *cia_iov;
-        unsigned long cia_nrsegs;
-        read_actor_t  cia_actor;
-        void         *cia_target;
-};
+static inline int cl_glimpse_size(struct inode *inode)
+{
+        return cl_glimpse_size0(inode, 0);
+}
+
+static inline int cl_agl(struct inode *inode)
+{
+        return cl_glimpse_size0(inode, 1);
+}
 
 /**
- * Locking policy for truncate.
+ * Locking policy for setattr.
  */
-enum ccc_trunc_lock_type {
+enum ccc_setattr_lock_type {
         /** Locking is done by server */
-        TRUNC_NOLOCK,
+        SETATTR_NOLOCK,
         /** Extent lock is enqueued */
-        TRUNC_EXTENT,
+        SETATTR_EXTENT_LOCK,
         /** Existing local extent lock is used */
-        TRUNC_MATCH
+        SETATTR_MATCH_LOCK
 };
 
+
 /**
  * IO state private to vvp or slp layers.
  */
@@ -100,30 +111,42 @@ struct ccc_io {
 
         union {
                 struct {
-                        int                      cui_locks_released;
-                        enum ccc_trunc_lock_type cui_local_lock;
-                } trunc;
-        } u;
-        /**
-         * True iff io is processing glimpse right now.
-         */
-        int                  cui_glimpse;
+                        enum ccc_setattr_lock_type cui_local_lock;
+                } setattr;
+               struct {
+                       struct cl_page_list cui_queue;
+                       unsigned long cui_written;
+                       int cui_from;
+                       int cui_to;
+               } write;
+       } u;
+       /**
+        * True iff io is processing glimpse right now.
+        */
+       int                  cui_glimpse;
+       /**
+        * Layout version when this IO is initialized
+        */
+       __u32                cui_layout_gen;
         /**
          * File descriptor against which IO is done.
          */
         struct ll_file_data *cui_fd;
-#ifndef HAVE_FILE_WRITEV
         struct kiocb *cui_iocb;
-#endif
 };
 
+/**
+ * True, if \a io is a normal io, False for other splice_{read,write}.
+ * must be impementated in arch specific code.
+ */
+int cl_is_normalio(const struct lu_env *env, const struct cl_io *io);
+
 extern struct lu_context_key ccc_key;
 extern struct lu_context_key ccc_session_key;
 
 struct ccc_thread_info {
         struct cl_lock_descr cti_descr;
         struct cl_io         cti_io;
-        struct cl_sync_io    cti_sync_io;
         struct cl_attr       cti_attr;
 };
 
@@ -143,6 +166,13 @@ static inline struct cl_attr *ccc_env_thread_attr(const struct lu_env *env)
         return attr;
 }
 
+static inline struct cl_io *ccc_env_thread_io(const struct lu_env *env)
+{
+        struct cl_io *io = &ccc_env_info(env)->cti_io;
+        memset(io, 0, sizeof(*io));
+        return io;
+}
+
 struct ccc_session {
         struct ccc_io cs_ios;
 };
@@ -175,7 +205,7 @@ struct ccc_object {
          *
          * \see ccc_page::cpg_pending_linkage
          */
-        struct list_head        cob_pending_list;
+       struct list_head        cob_pending_list;
 
         /**
          * Access this counter is protected by inode->i_sem. Now that
@@ -183,42 +213,44 @@ struct ccc_object {
          * we don't need to hold any lock..
          */
         int                     cob_transient_pages;
-        /**
-         * Number of outstanding mmaps on this file.
-         *
-         * \see ll_vm_open(), ll_vm_close().
-         */
-        atomic_t                cob_mmap_cnt;
+       /**
+        * Number of outstanding mmaps on this file.
+        *
+        * \see ll_vm_open(), ll_vm_close().
+        */
+       atomic_t                cob_mmap_cnt;
+
+       /**
+        * various flags
+        * cob_discard_page_warned
+        *     if pages belonging to this object are discarded when a client
+        * is evicted, some debug info will be printed, this flag will be set
+        * during processing the first discarded page, then avoid flooding
+        * debug message for lots of discarded pages.
+        *
+        * \see ll_dirty_page_discard_warn.
+        */
+       unsigned int            cob_discard_page_warned:1;
 };
 
 /**
  * ccc-private page state.
  */
 struct ccc_page {
-        struct cl_page_slice cpg_cl;
-        int                  cpg_defer_uptodate;
-        int                  cpg_ra_used;
-        int                  cpg_write_queued;
-        /**
-         * Non-empty iff this page is already counted in
-         * ccc_object::cob_pending_list. Protected by
-         * ccc_object::cob_pending_guard. This list is only used as a flag,
-         * that is, never iterated through, only checked for list_empty(), but
-         * having a list is useful for debugging.
-         */
-        struct list_head     cpg_pending_linkage;
-        /** VM page */
-        cfs_page_t          *cpg_page;
-        struct cl_sync_io   *cpg_sync_io;
-        /**
-         * checksum for paranoid I/O debugging enabled by
-         * ENABLE_LLITE_CHECKSUM configuration option.
-         *
-         * XXX This cannot be implemented reliably because checksum cannot be
-         * updated from ->set_page_dirty() that is called without page VM
-         * lock.
-         */
-        __u32                cpg_checksum;
+       struct cl_page_slice cpg_cl;
+       unsigned        cpg_defer_uptodate:1,
+                       cpg_ra_used:1,
+                       cpg_write_queued:1;
+       /**
+        * Non-empty iff this page is already counted in
+        * ccc_object::cob_pending_list. Protected by
+        * ccc_object::cob_pending_guard. This list is only used as a flag,
+        * that is, never iterated through, only checked for list_empty(), but
+        * having a list is useful for debugging.
+        */
+       struct list_head cpg_pending_linkage;
+       /** VM page */
+       struct page     *cpg_page;
 };
 
 static inline struct ccc_page *cl2ccc_page(const struct cl_page_slice *slice)
@@ -226,7 +258,12 @@ static inline struct ccc_page *cl2ccc_page(const struct cl_page_slice *slice)
         return container_of(slice, struct ccc_page, cpg_cl);
 }
 
-struct cl_page    *ccc_vmpage_page_transient(cfs_page_t *vmpage);
+static inline pgoff_t ccc_index(struct ccc_page *ccc)
+{
+       return ccc->cpg_cl.cpl_index;
+}
+
+struct cl_page    *ccc_vmpage_page_transient(struct page *vmpage);
 
 struct ccc_device {
         struct cl_device    cdv_cl;
@@ -288,15 +325,11 @@ int ccc_object_glimpse(const struct lu_env *env,
                        const struct cl_object *obj, struct ost_lvb *lvb);
 int ccc_conf_set(const struct lu_env *env, struct cl_object *obj,
                  const struct cl_object_conf *conf);
-cfs_page_t *ccc_page_vmpage(const struct lu_env *env,
-                            const struct cl_page_slice *slice);
-int ccc_page_is_under_lock(const struct lu_env *env,
-                           const struct cl_page_slice *slice, struct cl_io *io);
 int ccc_fail(const struct lu_env *env, const struct cl_page_slice *slice);
 void ccc_transient_page_verify(const struct cl_page *page);
-void ccc_transient_page_own(const struct lu_env *env,
+int  ccc_transient_page_own(const struct lu_env *env,
                             const struct cl_page_slice *slice,
-                            struct cl_io *io);
+                            struct cl_io *io, int nonblock);
 void ccc_transient_page_assume(const struct lu_env *env,
                                const struct cl_page_slice *slice,
                                struct cl_io *io);
@@ -317,6 +350,7 @@ void ccc_lock_delete(const struct lu_env *env,
 void ccc_lock_fini(const struct lu_env *env,struct cl_lock_slice *slice);
 int ccc_lock_enqueue(const struct lu_env *env,const struct cl_lock_slice *slice,
                      struct cl_io *io, __u32 enqflags);
+int ccc_lock_use(const struct lu_env *env,const struct cl_lock_slice *slice);
 int ccc_lock_unuse(const struct lu_env *env,const struct cl_lock_slice *slice);
 int ccc_lock_wait(const struct lu_env *env,const struct cl_lock_slice *slice);
 int ccc_lock_fits_into(const struct lu_env *env,
@@ -340,8 +374,7 @@ void ccc_io_advance(const struct lu_env *env, const struct cl_io_slice *ios,
 void ccc_io_update_iov(const struct lu_env *env, struct ccc_io *cio,
                        struct cl_io *io);
 int ccc_prep_size(const struct lu_env *env, struct cl_object *obj,
-                  struct cl_io *io, loff_t start, size_t count, int vfslock,
-                  int *exceed);
+                  struct cl_io *io, loff_t start, size_t count, int *exceed);
 void ccc_req_completion(const struct lu_env *env,
                         const struct cl_req_slice *slice, int ioret);
 void ccc_req_attr_set(const struct lu_env *env,const struct cl_req_slice *slice,
@@ -358,23 +391,24 @@ struct ccc_lock    *cl2ccc_lock     (const struct cl_lock_slice *slice);
 struct ccc_io      *cl2ccc_io       (const struct lu_env *env,
                                      const struct cl_io_slice *slice);
 struct ccc_req     *cl2ccc_req      (const struct cl_req_slice *slice);
-cfs_page_t         *cl2vm_page      (const struct cl_page_slice *slice);
+struct page         *cl2vm_page      (const struct cl_page_slice *slice);
 struct inode       *ccc_object_inode(const struct cl_object *obj);
 struct ccc_object  *cl_inode2ccc    (struct inode *inode);
 
-int cl_setattr_do_truncate(struct inode *inode, loff_t size,
-                           struct obd_capa *capa);
-int cl_setattr_ost(struct inode *inode, struct obd_capa *capa);
+int cl_setattr_ost(struct inode *inode, const struct iattr *attr,
+                   struct obd_capa *capa);
 
-struct cl_page *ccc_vmpage_page_transient(cfs_page_t *vmpage);
+struct cl_page *ccc_vmpage_page_transient(struct page *vmpage);
 int ccc_object_invariant(const struct cl_object *obj);
-int cl_inode_init(struct inode *inode, struct lustre_md *md);
+int cl_file_inode_init(struct inode *inode, struct lustre_md *md);
 void cl_inode_fini(struct inode *inode);
 int cl_local_size(struct inode *inode);
 
 __u16 ll_dirent_type_get(struct lu_dirent *ent);
+__u64 cl_fid_build_ino(const struct lu_fid *fid, int api32);
+__u32 cl_fid_build_gen(const struct lu_fid *fid);
 
-#ifdef INVARIANT_CHECK
+#ifdef CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK
 # define CLOBINVRNT(env, clob, expr)                                    \
   do {                                                                  \
           if (unlikely(!(expr))) {                                      \
@@ -382,18 +416,19 @@ __u16 ll_dirent_type_get(struct lu_dirent *ent);
                   LINVRNT(0);                                           \
           }                                                             \
   } while (0)
-#else /* !INVARIANT_CHECK */
+#else /* !CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
 # define CLOBINVRNT(env, clob, expr)                                    \
-        ((void)sizeof(env), (void)sizeof(clob), (void)sizeof !!(expr))
-#endif /* !INVARIANT_CHECK */
+        ((void)sizeof(env), (void)sizeof(clob), (void)sizeof !!(expr))
+#endif /* !CONFIG_LUSTRE_DEBUG_EXPENSIVE_CHECK */
 
 int cl_init_ea_size(struct obd_export *md_exp, struct obd_export *dt_exp);
 int cl_ocd_update(struct obd_device *host,
                   struct obd_device *watched,
-                  enum obd_notify_event ev, void *owner);
+                  enum obd_notify_event ev, void *owner, void *data);
 
 struct ccc_grouplock {
         struct lu_env   *cg_env;
+        struct cl_io    *cg_io;
         struct cl_lock  *cg_lock;
         unsigned long    cg_gid;
 };
@@ -402,4 +437,80 @@ int  cl_get_grouplock(struct cl_object *obj, unsigned long gid, int nonblock,
                       struct ccc_grouplock *cg);
 void cl_put_grouplock(struct ccc_grouplock *cg);
 
+/**
+ * New interfaces to get and put lov_stripe_md from lov layer. This violates
+ * layering because lov_stripe_md is supposed to be a private data in lov.
+ *
+ * NB: If you find you have to use these interfaces for your new code, please
+ * think about it again. These interfaces may be removed in the future for
+ * better layering. */
+struct lov_stripe_md *lov_lsm_get(struct cl_object *clobj);
+void lov_lsm_put(struct cl_object *clobj, struct lov_stripe_md *lsm);
+int lov_read_and_clear_async_rc(struct cl_object *clob);
+
+struct lov_stripe_md *ccc_inode_lsm_get(struct inode *inode);
+void ccc_inode_lsm_put(struct inode *inode, struct lov_stripe_md *lsm);
+
+/**
+ * Data structure managing a client's cached pages. A count of
+ * "unstable" pages is maintained, and an LRU of clean pages is
+ * maintained. "unstable" pages are pages pinned by the ptlrpc
+ * layer for recovery purposes.
+ */
+struct cl_client_cache {
+       /**
+        * # of users (OSCs)
+        */
+       atomic_t                ccc_users;
+       /**
+        * # of LRU entries available
+        */
+       atomic_t                ccc_lru_left;
+       /**
+        * List of entities(OSCs) for this LRU cache
+        */
+       struct list_head        ccc_lru;
+       /**
+        * Max # of LRU entries
+        */
+       unsigned long           ccc_lru_max;
+       /**
+        * Lock to protect ccc_lru list
+        */
+       spinlock_t              ccc_lru_lock;
+       /**
+        * # of threads are doing shrinking
+        */
+       unsigned int            ccc_lru_shrinkers;
+       /**
+        * Set if unstable check is enabled
+        */
+       unsigned int            ccc_unstable_check:1;
+       /**
+        * Waitq for awaiting unstable pages to reach zero.
+        * Used at umounting time and signaled on BRW commit
+        */
+       wait_queue_head_t       ccc_unstable_waitq;
+       /**
+        * # of unstable pages for this mount point
+        */
+       atomic_t                ccc_unstable_nr;
+};
+
+enum {
+       LUSTRE_OPC_MKDIR    = 0,
+       LUSTRE_OPC_SYMLINK  = 1,
+       LUSTRE_OPC_MKNOD    = 2,
+       LUSTRE_OPC_CREATE   = 3,
+       LUSTRE_OPC_ANY      = 5
+};
+
+enum op_cli_flags {
+       CLI_SET_MEA     = 1 << 0,
+       CLI_RM_ENTRY    = 1 << 1,
+       CLI_HASH64      = 1 << 2,
+       CLI_API32       = 1 << 3,
+       CLI_MIGRATE     = 1 << 4,
+};
+
 #endif /*LCLIENT_H */