lustre/osc/osc_internal.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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2011, 2016, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  */
  32
  33 #ifndef OSC_INTERNAL_H
  34 #define OSC_INTERNAL_H
  35
  36 #define OAP_MAGIC 8675309
  37
  38 #include <lustre_osc.h>
  39
  40 extern atomic_t osc_pool_req_count;
  41 extern unsigned int osc_reqpool_maxreqcount;
  42 extern struct ptlrpc_request_pool *osc_rq_pool;
  43
  44 void osc_wake_cache_waiters(struct client_obd *cli);
  45 int osc_shrink_grant_to_target(struct client_obd *cli, __u64 target_bytes);
  46 void osc_update_next_shrink(struct client_obd *cli);
  47
  48 extern struct ptlrpc_request_set *PTLRPCD_SET;
  49
  50 typedef int (*osc_enqueue_upcall_f)(void *cookie, struct lustre_handle *lockh,
  51                                     int rc);
  52
  53 int osc_enqueue_base(struct obd_export *exp, struct ldlm_res_id *res_id,
  54                      __u64 *flags, union ldlm_policy_data *policy,
  55                      struct ost_lvb *lvb, int kms_valid,
  56                      osc_enqueue_upcall_f upcall,
  57                      void *cookie, struct ldlm_enqueue_info *einfo,
  58                      struct ptlrpc_request_set *rqset, int async,
  59                      bool speculative);
  60
  61 int osc_match_base(struct obd_export *exp, struct ldlm_res_id *res_id,
  62                    enum ldlm_type type, union ldlm_policy_data *policy,
  63                    enum ldlm_mode mode, __u64 *flags, void *data,
  64                    struct lustre_handle *lockh, int unref);
  65
  66 int osc_setattr_async(struct obd_export *exp, struct obdo *oa,
  67                       obd_enqueue_update_f upcall, void *cookie,
  68                       struct ptlrpc_request_set *rqset);
  69 int osc_punch_base(struct obd_export *exp, struct obdo *oa,
  70                    obd_enqueue_update_f upcall, void *cookie,
  71                    struct ptlrpc_request_set *rqset);
  72 int osc_sync_base(struct osc_object *obj, struct obdo *oa,
  73                   obd_enqueue_update_f upcall, void *cookie,
  74                   struct ptlrpc_request_set *rqset);
  75 int osc_ladvise_base(struct obd_export *exp, struct obdo *oa,
  76                      struct ladvise_hdr *ladvise_hdr,
  77                      obd_enqueue_update_f upcall, void *cookie,
  78                      struct ptlrpc_request_set *rqset);
  79 int osc_process_config_base(struct obd_device *obd, struct lustre_cfg *cfg);
  80 int osc_build_rpc(const struct lu_env *env, struct client_obd *cli,
  81                   struct list_head *ext_list, int cmd);
  82 long osc_lru_shrink(const struct lu_env *env, struct client_obd *cli,
  83                    long target, bool force);
  84 unsigned long osc_lru_reserve(struct client_obd *cli, unsigned long npages);
  85 void osc_lru_unreserve(struct client_obd *cli, unsigned long npages);
  86
  87 extern struct lu_kmem_descr osc_caches[];
  88
  89 unsigned long osc_ldlm_weigh_ast(struct ldlm_lock *dlmlock);
  90
  91 int osc_cleanup(struct obd_device *obd);
  92 int osc_setup(struct obd_device *obd, struct lustre_cfg *lcfg);
  93
  94 #ifdef CONFIG_PROC_FS
  95 extern struct lprocfs_vars lprocfs_osc_obd_vars[];
  96 int lproc_osc_attach_seqstat(struct obd_device *dev);
  97 #else
  98 static inline int lproc_osc_attach_seqstat(struct obd_device *dev) {return 0;}
  99 #endif
 100
 101 extern struct lu_device_type osc_device_type;
 102
 103 static inline int osc_is_object(const struct lu_object *obj)
 104 {
 105         return obj->lo_dev->ld_type == &osc_device_type;
 106 }
 107
 108 static inline struct osc_lock *osc_lock_at(const struct cl_lock *lock)
 109 {
 110         return cl2osc_lock(cl_lock_at(lock, &osc_device_type));
 111 }
 112
 113 int osc_lock_init(const struct lu_env *env, struct cl_object *obj,
 114                   struct cl_lock *lock, const struct cl_io *io);
 115 int osc_io_init(const struct lu_env *env, struct cl_object *obj,
 116                 struct cl_io *io);
 117 struct lu_object *osc_object_alloc(const struct lu_env *env,
 118                                    const struct lu_object_header *hdr,
 119                                    struct lu_device *dev);
 120
 121 static inline int osc_recoverable_error(int rc)
 122 {
 123         return (rc == -EIO || rc == -EROFS || rc == -ENOMEM ||
 124                 rc == -EAGAIN || rc == -EINPROGRESS);
 125 }
 126
 127 static inline unsigned long rpcs_in_flight(struct client_obd *cli)
 128 {
 129         return cli->cl_r_in_flight + cli->cl_w_in_flight;
 130 }
 131
 132 static inline char *cli_name(struct client_obd *cli)
 133 {
 134         return cli->cl_import->imp_obd->obd_name;
 135 }
 136
 137 #ifndef min_t
 138 #define min_t(type,x,y) \
 139         ({ type __x = (x); type __y = (y); __x < __y ? __x: __y; })
 140 #endif
 141
 142 struct osc_async_args {
 143         struct obd_info *aa_oi;
 144 };
 145
 146 int osc_quota_setup(struct obd_device *obd);
 147 int osc_quota_cleanup(struct obd_device *obd);
 148 int osc_quota_setdq(struct client_obd *cli, const unsigned int qid[],
 149                     u64 valid, u32 flags);
 150 int osc_quota_chkdq(struct client_obd *cli, const unsigned int qid[]);
 151 int osc_quotactl(struct obd_device *unused, struct obd_export *exp,
 152                  struct obd_quotactl *oqctl);
 153 void osc_inc_unstable_pages(struct ptlrpc_request *req);
 154 void osc_dec_unstable_pages(struct ptlrpc_request *req);
 155 bool osc_over_unstable_soft_limit(struct client_obd *cli);
 156 /**
 157  * Bit flags for osc_dlm_lock_at_pageoff().
 158  */
 159 enum osc_dap_flags {
 160         /**
 161          * Just check if the desired lock exists, it won't hold reference
 162          * count on lock.
 163          */
 164         OSC_DAP_FL_TEST_LOCK = 1 << 0,
 165         /**
 166          * Return the lock even if it is being canceled.
 167          */
 168         OSC_DAP_FL_CANCELING = 1 << 1
 169 };
 170 struct ldlm_lock *osc_dlmlock_at_pgoff(const struct lu_env *env,
 171                                        struct osc_object *obj, pgoff_t index,
 172                                        enum osc_dap_flags flags);
 173 void osc_pack_req_body(struct ptlrpc_request *req, struct obdo *oa);
 174 int osc_object_invalidate(const struct lu_env *env, struct osc_object *osc);
 175
 176 /** osc shrink list to link all osc client obd */
 177 extern struct list_head osc_shrink_list;
 178 /** spin lock to protect osc_shrink_list */
 179 extern spinlock_t osc_shrink_lock;
 180 extern unsigned long osc_cache_shrink_count(struct shrinker *sk,
 181                                             struct shrink_control *sc);
 182 extern unsigned long osc_cache_shrink_scan(struct shrinker *sk,
 183                                            struct shrink_control *sc);
 184
 185 #endif /* OSC_INTERNAL_H */