lustre/osc/osc_internal.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
  30  * Use is subject to license terms.
  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 obd_async_page_ops {
  55         int  (*ap_make_ready)(const struct lu_env *env, void *data, int cmd);
  56         int  (*ap_refresh_count)(const struct lu_env *env, void *data, int cmd);
  57         int  (*ap_completion)(const struct lu_env *env,
  58                               void *data, int cmd, struct obdo *oa, int rc);
  59 };
  60
  61 struct osc_async_page {
  62         int                     oap_magic;
  63         unsigned short          oap_cmd;
  64         unsigned short          oap_interrupted:1;
  65
  66         cfs_list_t              oap_pending_item;
  67         cfs_list_t              oap_urgent_item;
  68         cfs_list_t              oap_rpc_item;
  69
  70         obd_off                 oap_obj_off;
  71         unsigned                oap_page_off;
  72         enum async_flags        oap_async_flags;
  73
  74         struct brw_page         oap_brw_page;
  75
  76         struct ptlrpc_request   *oap_request;
  77         struct client_obd       *oap_cli;
  78         struct lov_oinfo        *oap_loi;
  79
  80         const struct obd_async_page_ops *oap_caller_ops;
  81         void                    *oap_caller_data;
  82         cfs_list_t               oap_page_list;
  83         struct ldlm_lock        *oap_ldlm_lock;
  84         cfs_spinlock_t           oap_lock;
  85 };
  86
  87 #define oap_page        oap_brw_page.pg
  88 #define oap_count       oap_brw_page.count
  89 #define oap_brw_flags   oap_brw_page.flag
  90
  91 struct osc_cache_waiter {
  92         cfs_list_t              ocw_entry;
  93         cfs_waitq_t             ocw_waitq;
  94         struct osc_async_page  *ocw_oap;
  95         int                     ocw_rc;
  96 };
  97
  98 #define OSCC_FLAG_RECOVERING         0x01
  99 #define OSCC_FLAG_CREATING           0x02
 100 #define OSCC_FLAG_NOSPC              0x04 /* can't create more objects on OST */
 101 #define OSCC_FLAG_SYNC_IN_PROGRESS   0x08 /* only allow one thread to sync */
 102 #define OSCC_FLAG_LOW                0x10
 103 #define OSCC_FLAG_EXITING            0x20
 104 #define OSCC_FLAG_DEGRADED           0x40
 105 #define OSCC_FLAG_RDONLY             0x80
 106
 107 int osc_precreate(struct obd_export *exp);
 108 int osc_create(struct obd_export *exp, struct obdo *oa,
 109                struct lov_stripe_md **ea, struct obd_trans_info *oti);
 110 int osc_create_async(struct obd_export *exp, struct obd_info *oinfo,
 111                      struct lov_stripe_md **ea, struct obd_trans_info *oti);
 112 int osc_real_create(struct obd_export *exp, struct obdo *oa,
 113                     struct lov_stripe_md **ea, struct obd_trans_info *oti);
 114 void oscc_init(struct obd_device *obd);
 115 void osc_wake_cache_waiters(struct client_obd *cli);
 116 int osc_shrink_grant_to_target(struct client_obd *cli, long target);
 117
 118 /*
 119  * cl integration.
 120  */
 121 #include <cl_object.h>
 122
 123 extern struct ptlrpc_request_set *PTLRPCD_SET;
 124
 125 int osc_enqueue_base(struct obd_export *exp, struct ldlm_res_id *res_id,
 126                      int *flags, ldlm_policy_data_t *policy,
 127                      struct ost_lvb *lvb, int kms_valid,
 128                      obd_enqueue_update_f upcall,
 129                      void *cookie, struct ldlm_enqueue_info *einfo,
 130                      struct lustre_handle *lockh,
 131                      struct ptlrpc_request_set *rqset, int async);
 132 int osc_cancel_base(struct lustre_handle *lockh, __u32 mode);
 133
 134 int osc_match_base(struct obd_export *exp, struct ldlm_res_id *res_id,
 135                    __u32 type, ldlm_policy_data_t *policy, __u32 mode,
 136                    int *flags, void *data, struct lustre_handle *lockh,
 137                    int unref);
 138
 139 int osc_punch_base(struct obd_export *exp, struct obdo *oa,
 140                    struct obd_capa *capa,
 141                    obd_enqueue_update_f upcall, void *cookie,
 142                    struct ptlrpc_request_set *rqset);
 143
 144 int osc_prep_async_page(struct obd_export *exp, struct lov_stripe_md *lsm,
 145                         struct lov_oinfo *loi, cfs_page_t *page,
 146                         obd_off offset, const struct obd_async_page_ops *ops,
 147                         void *data, void **res, int nocache,
 148                         struct lustre_handle *lockh);
 149 void osc_oap_to_pending(struct osc_async_page *oap);
 150 int  osc_oap_interrupted(const struct lu_env *env, struct osc_async_page *oap);
 151 void loi_list_maint(struct client_obd *cli, struct lov_oinfo *loi);
 152 void osc_check_rpcs(const struct lu_env *env, struct client_obd *cli);
 153
 154 int osc_queue_async_io(const struct lu_env *env,
 155                        struct obd_export *exp, struct lov_stripe_md *lsm,
 156                        struct lov_oinfo *loi, void *cookie,
 157                        int cmd, obd_off off, int count,
 158                        obd_flag brw_flags, enum async_flags async_flags);
 159 int osc_teardown_async_page(struct obd_export *exp,
 160                             struct lov_stripe_md *lsm,
 161                             struct lov_oinfo *loi, void *cookie);
 162 int osc_process_config_base(struct obd_device *obd, struct lustre_cfg *cfg);
 163 int osc_set_async_flags_base(struct client_obd *cli,
 164                              struct lov_oinfo *loi, struct osc_async_page *oap,
 165                              obd_flag async_flags);
 166 int osc_enter_cache_try(const struct lu_env *env,
 167                         struct client_obd *cli, struct lov_oinfo *loi,
 168                         struct osc_async_page *oap, int transient);
 169
 170 struct cl_page *osc_oap2cl_page(struct osc_async_page *oap);
 171 extern cfs_spinlock_t osc_ast_guard;
 172
 173 int osc_cleanup(struct obd_device *obd);
 174 int osc_setup(struct obd_device *obd, struct lustre_cfg *lcfg);
 175
 176 #ifdef LPROCFS
 177 int lproc_osc_attach_seqstat(struct obd_device *dev);
 178 void lprocfs_osc_init_vars(struct lprocfs_static_vars *lvars);
 179 #else
 180 static inline int lproc_osc_attach_seqstat(struct obd_device *dev) {return 0;}
 181 static inline void lprocfs_osc_init_vars(struct lprocfs_static_vars *lvars)
 182 {
 183         memset(lvars, 0, sizeof(*lvars));
 184 }
 185 #endif
 186
 187 extern struct lu_device_type osc_device_type;
 188
 189 static inline int osc_recoverable_error(int rc)
 190 {
 191         return (rc == -EIO || rc == -EROFS || rc == -ENOMEM || rc == -EAGAIN);
 192 }
 193
 194 /* return 1 if osc should be resend request */
 195 static inline int osc_should_resend(int resend, struct client_obd *cli)
 196 {
 197         return cfs_atomic_read(&cli->cl_resends) ?
 198                cfs_atomic_read(&cli->cl_resends) > resend : 1;
 199 }
 200
 201 #ifndef min_t
 202 #define min_t(type,x,y) \
 203         ({ type __x = (x); type __y = (y); __x < __y ? __x: __y; })
 204 #endif
 205
 206 struct osc_device {
 207         struct cl_device    od_cl;
 208         struct obd_export  *od_exp;
 209
 210         /* Write stats is actually protected by client_obd's lock. */
 211         struct osc_stats {
 212                 uint64_t     os_lockless_writes;          /* by bytes */
 213                 uint64_t     os_lockless_reads;           /* by bytes */
 214                 uint64_t     os_lockless_truncates;       /* by times */
 215         } od_stats;
 216
 217         /* configuration item(s) */
 218         int                 od_contention_time;
 219         int                 od_lockless_truncate;
 220 };
 221
 222 static inline struct osc_device *obd2osc_dev(const struct obd_device *d)
 223 {
 224         return container_of0(d->obd_lu_dev, struct osc_device, od_cl.cd_lu_dev);
 225 }
 226
 227
 228 #endif /* OSC_INTERNAL_H */