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, 2017, 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 <libcfs/linux/linux-mem.h>
  39 #include <lustre_osc.h>
  40
  41 extern atomic_t osc_pool_req_count;
  42 extern unsigned int osc_reqpool_maxreqcount;
  43 extern struct ptlrpc_request_pool *osc_rq_pool;
  44
  45 void osc_wake_cache_waiters(struct client_obd *cli);
  46 int osc_shrink_grant_to_target(struct client_obd *cli, __u64 target_bytes);
  47 void osc_schedule_grant_work(void);
  48 void osc_update_next_shrink(struct client_obd *cli);
  49 int lru_queue_work(const struct lu_env *env, void *data);
  50 int osc_extent_finish(const struct lu_env *env, struct osc_extent *ext,
  51                       int sent, int rc);
  52 int osc_extent_release(const struct lu_env *env, struct osc_extent *ext);
  53 int osc_lock_discard_pages(const struct lu_env *env, struct osc_object *osc,
  54                            pgoff_t start, pgoff_t end, bool discard);
  55
  56 void osc_lock_lvb_update(const struct lu_env *env,
  57                          struct osc_object *osc,
  58                          struct ldlm_lock *dlmlock,
  59                          struct ost_lvb *lvb);
  60
  61 int osc_enqueue_base(struct obd_export *exp, struct ldlm_res_id *res_id,
  62                      __u64 *flags, union ldlm_policy_data *policy,
  63                      struct ost_lvb *lvb, osc_enqueue_upcall_f upcall,
  64                      void *cookie, struct ldlm_enqueue_info *einfo,
  65                      struct ptlrpc_request_set *rqset, int async,
  66                      bool speculative);
  67
  68 int osc_match_base(const struct lu_env *env, struct obd_export *exp,
  69                    struct ldlm_res_id *res_id, enum ldlm_type type,
  70                    union ldlm_policy_data *policy, enum ldlm_mode mode,
  71                    __u64 *flags, struct osc_object *obj,
  72                    struct lustre_handle *lockh, int unref);
  73
  74 int osc_setattr_async(struct obd_export *exp, struct obdo *oa,
  75                       obd_enqueue_update_f upcall, void *cookie,
  76                       struct ptlrpc_request_set *rqset);
  77 int osc_sync_base(struct osc_object *obj, struct obdo *oa,
  78                   obd_enqueue_update_f upcall, void *cookie,
  79                   struct ptlrpc_request_set *rqset);
  80 int osc_ladvise_base(struct obd_export *exp, struct obdo *oa,
  81                      struct ladvise_hdr *ladvise_hdr,
  82                      obd_enqueue_update_f upcall, void *cookie,
  83                      struct ptlrpc_request_set *rqset);
  84 int osc_process_config_base(struct obd_device *obd, struct lustre_cfg *cfg);
  85 int osc_build_rpc(const struct lu_env *env, struct client_obd *cli,
  86                   struct list_head *ext_list, int cmd);
  87 unsigned long osc_lru_reserve(struct client_obd *cli, unsigned long npages);
  88 void osc_lru_unreserve(struct client_obd *cli, unsigned long npages);
  89
  90 extern struct lu_kmem_descr osc_caches[];
  91
  92 unsigned long osc_ldlm_weigh_ast(struct ldlm_lock *dlmlock);
  93
  94 int osc_cleanup(struct obd_device *obd);
  95 int osc_setup(struct obd_device *obd, struct lustre_cfg *lcfg);
  96
  97 int osc_tunables_init(struct obd_device *obd);
  98
  99 extern struct lu_device_type osc_device_type;
 100
 101 static inline struct cl_io *osc_env_thread_io(const struct lu_env *env)
 102 {
 103         struct cl_io *io = &osc_env_info(env)->oti_io;
 104
 105         memset(io, 0, sizeof(*io));
 106         return io;
 107 }
 108
 109 static inline int osc_is_object(const struct lu_object *obj)
 110 {
 111         return obj->lo_dev->ld_type == &osc_device_type;
 112 }
 113
 114 static inline struct osc_lock *osc_lock_at(const struct cl_lock *lock)
 115 {
 116         return cl2osc_lock(cl_lock_at(lock, &osc_device_type));
 117 }
 118
 119 int osc_lock_init(const struct lu_env *env, struct cl_object *obj,
 120                   struct cl_lock *lock, const struct cl_io *io);
 121 int osc_io_init(const struct lu_env *env, struct cl_object *obj,
 122                 struct cl_io *io);
 123 struct lu_object *osc_object_alloc(const struct lu_env *env,
 124                                    const struct lu_object_header *hdr,
 125                                    struct lu_device *dev);
 126
 127 static inline int osc_recoverable_error(int rc)
 128 {
 129         return (rc == -EIO || rc == -EROFS || rc == -ENOMEM ||
 130                 rc == -EAGAIN || rc == -EINPROGRESS);
 131 }
 132
 133 static inline unsigned long rpcs_in_flight(struct client_obd *cli)
 134 {
 135         return cli->cl_r_in_flight + cli->cl_w_in_flight;
 136 }
 137
 138 static inline char *cli_name(struct client_obd *cli)
 139 {
 140         return cli->cl_import->imp_obd->obd_name;
 141 }
 142
 143 static inline char list_empty_marker(struct list_head *list)
 144 {
 145         return list_empty(list) ? '-' : '+';
 146 }
 147
 148 struct osc_async_args {
 149         struct obd_info *aa_oi;
 150 };
 151
 152 int osc_quota_setup(struct obd_device *obd);
 153 int osc_quota_cleanup(struct obd_device *obd);
 154 int osc_quota_setdq(struct client_obd *cli, __u64 xid, const unsigned int qid[],
 155                     u64 valid, u32 flags);
 156 int osc_quota_chkdq(struct client_obd *cli, const unsigned int qid[]);
 157 int osc_quotactl(struct obd_device *unused, struct obd_export *exp,
 158                  struct obd_quotactl *oqctl);
 159 void osc_inc_unstable_pages(struct ptlrpc_request *req);
 160 void osc_dec_unstable_pages(struct ptlrpc_request *req);
 161 bool osc_over_unstable_soft_limit(struct client_obd *cli);
 162 void osc_page_touch_at(const struct lu_env *env, struct cl_object *obj,
 163                        pgoff_t idx, size_t to);
 164
 165 struct ldlm_lock *osc_obj_dlmlock_at_pgoff(const struct lu_env *env,
 166                                            struct osc_object *obj,
 167                                            pgoff_t index,
 168                                            enum osc_dap_flags flags);
 169
 170 int osc_object_invalidate(const struct lu_env *env, struct osc_object *osc);
 171
 172 /** osc shrink list to link all osc client obd */
 173 extern struct list_head osc_shrink_list;
 174 /** spin lock to protect osc_shrink_list */
 175 extern spinlock_t osc_shrink_lock;
 176 extern unsigned long osc_cache_shrink_count(struct shrinker *sk,
 177                                             struct shrink_control *sc);
 178 extern unsigned long osc_cache_shrink_scan(struct shrinker *sk,
 179                                            struct shrink_control *sc);
 180 static inline unsigned int osc_max_write_chunks(const struct client_obd *cli)
 181 {
 182         /*
 183          * LU-8135:
 184          *
 185          * The maximum size of a single transaction is about 64MB in ZFS.
 186          * #define DMU_MAX_ACCESS (64 * 1024 * 1024)
 187          *
 188          * Since ZFS is a copy-on-write file system, a single dirty page in
 189          * a chunk will result in the rewrite of the whole chunk, therefore
 190          * an RPC shouldn't be allowed to contain too many chunks otherwise
 191          * it will make transaction size much bigger than 64MB, especially
 192          * with big block size for ZFS.
 193          *
 194          * This piece of code is to make sure that OSC won't send write RPCs
 195          * with too many chunks. The maximum chunk size that an RPC can cover
 196          * is set to PTLRPC_MAX_BRW_SIZE, which is defined to 16MB. Ideally
 197          * OST should tell the client what the biggest transaction size is,
 198          * but it's good enough for now.
 199          *
 200          * This limitation doesn't apply to ldiskfs, which allows as many
 201          * chunks in one RPC as we want. However, it won't have any benefits
 202          * to have too many discontiguous pages in one RPC.
 203          *
 204          * An osc_extent won't cover over a RPC size, so the chunks in an
 205          * osc_extent won't bigger than PTLRPC_MAX_BRW_SIZE >> chunkbits.
 206          */
 207         return PTLRPC_MAX_BRW_SIZE >> cli->cl_chunkbits;
 208 }
 209
 210 static inline void osc_set_io_portal(struct ptlrpc_request *req)
 211 {
 212         struct obd_import *imp = req->rq_import;
 213
 214         /* Distinguish OSC from MDC here to use OST or MDS portal */
 215         if (OCD_HAS_FLAG(&imp->imp_connect_data, IBITS))
 216                 req->rq_request_portal = MDS_IO_PORTAL;
 217         else
 218                 req->rq_request_portal = OST_IO_PORTAL;
 219 }
 220 #endif /* OSC_INTERNAL_H */