Whamcloud - gitweb
LU-5683 clio: add CIT_DATA_VERSION
[fs/lustre-release.git] / lustre / osc / osc_internal.h
index 68a2d35..e13eadf 100644 (file)
-/* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
- * vim:expandtab:shiftwidth=8:tabstop=8:
+/*
+ * GPL HEADER START
  *
- * Copyright (C) 2003 Cluster File Systems, Inc.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
- * This code is issued under the GNU General Public License.
- * See the file COPYING in this distribution
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 only,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License version 2 for more details (a copy is included
+ * in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License
+ * version 2 along with this program; If not, see
+ * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
+ *
+ * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
+ * CA 95054 USA or visit www.sun.com if you need additional information or
+ * have any questions.
+ *
+ * GPL HEADER END
+ */
+/*
+ * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
+ * Use is subject to license terms.
+ *
+ * Copyright (c) 2011, 2014, Intel Corporation.
+ */
+/*
+ * This file is part of Lustre, http://www.lustre.org/
+ * Lustre is a trademark of Sun Microsystems, Inc.
  */
 
 #ifndef OSC_INTERNAL_H
 #define OSC_INTERNAL_H
 
-#include <portals/lib-types.h> /* for PTL_MTU and PTL_MD_MAX_PAGES */
-
+#define OAP_MAGIC 8675309
 
-/* bug 1578: negotiate BRW_MAX_SIZE with the OST, instead of hard-coding it */
-#define OSC_BRW_MAX_SIZE PTL_MTU
-#define OSC_BRW_MAX_IOV PTL_MD_MAX_PAGES
+struct lu_env;
 
-#define OAP_MAGIC 8675309
+enum async_flags {
+        ASYNC_READY = 0x1, /* ap_make_ready will not be called before this
+                              page is added to an rpc */
+        ASYNC_URGENT = 0x2, /* page must be put into an RPC before return */
+        ASYNC_COUNT_STABLE = 0x4, /* ap_refresh_count will not be called
+                                     to give the caller a chance to update
+                                     or cancel the size of the io */
+        ASYNC_HP = 0x10,
+};
 
 struct osc_async_page {
         int                     oap_magic;
-        struct list_head        oap_pending_item;
-        struct list_head        oap_urgent_item;
-        struct list_head        oap_rpc_item;
-        struct page             *oap_page;
-        int                     oap_cmd;
-
-        obd_off                 oap_obj_off;
-        obd_off                 oap_page_off;
-        int                     oap_count;
-        obd_flag                oap_brw_flags;
+        unsigned short          oap_cmd;
+        unsigned short          oap_interrupted:1;
+
+       struct list_head        oap_pending_item;
+       struct list_head        oap_rpc_item;
+
+       loff_t                  oap_obj_off;
+        unsigned                oap_page_off;
         enum async_flags        oap_async_flags;
 
-        unsigned long           oap_interrupted:1;
-        struct obd_sync_io_container *oap_osic;
-        struct osic_callback_context oap_occ;
+        struct brw_page         oap_brw_page;
+
         struct ptlrpc_request   *oap_request;
         struct client_obd       *oap_cli;
-        struct lov_oinfo        *oap_loi;
+       struct osc_object       *oap_obj;
 
-       struct obd_async_page_ops *oap_caller_ops;
-        void                   *oap_caller_data;
+       spinlock_t               oap_lock;
 };
 
+#define oap_page        oap_brw_page.pg
+#define oap_count       oap_brw_page.count
+#define oap_brw_flags   oap_brw_page.flag
+
+static inline struct osc_async_page *brw_page2oap(struct brw_page *pga)
+{
+       return (struct osc_async_page *)container_of(pga, struct osc_async_page,
+                                                    oap_brw_page);
+}
+
 struct osc_cache_waiter {
-        struct list_head        ocw_entry;
-        wait_queue_head_t       ocw_waitq;
-        struct osc_async_page   *ocw_oap;
-        int                     ocw_rc;
+       struct list_head        ocw_entry;
+       wait_queue_head_t       ocw_waitq;
+       struct osc_async_page  *ocw_oap;
+       int                     ocw_grant;
+       int                     ocw_rc;
 };
 
-#define OSCC_FLAG_RECOVERING 1
-#define OSCC_FLAG_CREATING   2
-#define OSCC_FLAG_NOSPC      4 /* can't create more objects on this OST */
-
-int osc_create(struct obd_export *exp, struct obdo *oa,
-              struct lov_stripe_md **ea, struct obd_trans_info *oti);
-int osc_real_create(struct obd_export *exp, struct obdo *oa,
-              struct lov_stripe_md **ea, struct obd_trans_info *oti);
-void oscc_init(struct obd_export *exp);
 void osc_wake_cache_waiters(struct client_obd *cli);
+int osc_shrink_grant_to_target(struct client_obd *cli, __u64 target_bytes);
+void osc_update_next_shrink(struct client_obd *cli);
+
+/*
+ * cl integration.
+ */
+#include <cl_object.h>
+
+extern struct ptlrpc_request_set *PTLRPCD_SET;
+
+typedef int (*osc_enqueue_upcall_f)(void *cookie, struct lustre_handle *lockh,
+                                   int rc);
+
+int osc_enqueue_base(struct obd_export *exp, struct ldlm_res_id *res_id,
+                    __u64 *flags, ldlm_policy_data_t *policy,
+                    struct ost_lvb *lvb, int kms_valid,
+                    osc_enqueue_upcall_f upcall,
+                    void *cookie, struct ldlm_enqueue_info *einfo,
+                    struct ptlrpc_request_set *rqset, int async, int agl);
 
