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_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 extern struct ptlrpc_request_set *PTLRPCD_SET;
  56
  57 int osc_enqueue_base(struct obd_export *exp, struct ldlm_res_id *res_id,
  58                      __u64 *flags, union ldlm_policy_data *policy,
  59                      struct ost_lvb *lvb, int kms_valid,
  60                      osc_enqueue_upcall_f upcall,
  61                      void *cookie, struct ldlm_enqueue_info *einfo,
  62                      struct ptlrpc_request_set *rqset, int async,
  63                      bool speculative);
  64
  65 int osc_match_base(struct obd_export *exp, struct ldlm_res_id *res_id,
  66                    enum ldlm_type type, union ldlm_policy_data *policy,
  67                    enum ldlm_mode mode, __u64 *flags, void *data,
  68                    struct lustre_handle *lockh, int unref);
  69
  70 int osc_setattr_async(struct obd_export *exp, struct obdo *oa,
  71                       obd_enqueue_update_f upcall, void *cookie,
  72                       struct ptlrpc_request_set *rqset);
  73 int osc_sync_base(struct osc_object *obj, struct obdo *oa,
  74                   obd_enqueue_update_f upcall, void *cookie,
  75                   struct ptlrpc_request_set *rqset);
  76 int osc_ladvise_base(struct obd_export *exp, struct obdo *oa,
  77                      struct ladvise_hdr *ladvise_hdr,
  78                      obd_enqueue_update_f upcall, void *cookie,
  79                      struct ptlrpc_request_set *rqset);
  80 int osc_process_config_base(struct obd_device *obd, struct lustre_cfg *cfg);
  81 int osc_build_rpc(const struct lu_env *env, struct client_obd *cli,
  82                   struct list_head *ext_list, int cmd);
  83 unsigned long osc_lru_reserve(struct client_obd *cli, unsigned long npages);
  84 void osc_lru_unreserve(struct client_obd *cli, unsigned long npages);
  85
  86 extern struct lu_kmem_descr osc_caches[];
  87
  88 unsigned long osc_ldlm_weigh_ast(struct ldlm_lock *dlmlock);
  89
  90 int osc_cleanup(struct obd_device *obd);
  91 int osc_setup(struct obd_device *obd, struct lustre_cfg *lcfg);
  92
  93 #ifdef CONFIG_PROC_FS
  94 extern struct lprocfs_vars lprocfs_osc_obd_vars[];
  95 int lproc_osc_attach_seqstat(struct obd_device *dev);
  96 #else
  97 static inline int lproc_osc_attach_seqstat(struct obd_device *dev) {return 0;}
  98 #endif
  99
 100 extern struct lu_device_type osc_device_type;
 101
 102 static inline struct cl_io *osc_env_thread_io(const struct lu_env *env)
 103 {
 104         struct cl_io *io = &osc_env_info(env)->oti_io;
 105
 106         memset(io, 0, sizeof(*io));
 107         return io;
 108 }
 109
 110 static inline int osc_is_object(const struct lu_object *obj)
 111 {
 112         return obj->lo_dev->ld_type == &osc_device_type;
 113 }
 114
 115 static inline struct osc_lock *osc_lock_at(const struct cl_lock *lock)
 116 {
 117         return cl2osc_lock(cl_lock_at(lock, &osc_device_type));
 118 }
 119
 120 int osc_lock_init(const struct lu_env *env, struct cl_object *obj,
 121                   struct cl_lock *lock, const struct cl_io *io);
 122 int osc_io_init(const struct lu_env *env, struct cl_object *obj,
 123                 struct cl_io *io);
 124 struct lu_object *osc_object_alloc(const struct lu_env *env,
 125                                    const struct lu_object_header *hdr,
 126                                    struct lu_device *dev);
 127
 128 static inline int osc_recoverable_error(int rc)
 129 {
 130         return (rc == -EIO || rc == -EROFS || rc == -ENOMEM ||
 131                 rc == -EAGAIN || rc == -EINPROGRESS);
 132 }
 133
 134 static inline unsigned long rpcs_in_flight(struct client_obd *cli)
 135 {
 136         return cli->cl_r_in_flight + cli->cl_w_in_flight;
 137 }
 138
 139 static inline char *cli_name(struct client_obd *cli)
 140 {
 141         return cli->cl_import->imp_obd->obd_name;
 142 }
 143
 144 #ifndef min_t
 145 #define min_t(type,x,y) \
 146         ({ type __x = (x); type __y = (y); __x < __y ? __x: __y; })
 147 #endif
 148
 149 struct osc_async_args {
 150         struct obd_info *aa_oi;
 151 };
 152
 153 int osc_quota_setup(struct obd_device *obd);
 154 int osc_quota_cleanup(struct obd_device *obd);
 155 int osc_quota_setdq(struct client_obd *cli, const unsigned int qid[],
 156                     u64 valid, u32 flags);
 157 int osc_quota_chkdq(struct client_obd *cli, const unsigned int qid[]);
 158 int osc_quotactl(struct obd_device *unused, struct obd_export *exp,
 159                  struct obd_quotactl *oqctl);
 160 void osc_inc_unstable_pages(struct ptlrpc_request *req);
 161 void osc_dec_unstable_pages(struct ptlrpc_request *req);
 162 bool osc_over_unstable_soft_limit(struct client_obd *cli);
 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
 180 static inline void osc_set_io_portal(struct ptlrpc_request *req)
 181 {
 182         struct obd_import *imp = req->rq_import;
 183
 184         /* Distinguish OSC from MDC here to use OST or MDS portal */
 185         if (OCD_HAS_FLAG(&imp->imp_connect_data, IBITS))
 186                 req->rq_request_portal = MDS_IO_PORTAL;
 187         else
 188                 req->rq_request_portal = OST_IO_PORTAL;
 189 }
 190 #endif /* OSC_INTERNAL_H */