1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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
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
29 * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
30 * Use is subject to license terms.
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 */
55 struct obd_async_page_ops {
56 int (*ap_make_ready)(const struct lu_env *env, void *data, int cmd);
57 int (*ap_refresh_count)(const struct lu_env *env, void *data, int cmd);
58 int (*ap_completion)(const struct lu_env *env,
59 void *data, int cmd, struct obdo *oa, int rc);
62 struct osc_async_page {
64 unsigned short oap_cmd;
65 unsigned short oap_interrupted:1;
67 cfs_list_t oap_pending_item;
68 cfs_list_t oap_urgent_item;
69 cfs_list_t oap_rpc_item;
72 unsigned oap_page_off;
73 enum async_flags oap_async_flags;
75 struct brw_page oap_brw_page;
77 struct ptlrpc_request *oap_request;
78 struct client_obd *oap_cli;
79 struct lov_oinfo *oap_loi;
81 const struct obd_async_page_ops *oap_caller_ops;
82 void *oap_caller_data;
83 cfs_list_t oap_page_list;
84 struct ldlm_lock *oap_ldlm_lock;
85 cfs_spinlock_t oap_lock;
88 #define oap_page oap_brw_page.pg
89 #define oap_count oap_brw_page.count
90 #define oap_brw_flags oap_brw_page.flag
92 struct osc_cache_waiter {
94 cfs_waitq_t ocw_waitq;
95 struct osc_async_page *ocw_oap;
99 #define OSCC_FLAG_RECOVERING 0x01
100 #define OSCC_FLAG_CREATING 0x02
101 #define OSCC_FLAG_NOSPC 0x04 /* can't create more objects on OST */
102 #define OSCC_FLAG_SYNC_IN_PROGRESS 0x08 /* only allow one thread to sync */
103 #define OSCC_FLAG_LOW 0x10
104 #define OSCC_FLAG_EXITING 0x20
105 #define OSCC_FLAG_DEGRADED 0x40
106 #define OSCC_FLAG_RDONLY 0x80
108 int osc_precreate(struct obd_export *exp);
109 int osc_create(struct obd_export *exp, struct obdo *oa,
110 struct lov_stripe_md **ea, struct obd_trans_info *oti);
111 int osc_create_async(struct obd_export *exp, struct obd_info *oinfo,
112 struct lov_stripe_md **ea, struct obd_trans_info *oti);
113 int osc_real_create(struct obd_export *exp, struct obdo *oa,
114 struct lov_stripe_md **ea, struct obd_trans_info *oti);
115 void oscc_init(struct obd_device *obd);
116 void osc_wake_cache_waiters(struct client_obd *cli);
117 int osc_shrink_grant_to_target(struct client_obd *cli, long target);
122 #include <cl_object.h>
124 extern struct ptlrpc_request_set *PTLRPCD_SET;
126 int osc_enqueue_base(struct obd_export *exp, struct ldlm_res_id *res_id,
127 int *flags, ldlm_policy_data_t *policy,
128 struct ost_lvb *lvb, int kms_valid,
129 obd_enqueue_update_f upcall,
130 void *cookie, struct ldlm_enqueue_info *einfo,
131 struct lustre_handle *lockh,
132 struct ptlrpc_request_set *rqset, int async);
133 int osc_cancel_base(struct lustre_handle *lockh, __u32 mode);
135 int osc_match_base(struct obd_export *exp, struct ldlm_res_id *res_id,
136 __u32 type, ldlm_policy_data_t *policy, __u32 mode,
137 int *flags, void *data, struct lustre_handle *lockh,
140 int osc_setattr_async_base(struct obd_export *exp, struct obd_info *oinfo,
141 struct obd_trans_info *oti,
142 obd_enqueue_update_f upcall, void *cookie,
143 struct ptlrpc_request_set *rqset);
144 int osc_punch_base(struct obd_export *exp, struct obd_info *oinfo,
145 obd_enqueue_update_f upcall, void *cookie,
146 struct ptlrpc_request_set *rqset);
148 int osc_prep_async_page(struct obd_export *exp, struct lov_stripe_md *lsm,
149 struct lov_oinfo *loi, cfs_page_t *page,
150 obd_off offset, const struct obd_async_page_ops *ops,
151 void *data, void **res, int nocache,
152 struct lustre_handle *lockh);
153 void osc_oap_to_pending(struct osc_async_page *oap);
154 int osc_oap_interrupted(const struct lu_env *env, struct osc_async_page *oap);
155 void loi_list_maint(struct client_obd *cli, struct lov_oinfo *loi);
156 void osc_check_rpcs(const struct lu_env *env, struct client_obd *cli);
158 int osc_queue_async_io(const struct lu_env *env,
159 struct obd_export *exp, struct lov_stripe_md *lsm,
160 struct lov_oinfo *loi, void *cookie,
161 int cmd, obd_off off, int count,
162 obd_flag brw_flags, enum async_flags async_flags);
163 int osc_teardown_async_page(struct obd_export *exp,
164 struct lov_stripe_md *lsm,
165 struct lov_oinfo *loi, void *cookie);
166 int osc_process_config_base(struct obd_device *obd, struct lustre_cfg *cfg);
167 int osc_set_async_flags_base(struct client_obd *cli,
168 struct lov_oinfo *loi, struct osc_async_page *oap,
169 obd_flag async_flags);
170 int osc_enter_cache_try(const struct lu_env *env,
171 struct client_obd *cli, struct lov_oinfo *loi,
172 struct osc_async_page *oap, int transient);
174 struct cl_page *osc_oap2cl_page(struct osc_async_page *oap);
175 extern cfs_spinlock_t osc_ast_guard;
177 int osc_cleanup(struct obd_device *obd);
178 int osc_setup(struct obd_device *obd, struct lustre_cfg *lcfg);
181 int lproc_osc_attach_seqstat(struct obd_device *dev);
182 void lprocfs_osc_init_vars(struct lprocfs_static_vars *lvars);
184 static inline int lproc_osc_attach_seqstat(struct obd_device *dev) {return 0;}
185 static inline void lprocfs_osc_init_vars(struct lprocfs_static_vars *lvars)
187 memset(lvars, 0, sizeof(*lvars));
191 extern struct lu_device_type osc_device_type;
193 static inline int osc_recoverable_error(int rc)
195 return (rc == -EIO || rc == -EROFS || rc == -ENOMEM || rc == -EAGAIN);
198 /* return 1 if osc should be resend request */
199 static inline int osc_should_resend(int resend, struct client_obd *cli)
201 return cfs_atomic_read(&cli->cl_resends) ?
202 cfs_atomic_read(&cli->cl_resends) > resend : 1;
206 #define min_t(type,x,y) \
207 ({ type __x = (x); type __y = (y); __x < __y ? __x: __y; })
211 struct cl_device od_cl;
212 struct obd_export *od_exp;
214 /* Write stats is actually protected by client_obd's lock. */
216 uint64_t os_lockless_writes; /* by bytes */
217 uint64_t os_lockless_reads; /* by bytes */
218 uint64_t os_lockless_truncates; /* by times */
221 /* configuration item(s) */
222 int od_contention_time;
223 int od_lockless_truncate;
226 static inline struct osc_device *obd2osc_dev(const struct obd_device *d)
228 return container_of0(d->obd_lu_dev, struct osc_device, od_cl.cd_lu_dev);
231 int osc_dlm_lock_pageref(struct ldlm_lock *dlm);
233 #endif /* OSC_INTERNAL_H */