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.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2011, 2014, Intel Corporation.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  */
  36
  37 #ifndef OSC_INTERNAL_H
  38 #define OSC_INTERNAL_H
  39
  40 #define OAP_MAGIC 8675309
  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, ldlm_policy_data_t *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 int osc_cancel_base(struct lustre_handle *lockh, __u32 mode);
 114
 115 int osc_match_base(struct obd_export *exp, struct ldlm_res_id *res_id,
 116                    __u32 type, ldlm_policy_data_t *policy, __u32 mode,
 117                    __u64 *flags, void *data, struct lustre_handle *lockh,
 118                    int unref);
 119
 120 int osc_setattr_async(struct obd_export *exp, struct obd_info *oinfo,
 121                       obd_enqueue_update_f upcall, void *cookie,
 122                       struct ptlrpc_request_set *rqset);
 123 int osc_punch_base(struct obd_export *exp, struct obd_info *oinfo,
 124                    obd_enqueue_update_f upcall, void *cookie,
 125                    struct ptlrpc_request_set *rqset);
 126 int osc_sync_base(struct obd_export *exp, struct obd_info *oinfo,
 127                   obd_enqueue_update_f upcall, void *cookie,
 128                   struct ptlrpc_request_set *rqset);
 129
 130 int osc_process_config_base(struct obd_device *obd, struct lustre_cfg *cfg);
 131 int osc_build_rpc(const struct lu_env *env, struct client_obd *cli,
 132                   struct list_head *ext_list, int cmd, pdl_policy_t p);
 133 long osc_lru_shrink(const struct lu_env *env, struct client_obd *cli,
 134                    long target, bool force);
 135 long osc_lru_reclaim(struct client_obd *cli);
 136
 137 extern spinlock_t osc_ast_guard;
 138 extern struct lu_kmem_descr osc_caches[];
 139 extern struct lock_class_key osc_ast_guard_class;
 140
 141 unsigned long osc_ldlm_weigh_ast(struct ldlm_lock *dlmlock);
 142
 143 int osc_cleanup(struct obd_device *obd);
 144 int osc_setup(struct obd_device *obd, struct lustre_cfg *lcfg);
 145
 146 #ifdef CONFIG_PROC_FS
 147 extern struct lprocfs_vars lprocfs_osc_obd_vars[];
 148 int lproc_osc_attach_seqstat(struct obd_device *dev);
 149 #else
 150 static inline int lproc_osc_attach_seqstat(struct obd_device *dev) {return 0;}
 151 #endif
 152
 153 extern struct lu_device_type osc_device_type;
 154
 155 static inline int osc_recoverable_error(int rc)
 156 {
 157         return (rc == -EIO || rc == -EROFS || rc == -ENOMEM ||
 158                 rc == -EAGAIN || rc == -EINPROGRESS);
 159 }
 160
 161 static inline unsigned long rpcs_in_flight(struct client_obd *cli)
 162 {
 163         return cli->cl_r_in_flight + cli->cl_w_in_flight;
 164 }
 165
 166 #ifndef min_t
 167 #define min_t(type,x,y) \
 168         ({ type __x = (x); type __y = (y); __x < __y ? __x: __y; })
 169 #endif
 170
 171 struct osc_device {
 172         struct cl_device    od_cl;
 173         struct obd_export  *od_exp;
 174
 175         /* Write stats is actually protected by client_obd's lock. */
 176         struct osc_stats {
 177                 uint64_t     os_lockless_writes;          /* by bytes */
 178                 uint64_t     os_lockless_reads;           /* by bytes */
 179                 uint64_t     os_lockless_truncates;       /* by times */
 180         } od_stats;
 181
 182         /* configuration item(s) */
 183         int                 od_contention_time;
 184         int                 od_lockless_truncate;
 185 };
 186
 187 static inline struct osc_device *obd2osc_dev(const struct obd_device *d)
 188 {
 189         return container_of0(d->obd_lu_dev, struct osc_device, od_cl.cd_lu_dev);
 190 }
 191
 192 extern struct kmem_cache *osc_quota_kmem;
 193 struct osc_quota_info {
 194         /** linkage for quota hash table */
 195         struct hlist_node oqi_hash;
 196         u32               oqi_id;
 197 };
 198
 199 struct osc_async_args {
 200         struct obd_info *aa_oi;
 201 };
 202
 203 int osc_quota_setup(struct obd_device *obd);
 204 int osc_quota_cleanup(struct obd_device *obd);
 205 int osc_quota_setdq(struct client_obd *cli, const unsigned int qid[],
 206                     u64 valid, u32 flags);
 207 int osc_quota_chkdq(struct client_obd *cli, const unsigned int qid[]);
 208 int osc_quotactl(struct obd_device *unused, struct obd_export *exp,
 209                  struct obd_quotactl *oqctl);
 210 int osc_quotacheck(struct obd_device *unused, struct obd_export *exp,
 211                    struct obd_quotactl *oqctl);
 212 int osc_quota_poll_check(struct obd_export *exp, struct if_quotacheck *qchk);
 213 void osc_inc_unstable_pages(struct ptlrpc_request *req);
 214 void osc_dec_unstable_pages(struct ptlrpc_request *req);
 215 bool osc_over_unstable_soft_limit(struct client_obd *cli);
 216 /**
 217  * Bit flags for osc_dlm_lock_at_pageoff().
 218  */
 219 enum osc_dap_flags {
 220         /**
 221          * Just check if the desired lock exists, it won't hold reference
 222          * count on lock.
 223          */
 224         OSC_DAP_FL_TEST_LOCK = 1 << 0,
 225         /**
 226          * Return the lock even if it is being canceled.
 227          */
 228         OSC_DAP_FL_CANCELING = 1 << 1
 229 };
 230 struct ldlm_lock *osc_dlmlock_at_pgoff(const struct lu_env *env,
 231                                        struct osc_object *obj, pgoff_t index,
 232                                        enum osc_dap_flags flags);
 233 void osc_pack_req_body(struct ptlrpc_request *req, struct obd_info *oinfo);
 234 void osc_set_capa_size(struct ptlrpc_request *req,
 235                        const struct req_msg_field *field, struct obd_capa *oc);
 236 int osc_getattr_interpret(const struct lu_env *env,
 237                           struct ptlrpc_request *req,
 238                           struct osc_async_args *aa, int rc);
 239 #endif /* OSC_INTERNAL_H */