-#ifdef __KERNEL__
+int osc_match_base(struct obd_export *exp, struct ldlm_res_id *res_id,
+                  __u32 type, ldlm_policy_data_t *policy, __u32 mode,
+                  __u64 *flags, void *data, struct lustre_handle *lockh,
+                  int unref);
+
+int osc_setattr_async(struct obd_export *exp, struct obd_info *oinfo,
+                     obd_enqueue_update_f upcall, void *cookie,
+                     struct ptlrpc_request_set *rqset);
+int osc_punch_base(struct obd_export *exp, struct obd_info *oinfo,
+                   obd_enqueue_update_f upcall, void *cookie,
+                   struct ptlrpc_request_set *rqset);
+int osc_sync_base(struct obd_export *exp, struct obd_info *oinfo,
+                 obd_enqueue_update_f upcall, void *cookie,
+                 struct ptlrpc_request_set *rqset);
+
+int osc_process_config_base(struct obd_device *obd, struct lustre_cfg *cfg);
+int osc_build_rpc(const struct lu_env *env, struct client_obd *cli,
+                 struct list_head *ext_list, int cmd, pdl_policy_t p);
+long osc_lru_shrink(const struct lu_env *env, struct client_obd *cli,
+                  long target, bool force);
+long osc_lru_reclaim(struct client_obd *cli);
+
+extern spinlock_t osc_ast_guard;
+extern struct lu_kmem_descr osc_caches[];
+extern struct lock_class_key osc_ast_guard_class;
+
+unsigned long osc_ldlm_weigh_ast(struct ldlm_lock *dlmlock);
+
+int osc_cleanup(struct obd_device *obd);
+int osc_setup(struct obd_device *obd, struct lustre_cfg *lcfg);
+
+#ifdef CONFIG_PROC_FS
+extern struct lprocfs_vars lprocfs_osc_obd_vars[];
 int lproc_osc_attach_seqstat(struct obd_device *dev);
 #else
 static inline int lproc_osc_attach_seqstat(struct obd_device *dev) {return 0;}
 #endif
 
+extern struct lu_device_type osc_device_type;
+
+static inline int osc_recoverable_error(int rc)
+{
+        return (rc == -EIO || rc == -EROFS || rc == -ENOMEM ||
+                rc == -EAGAIN || rc == -EINPROGRESS);
+}
+
+static inline unsigned long rpcs_in_flight(struct client_obd *cli)
+{
+       return cli->cl_r_in_flight + cli->cl_w_in_flight;
+}
+
+#ifndef min_t
+#define min_t(type,x,y) \
+        ({ type __x = (x); type __y = (y); __x < __y ? __x: __y; })
+#endif
+
+struct osc_device {
+        struct cl_device    od_cl;
+        struct obd_export  *od_exp;
+
+        /* Write stats is actually protected by client_obd's lock. */
+        struct osc_stats {
+                uint64_t     os_lockless_writes;          /* by bytes */
+                uint64_t     os_lockless_reads;           /* by bytes */
+                uint64_t     os_lockless_truncates;       /* by times */
+        } od_stats;
+
+        /* configuration item(s) */
+        int                 od_contention_time;
+        int                 od_lockless_truncate;
+};
+
+static inline struct osc_device *obd2osc_dev(const struct obd_device *d)
+{
+        return container_of0(d->obd_lu_dev, struct osc_device, od_cl.cd_lu_dev);
+}
+
+extern struct kmem_cache *osc_quota_kmem;
+struct osc_quota_info {
+       /** linkage for quota hash table */
+       struct hlist_node oqi_hash;
+       u32               oqi_id;
+};
+
+struct osc_async_args {
+       struct obd_info *aa_oi;
+};
+
+int osc_quota_setup(struct obd_device *obd);
+int osc_quota_cleanup(struct obd_device *obd);
+int osc_quota_setdq(struct client_obd *cli, const unsigned int qid[],
+                   u64 valid, u32 flags);
+int osc_quota_chkdq(struct client_obd *cli, const unsigned int qid[]);
+int osc_quotactl(struct obd_device *unused, struct obd_export *exp,
+                 struct obd_quotactl *oqctl);
+void osc_inc_unstable_pages(struct ptlrpc_request *req);
+void osc_dec_unstable_pages(struct ptlrpc_request *req);
+bool osc_over_unstable_soft_limit(struct client_obd *cli);
+/**
+ * Bit flags for osc_dlm_lock_at_pageoff().
+ */
+enum osc_dap_flags {
+       /**
+        * Just check if the desired lock exists, it won't hold reference
+        * count on lock.
+        */
+       OSC_DAP_FL_TEST_LOCK = 1 << 0,
+       /**
+        * Return the lock even if it is being canceled.
+        */
+       OSC_DAP_FL_CANCELING = 1 << 1
+};
+struct ldlm_lock *osc_dlmlock_at_pgoff(const struct lu_env *env,
+                                      struct osc_object *obj, pgoff_t index,
+                                      enum osc_dap_flags flags);
+void osc_pack_req_body(struct ptlrpc_request *req, struct obd_info *oinfo);
+void osc_set_capa_size(struct ptlrpc_request *req,
+                      const struct req_msg_field *field, struct obd_capa *oc);
 #endif /* OSC_INTERNAL_H */