Whamcloud - gitweb
LU-506 statahead: revalidating dentry may be stale
[fs/lustre-release.git] / 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 (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
30  * Use is subject to license terms.
31  *
32  * Copyright (c) 2011, 2012, Whamcloud, Inc.
33  */
34 /*
35  * This file is part of Lustre, http://www.lustre.org/
36  * Lustre is a trademark of Sun Microsystems, Inc.
37  */
38
39 #ifndef OSC_INTERNAL_H
40 #define OSC_INTERNAL_H
41
42 #define OAP_MAGIC 8675309
43
44 struct lu_env;
45
46 enum async_flags {
47         ASYNC_READY = 0x1, /* ap_make_ready will not be called before this
48                               page is added to an rpc */
49         ASYNC_URGENT = 0x2, /* page must be put into an RPC before return */
50         ASYNC_COUNT_STABLE = 0x4, /* ap_refresh_count will not be called
51                                      to give the caller a chance to update
52                                      or cancel the size of the io */
53         ASYNC_HP = 0x10,
54 };
55
56 struct obd_async_page_ops {
57         int  (*ap_make_ready)(const struct lu_env *env, void *data, int cmd);
58         int  (*ap_refresh_count)(const struct lu_env *env, void *data, int cmd);
59         int  (*ap_completion)(const struct lu_env *env,
60                               void *data, int cmd, struct obdo *oa, int rc);
61 };
62
63 struct osc_async_page {
64         int                     oap_magic;
65         unsigned short          oap_cmd;
66         unsigned short          oap_interrupted:1;
67
68         cfs_list_t              oap_pending_item;
69         cfs_list_t              oap_urgent_item;
70         cfs_list_t              oap_rpc_item;
71
72         obd_off                 oap_obj_off;
73         unsigned                oap_page_off;
74         enum async_flags        oap_async_flags;
75
76         struct brw_page         oap_brw_page;
77
78         struct ptlrpc_request   *oap_request;
79         struct client_obd       *oap_cli;
80         struct lov_oinfo        *oap_loi;
81
82         const struct obd_async_page_ops *oap_caller_ops;
83         void                    *oap_caller_data;
84         cfs_list_t               oap_page_list;
85         struct ldlm_lock        *oap_ldlm_lock;
86         cfs_spinlock_t           oap_lock;
87 };
88
89 #define oap_page        oap_brw_page.pg
90 #define oap_count       oap_brw_page.count
91 #define oap_brw_flags   oap_brw_page.flag
92
93 struct osc_cache_waiter {
94         cfs_list_t              ocw_entry;
95         cfs_waitq_t             ocw_waitq;
96         struct osc_async_page  *ocw_oap;
97         int                     ocw_rc;
98 };
99
100 #define OSCC_FLAG_RECOVERING         0x01
101 #define OSCC_FLAG_CREATING           0x02
102 #define OSCC_FLAG_NOSPC              0x04 /* can't create more objects on OST */
103 #define OSCC_FLAG_SYNC_IN_PROGRESS   0x08 /* only allow one thread to sync */
104 #define OSCC_FLAG_LOW                0x10
105 #define OSCC_FLAG_EXITING            0x20
106 #define OSCC_FLAG_DEGRADED           0x40
107 #define OSCC_FLAG_RDONLY             0x80
108 #define OSCC_FLAG_NOSPC_BLK          0x100 /* no more block space on OST */
109
110 int osc_precreate(struct obd_export *exp);
111 int osc_create(struct obd_export *exp, struct obdo *oa,
112                struct lov_stripe_md **ea, struct obd_trans_info *oti);
113 int osc_create_async(struct obd_export *exp, struct obd_info *oinfo,
114                      struct lov_stripe_md **ea, struct obd_trans_info *oti);
115 int osc_real_create(struct obd_export *exp, struct obdo *oa,
116                     struct lov_stripe_md **ea, struct obd_trans_info *oti);
117 void oscc_init(struct obd_device *obd);
118 void osc_wake_cache_waiters(struct client_obd *cli);
119 int osc_shrink_grant_to_target(struct client_obd *cli, long target);
120
121 /*
122  * cl integration.
123  */
124 #include <cl_object.h>
125
126 extern struct ptlrpc_request_set *PTLRPCD_SET;
127
128 int osc_enqueue_base(struct obd_export *exp, struct ldlm_res_id *res_id,
129                      int *flags, ldlm_policy_data_t *policy,
130                      struct ost_lvb *lvb, int kms_valid,
131                      obd_enqueue_update_f upcall,
132                      void *cookie, struct ldlm_enqueue_info *einfo,
133                      struct lustre_handle *lockh,
134                      struct ptlrpc_request_set *rqset, int async, int agl);
135 int osc_cancel_base(struct lustre_handle *lockh, __u32 mode);
136
137 int osc_match_base(struct obd_export *exp, struct ldlm_res_id *res_id,
138                    __u32 type, ldlm_policy_data_t *policy, __u32 mode,
139                    int *flags, void *data, struct lustre_handle *lockh,
140                    int unref);
141
142 int osc_setattr_async_base(struct obd_export *exp, struct obd_info *oinfo,
143                            struct obd_trans_info *oti,
144                            obd_enqueue_update_f upcall, void *cookie,
145                            struct ptlrpc_request_set *rqset);
146 int osc_punch_base(struct obd_export *exp, struct obd_info *oinfo,
147                    obd_enqueue_update_f upcall, void *cookie,
148                    struct ptlrpc_request_set *rqset);
149
150 int osc_prep_async_page(struct obd_export *exp, struct lov_stripe_md *lsm,
151                         struct lov_oinfo *loi, cfs_page_t *page,
152                         obd_off offset, const struct obd_async_page_ops *ops,
153                         void *data, void **res, int nocache,
154                         struct lustre_handle *lockh);
155 void osc_oap_to_pending(struct osc_async_page *oap);
156 int  osc_oap_interrupted(const struct lu_env *env, struct osc_async_page *oap);
157 void loi_list_maint(struct client_obd *cli, struct lov_oinfo *loi);
158 void osc_check_rpcs(const struct lu_env *env, struct client_obd *cli);
159 int osc_queue_async_io(const struct lu_env *env, struct obd_export *exp,
160                        struct lov_stripe_md *lsm, struct lov_oinfo *loi,
161                        struct osc_async_page *oap, int cmd, int off,
162                        int count,  obd_flag brw_flags, enum async_flags async_flags);
163 int osc_teardown_async_page(struct obd_export *exp, struct lov_stripe_md *lsm,
164                             struct lov_oinfo *loi, struct osc_async_page *oap);
165 int osc_process_config_base(struct obd_device *obd, struct lustre_cfg *cfg);
166 int osc_set_async_flags_base(struct client_obd *cli,
167                              struct lov_oinfo *loi, struct osc_async_page *oap,
168                              obd_flag async_flags);
169 int osc_enter_cache_try(const struct lu_env *env,
170                         struct client_obd *cli, struct lov_oinfo *loi,
171                         struct osc_async_page *oap, int transient);
172
173 struct cl_page *osc_oap2cl_page(struct osc_async_page *oap);
174 extern cfs_spinlock_t osc_ast_guard;
175
176 int osc_cleanup(struct obd_device *obd);
177 int osc_setup(struct obd_device *obd, struct lustre_cfg *lcfg);
178
179 #ifdef LPROCFS
180 int lproc_osc_attach_seqstat(struct obd_device *dev);
181 void lprocfs_osc_init_vars(struct lprocfs_static_vars *lvars);
182 #else
183 static inline int lproc_osc_attach_seqstat(struct obd_device *dev) {return 0;}
184 static inline void lprocfs_osc_init_vars(struct lprocfs_static_vars *lvars)
185 {
186         memset(lvars, 0, sizeof(*lvars));
187 }
188 #endif
189
190 extern struct lu_device_type osc_device_type;
191
192 static inline int osc_recoverable_error(int rc)
193 {
194         return (rc == -EIO || rc == -EROFS || rc == -ENOMEM || rc == -EAGAIN);
195 }
196
197 #ifndef min_t
198 #define min_t(type,x,y) \
199         ({ type __x = (x); type __y = (y); __x < __y ? __x: __y; })
200 #endif
201
202 struct osc_device {
203         struct cl_device    od_cl;
204         struct obd_export  *od_exp;
205
206         /* Write stats is actually protected by client_obd's lock. */
207         struct osc_stats {
208                 uint64_t     os_lockless_writes;          /* by bytes */
209                 uint64_t     os_lockless_reads;           /* by bytes */
210                 uint64_t     os_lockless_truncates;       /* by times */
211         } od_stats;
212
213         /* configuration item(s) */
214         int                 od_contention_time;
215         int                 od_lockless_truncate;
216 };
217
218 static inline struct osc_device *obd2osc_dev(const struct obd_device *d)
219 {
220         return container_of0(d->obd_lu_dev, struct osc_device, od_cl.cd_lu_dev);
221 }
222
223 int osc_dlm_lock_pageref(struct ldlm_lock *dlm);
224
225 int osc_quota_init(void);
226 int osc_quota_exit(void);
227 int osc_quota_cleanup(struct obd_device *obd);
228 int osc_quota_setdq(struct client_obd *cli, const unsigned int qid[],
229                     obd_flag valid, obd_flag flags);
230 int osc_quota_chkdq(struct client_obd *cli, const unsigned int qid[]);
231 int osc_quotactl(struct obd_device *unused, struct obd_export *exp,
232                  struct obd_quotactl *oqctl);
233 int osc_quotacheck(struct obd_device *unused, struct obd_export *exp,
234                    struct obd_quotactl *oqctl);
235 int osc_quota_poll_check(struct obd_export *exp, struct if_quotacheck *qchk);
236 int osc_quota_adjust_qunit(struct obd_export *exp,
237                            struct quota_adjust_qunit *oqaq,
238                            struct lustre_quota_ctxt *qctxt,
239                            struct ptlrpc_request_set *rqset);
240 #endif /* OSC_INTERNAL_H */