4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
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
27 * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2012, Whamcloud, Inc.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
37 #ifndef OSC_INTERNAL_H
38 #define OSC_INTERNAL_H
40 #define OAP_MAGIC 8675309
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 */
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);
61 struct osc_async_page {
63 unsigned short oap_cmd;
64 unsigned short oap_interrupted:1;
66 cfs_list_t oap_pending_item;
67 cfs_list_t oap_urgent_item;
68 cfs_list_t oap_rpc_item;
71 unsigned oap_page_off;
72 enum async_flags oap_async_flags;
74 struct brw_page oap_brw_page;
76 struct ptlrpc_request *oap_request;
77 struct client_obd *oap_cli;
78 struct lov_oinfo *oap_loi;
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;
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
91 struct osc_cache_waiter {
93 cfs_waitq_t ocw_waitq;
94 struct osc_async_page *ocw_oap;
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 #define OSCC_FLAG_NOSPC_BLK 0x100 /* no more block space on OST */
108 int osc_precreate(struct obd_export *exp);
109 int osc_create(const struct lu_env *env, struct obd_export *exp,
110 struct obdo *oa, struct lov_stripe_md **ea,
111 struct obd_trans_info *oti);
112 int osc_create_async(struct obd_export *exp, struct obd_info *oinfo,
113 struct lov_stripe_md **ea, struct obd_trans_info *oti);
114 int osc_real_create(struct obd_export *exp, struct obdo *oa,
115 struct lov_stripe_md **ea, struct obd_trans_info *oti);
116 void oscc_init(struct obd_device *obd);
117 void osc_wake_cache_waiters(struct client_obd *cli);
118 int osc_shrink_grant_to_target(struct client_obd *cli, long target);
123 #include <cl_object.h>
125 extern struct ptlrpc_request_set *PTLRPCD_SET;
127 int osc_enqueue_base(struct obd_export *exp, struct ldlm_res_id *res_id,
128 int *flags, ldlm_policy_data_t *policy,
129 struct ost_lvb *lvb, int kms_valid,
130 obd_enqueue_update_f upcall,
131 void *cookie, struct ldlm_enqueue_info *einfo,
132 struct lustre_handle *lockh,
133 struct ptlrpc_request_set *rqset, int async, int agl);
134 int osc_cancel_base(struct lustre_handle *lockh, __u32 mode);
136 int osc_match_base(struct obd_export *exp, struct ldlm_res_id *res_id,
137 __u32 type, ldlm_policy_data_t *policy, __u32 mode,
138 int *flags, void *data, struct lustre_handle *lockh,
141 int osc_setattr_async_base(struct obd_export *exp, struct obd_info *oinfo,
142 struct obd_trans_info *oti,
143 obd_enqueue_update_f upcall, void *cookie,
144 struct ptlrpc_request_set *rqset);
145 int osc_punch_base(struct obd_export *exp, struct obd_info *oinfo,
146 obd_enqueue_update_f upcall, void *cookie,
147 struct ptlrpc_request_set *rqset);
149 int osc_prep_async_page(struct obd_export *exp, struct lov_stripe_md *lsm,
150 struct lov_oinfo *loi, cfs_page_t *page,
151 obd_off offset, const struct obd_async_page_ops *ops,
152 void *data, void **res, int nocache,
153 struct lustre_handle *lockh);
154 void osc_oap_to_pending(struct osc_async_page *oap);
155 int osc_oap_interrupted(const struct lu_env *env, struct osc_async_page *oap);
156 void loi_list_maint(struct client_obd *cli, struct lov_oinfo *loi);
157 void osc_check_rpcs(const struct lu_env *env, struct client_obd *cli);
158 int osc_queue_async_io(const struct lu_env *env, struct obd_export *exp,
159 struct lov_stripe_md *lsm, struct lov_oinfo *loi,
160 struct osc_async_page *oap, int cmd, int off,
161 int count, obd_flag brw_flags, enum async_flags async_flags);
162 int osc_teardown_async_page(struct obd_export *exp, struct lov_stripe_md *lsm,
163 struct lov_oinfo *loi, struct osc_async_page *oap);
164 int osc_process_config_base(struct obd_device *obd, struct lustre_cfg *cfg);
165 int osc_set_async_flags_base(struct client_obd *cli,
166 struct lov_oinfo *loi, struct osc_async_page *oap,
167 obd_flag async_flags);
168 int osc_enter_cache_try(const struct lu_env *env,
169 struct client_obd *cli, struct lov_oinfo *loi,
170 struct osc_async_page *oap, int transient);
172 struct cl_page *osc_oap2cl_page(struct osc_async_page *oap);
173 extern cfs_spinlock_t osc_ast_guard;
175 int osc_cleanup(struct obd_device *obd);
176 int osc_setup(struct obd_device *obd, struct lustre_cfg *lcfg);
179 int lproc_osc_attach_seqstat(struct obd_device *dev);
180 void lprocfs_osc_init_vars(struct lprocfs_static_vars *lvars);
182 static inline int lproc_osc_attach_seqstat(struct obd_device *dev) {return 0;}
183 static inline void lprocfs_osc_init_vars(struct lprocfs_static_vars *lvars)
185 memset(lvars, 0, sizeof(*lvars));
189 extern struct lu_device_type osc_device_type;
191 static inline int osc_recoverable_error(int rc)
193 return (rc == -EIO || rc == -EROFS || rc == -ENOMEM ||
194 rc == -EAGAIN || rc == -EINPROGRESS);
198 #define min_t(type,x,y) \
199 ({ type __x = (x); type __y = (y); __x < __y ? __x: __y; })
203 struct cl_device od_cl;
204 struct obd_export *od_exp;
206 /* Write stats is actually protected by client_obd's lock. */
208 uint64_t os_lockless_writes; /* by bytes */
209 uint64_t os_lockless_reads; /* by bytes */
210 uint64_t os_lockless_truncates; /* by times */
213 /* configuration item(s) */
214 int od_contention_time;
215 int od_lockless_truncate;
218 static inline struct osc_device *obd2osc_dev(const struct obd_device *d)
220 return container_of0(d->obd_lu_dev, struct osc_device, od_cl.cd_lu_dev);
223 int osc_dlm_lock_pageref(struct ldlm_lock *dlm);
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 */