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, 2015, Intel Corporation.
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
42 extern atomic_t osc_pool_req_count;
43 extern unsigned int osc_reqpool_maxreqcount;
44 extern struct ptlrpc_request_pool *osc_rq_pool;
49 ASYNC_READY = 0x1, /* ap_make_ready will not be called before this
50 page is added to an rpc */
51 ASYNC_URGENT = 0x2, /* page must be put into an RPC before return */
52 ASYNC_COUNT_STABLE = 0x4, /* ap_refresh_count will not be called
53 to give the caller a chance to update
54 or cancel the size of the io */
58 struct osc_async_page {
60 unsigned short oap_cmd;
61 unsigned short oap_interrupted:1;
63 struct list_head oap_pending_item;
64 struct list_head oap_rpc_item;
67 unsigned oap_page_off;
68 enum async_flags oap_async_flags;
70 struct brw_page oap_brw_page;
72 struct ptlrpc_request *oap_request;
73 struct client_obd *oap_cli;
74 struct osc_object *oap_obj;
79 #define oap_page oap_brw_page.pg
80 #define oap_count oap_brw_page.count
81 #define oap_brw_flags oap_brw_page.flag
83 static inline struct osc_async_page *brw_page2oap(struct brw_page *pga)
85 return (struct osc_async_page *)container_of(pga, struct osc_async_page,
89 struct osc_cache_waiter {
90 struct list_head ocw_entry;
91 wait_queue_head_t ocw_waitq;
92 struct osc_async_page *ocw_oap;
97 void osc_wake_cache_waiters(struct client_obd *cli);
98 int osc_shrink_grant_to_target(struct client_obd *cli, __u64 target_bytes);
99 void osc_update_next_shrink(struct client_obd *cli);
104 #include <cl_object.h>
106 extern struct ptlrpc_request_set *PTLRPCD_SET;
108 typedef int (*osc_enqueue_upcall_f)(void *cookie, struct lustre_handle *lockh,
111 int osc_enqueue_base(struct obd_export *exp, struct ldlm_res_id *res_id,
112 __u64 *flags, union ldlm_policy_data *policy,
113 struct ost_lvb *lvb, int kms_valid,
114 osc_enqueue_upcall_f upcall,
115 void *cookie, struct ldlm_enqueue_info *einfo,
116 struct ptlrpc_request_set *rqset, int async, int agl);
118 int osc_match_base(struct obd_export *exp, struct ldlm_res_id *res_id,
119 __u32 type, union ldlm_policy_data *policy, __u32 mode,
120 __u64 *flags, void *data, struct lustre_handle *lockh,
123 int osc_setattr_async(struct obd_export *exp, struct obdo *oa,
124 obd_enqueue_update_f upcall, void *cookie,
125 struct ptlrpc_request_set *rqset);
126 int osc_punch_base(struct obd_export *exp, struct obdo *oa,
127 obd_enqueue_update_f upcall, void *cookie,
128 struct ptlrpc_request_set *rqset);
129 int osc_sync_base(struct osc_object *obj, struct obdo *oa,
130 obd_enqueue_update_f upcall, void *cookie,
131 struct ptlrpc_request_set *rqset);
132 int osc_ladvise_base(struct obd_export *exp, struct obdo *oa,
133 struct ladvise_hdr *ladvise_hdr,
134 obd_enqueue_update_f upcall, void *cookie,
135 struct ptlrpc_request_set *rqset);
136 int osc_process_config_base(struct obd_device *obd, struct lustre_cfg *cfg);
137 int osc_build_rpc(const struct lu_env *env, struct client_obd *cli,
138 struct list_head *ext_list, int cmd);
139 long osc_lru_shrink(const struct lu_env *env, struct client_obd *cli,
140 long target, bool force);
141 unsigned long osc_lru_reserve(struct client_obd *cli, unsigned long npages);
142 void osc_lru_unreserve(struct client_obd *cli, unsigned long npages);
144 extern struct lu_kmem_descr osc_caches[];
146 unsigned long osc_ldlm_weigh_ast(struct ldlm_lock *dlmlock);
148 int osc_cleanup(struct obd_device *obd);
149 int osc_setup(struct obd_device *obd, struct lustre_cfg *lcfg);
151 #ifdef CONFIG_PROC_FS
152 extern struct lprocfs_vars lprocfs_osc_obd_vars[];
153 int lproc_osc_attach_seqstat(struct obd_device *dev);
155 static inline int lproc_osc_attach_seqstat(struct obd_device *dev) {return 0;}
158 extern struct lu_device_type osc_device_type;
160 static inline int osc_recoverable_error(int rc)
162 return (rc == -EIO || rc == -EROFS || rc == -ENOMEM ||
163 rc == -EAGAIN || rc == -EINPROGRESS);
166 static inline unsigned long rpcs_in_flight(struct client_obd *cli)
168 return cli->cl_r_in_flight + cli->cl_w_in_flight;
171 static inline char *cli_name(struct client_obd *cli)
173 return cli->cl_import->imp_obd->obd_name;
177 #define min_t(type,x,y) \
178 ({ type __x = (x); type __y = (y); __x < __y ? __x: __y; })
182 struct cl_device od_cl;
183 struct obd_export *od_exp;
185 /* Write stats is actually protected by client_obd's lock. */
187 uint64_t os_lockless_writes; /* by bytes */
188 uint64_t os_lockless_reads; /* by bytes */
189 uint64_t os_lockless_truncates; /* by times */
192 /* configuration item(s) */
193 int od_contention_time;
194 int od_lockless_truncate;
197 static inline struct osc_device *obd2osc_dev(const struct obd_device *d)
199 return container_of0(d->obd_lu_dev, struct osc_device, od_cl.cd_lu_dev);
202 extern struct kmem_cache *osc_quota_kmem;
203 struct osc_quota_info {
204 /** linkage for quota hash table */
205 struct hlist_node oqi_hash;
209 struct osc_async_args {
210 struct obd_info *aa_oi;
213 int osc_quota_setup(struct obd_device *obd);
214 int osc_quota_cleanup(struct obd_device *obd);
215 int osc_quota_setdq(struct client_obd *cli, const unsigned int qid[],
216 u64 valid, u32 flags);
217 int osc_quota_chkdq(struct client_obd *cli, const unsigned int qid[]);
218 int osc_quotactl(struct obd_device *unused, struct obd_export *exp,
219 struct obd_quotactl *oqctl);
220 void osc_inc_unstable_pages(struct ptlrpc_request *req);
221 void osc_dec_unstable_pages(struct ptlrpc_request *req);
222 bool osc_over_unstable_soft_limit(struct client_obd *cli);
224 * Bit flags for osc_dlm_lock_at_pageoff().
228 * Just check if the desired lock exists, it won't hold reference
231 OSC_DAP_FL_TEST_LOCK = 1 << 0,
233 * Return the lock even if it is being canceled.
235 OSC_DAP_FL_CANCELING = 1 << 1
237 struct ldlm_lock *osc_dlmlock_at_pgoff(const struct lu_env *env,
238 struct osc_object *obj, pgoff_t index,
239 enum osc_dap_flags flags);
240 void osc_pack_req_body(struct ptlrpc_request *req, struct obdo *oa);
241 int osc_object_invalidate(const struct lu_env *env, struct osc_object *osc);
243 /** osc shrink list to link all osc client obd */
244 extern struct list_head osc_shrink_list;
245 /** spin lock to protect osc_shrink_list */
246 extern spinlock_t osc_shrink_lock;
247 extern unsigned long osc_cache_shrink_count(struct shrinker *sk,
248 struct shrink_control *sc);
249 extern unsigned long osc_cache_shrink_scan(struct shrinker *sk,
250 struct shrink_control *sc);
252 #endif /* OSC_INTERNAL_H */