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 extern atomic_t osc_pool_req_count;
  39 extern unsigned int osc_reqpool_maxreqcount;
  40 extern struct ptlrpc_request_pool *osc_rq_pool;
  41
  42 struct lu_env;
  43
  44 enum async_flags {
  45         ASYNC_READY = 0x1, /* ap_make_ready will not be called before this
  46                               page is added to an rpc */
  47         ASYNC_URGENT = 0x2, /* page must be put into an RPC before return */
  48         ASYNC_COUNT_STABLE = 0x4, /* ap_refresh_count will not be called
  49                                      to give the caller a chance to update
  50                                      or cancel the size of the io */
  51         ASYNC_HP = 0x10,
  52 };
  53
  54 struct osc_async_page {
  55         int                     oap_magic;
  56         unsigned short          oap_cmd;
  57         unsigned short          oap_interrupted:1;
  58
  59         struct list_head        oap_pending_item;
  60         struct list_head        oap_rpc_item;
  61
  62         loff_t                  oap_obj_off;
  63         unsigned                oap_page_off;
  64         enum async_flags        oap_async_flags;
  65
  66         struct brw_page         oap_brw_page;
  67
  68         struct ptlrpc_request   *oap_request;
  69         struct client_obd       *oap_cli;
  70         struct osc_object       *oap_obj;
  71
  72         spinlock_t               oap_lock;
  73 };
  74
  75 #define oap_page        oap_brw_page.pg
  76 #define oap_count       oap_brw_page.count
  77 #define oap_brw_flags   oap_brw_page.flag
  78
  79 static inline struct osc_async_page *brw_page2oap(struct brw_page *pga)
  80 {
  81         return (struct osc_async_page *)container_of(pga, struct osc_async_page,
  82                                                      oap_brw_page);
  83 }
  84
  85 struct osc_cache_waiter {
  86         struct list_head        ocw_entry;
  87         wait_queue_head_t       ocw_waitq;
  88         struct osc_async_page  *ocw_oap;
  89         int                     ocw_grant;
  90         int                     ocw_rc;
  91 };
  92
  93 void osc_wake_cache_waiters(struct client_obd *cli);
  94 int osc_shrink_grant_to_target(struct client_obd *cli, __u64 target_bytes);
  95 void osc_update_next_shrink(struct client_obd *cli);
  96
  97 /*
  98  * cl integration.
  99  */
 100 #include <cl_object.h>
 101
 102 extern struct ptlrpc_request_set *PTLRPCD_SET;
 103
 104 typedef int (*osc_enqueue_upcall_f)(void *cookie, struct lustre_handle *lockh,
 105                                     int rc);
 106
 107 int osc_enqueue_base(struct obd_export *exp, struct ldlm_res_id *res_id,
 108                      __u64 *flags, union ldlm_policy_data *policy,
 109                      struct ost_lvb *lvb, int kms_valid,
 110                      osc_enqueue_upcall_f upcall,
 111                      void *cookie, struct ldlm_enqueue_info *einfo,
 112                      struct ptlrpc_request_set *rqset, int async, int agl);
 113
 114 int osc_match_base(struct obd_export *exp, struct ldlm_res_id *res_id,
 115                    enum ldlm_type type, union ldlm_policy_data *policy,
 116                    enum ldlm_mode mode, __u64 *flags, void *data,
 117                    struct lustre_handle *lockh, int unref);
 118
 119 int osc_setattr_async(struct obd_export *exp, struct obdo *oa,
 120                       obd_enqueue_update_f upcall, void *cookie,
 121                       struct ptlrpc_request_set *rqset);
 122 int osc_punch_base(struct obd_export *exp, struct obdo *oa,
 123                    obd_enqueue_update_f upcall, void *cookie,
 124                    struct ptlrpc_request_set *rqset);
 125 int osc_sync_base(struct osc_object *obj, struct obdo *oa,
 126                   obd_enqueue_update_f upcall, void *cookie,
 127                   struct ptlrpc_request_set *rqset);
 128 int osc_ladvise_base(struct obd_export *exp, struct obdo *oa,
 129                      struct ladvise_hdr *ladvise_hdr,
 130                      obd_enqueue_update_f upcall, void *cookie,
 131                      struct ptlrpc_request_set *rqset);
 132 int osc_process_config_base(struct obd_device *obd, struct lustre_cfg *cfg);
 133 int osc_build_rpc(const struct lu_env *env, struct client_obd *cli,
 134                   struct list_head *ext_list, int cmd);
 135 long osc_lru_shrink(const struct lu_env *env, struct client_obd *cli,
 136                    long target, bool force);
 137 unsigned long osc_lru_reserve(struct client_obd *cli, unsigned long npages);
 138 void osc_lru_unreserve(struct client_obd *cli, unsigned long npages);
 139
 140 extern struct lu_kmem_descr osc_caches[];
 141
 142 unsigned long osc_ldlm_weigh_ast(struct ldlm_lock *dlmlock);
 143
 144 int osc_cleanup(struct obd_device *obd);
 145 int osc_setup(struct obd_device *obd, struct lustre_cfg *lcfg);
 146
 147 #ifdef CONFIG_PROC_FS
 148 extern struct lprocfs_vars lprocfs_osc_obd_vars[];
 149 int lproc_osc_attach_seqstat(struct obd_device *dev);
 150 #else
 151 static inline int lproc_osc_attach_seqstat(struct obd_device *dev) {return 0;}
 152 #endif
 153
 154 extern struct lu_device_type osc_device_type;
 155
 156 static inline int osc_recoverable_error(int rc)
 157 {
 158         return (rc == -EIO || rc == -EROFS || rc == -ENOMEM ||
 159                 rc == -EAGAIN || rc == -EINPROGRESS);
 160 }
 161
 162 static inline unsigned long rpcs_in_flight(struct client_obd *cli)
 163 {
 164         return cli->cl_r_in_flight + cli->cl_w_in_flight;
 165 }
 166
 167 static inline char *cli_name(struct client_obd *cli)
 168 {
 169         return cli->cl_import->imp_obd->obd_name;
 170 }
 171
 172 #ifndef min_t
 173 #define min_t(type,x,y) \
 174         ({ type __x = (x); type __y = (y); __x < __y ? __x: __y; })
 175 #endif
 176
 177 struct osc_device {
 178         struct cl_device    od_cl;
 179         struct obd_export  *od_exp;
 180
 181         /* Write stats is actually protected by client_obd's lock. */
 182         struct osc_stats {
 183                 uint64_t     os_lockless_writes;          /* by bytes */
 184                 uint64_t     os_lockless_reads;           /* by bytes */
 185                 uint64_t     os_lockless_truncates;       /* by times */
 186         } od_stats;
 187
 188         /* configuration item(s) */
 189         int                 od_contention_time;
 190         int                 od_lockless_truncate;
 191 };
 192
 193 static inline struct osc_device *obd2osc_dev(const struct obd_device *d)
 194 {
 195         return container_of0(d->obd_lu_dev, struct osc_device, od_cl.cd_lu_dev);
 196 }
 197
 198 extern struct kmem_cache *osc_quota_kmem;
 199 struct osc_quota_info {
 200         /** linkage for quota hash table */
 201         struct hlist_node oqi_hash;
 202         u32               oqi_id;
 203 };
 204
 205 struct osc_async_args {
 206         struct obd_info *aa_oi;
 207 };
 208
 209 int osc_quota_setup(struct obd_device *obd);
 210 int osc_quota_cleanup(struct obd_device *obd);
 211 int osc_quota_setdq(struct client_obd *cli, const unsigned int qid[],
 212                     u64 valid, u32 flags);
 213 int osc_quota_chkdq(struct client_obd *cli, const unsigned int qid[]);
 214 int osc_quotactl(struct obd_device *unused, struct obd_export *exp,
 215                  struct obd_quotactl *oqctl);
 216 void osc_inc_unstable_pages(struct ptlrpc_request *req);
 217 void osc_dec_unstable_pages(struct ptlrpc_request *req);
 218 bool osc_over_unstable_soft_limit(struct client_obd *cli);
 219 /**
 220  * Bit flags for osc_dlm_lock_at_pageoff().
 221  */
 222 enum osc_dap_flags {
 223         /**
 224          * Just check if the desired lock exists, it won't hold reference
 225          * count on lock.
 226          */
 227         OSC_DAP_FL_TEST_LOCK = 1 << 0,
 228         /**
 229          * Return the lock even if it is being canceled.
 230          */
 231         OSC_DAP_FL_CANCELING = 1 << 1
 232 };
 233 struct ldlm_lock *osc_dlmlock_at_pgoff(const struct lu_env *env,
 234                                        struct osc_object *obj, pgoff_t index,
 235                                        enum osc_dap_flags flags);
 236 void osc_pack_req_body(struct ptlrpc_request *req, struct obdo *oa);
 237 int osc_object_invalidate(const struct lu_env *env, struct osc_object *osc);
 238
 239 /** osc shrink list to link all osc client obd */
 240 extern struct list_head osc_shrink_list;
 241 /** spin lock to protect osc_shrink_list */
 242 extern spinlock_t osc_shrink_lock;
 243 extern unsigned long osc_cache_shrink_count(struct shrinker *sk,
 244                                             struct shrink_control *sc);
 245 extern unsigned long osc_cache_shrink_scan(struct shrinker *sk,
 246                                            struct shrink_control *sc);
 247
 248 #endif /* OSC_INTERNAL_H */