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