1 /*
2 * GPL HEADER START
3 *
4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 *
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.
9 *
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).
15 *
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
19 *
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
22 * have any questions.
23 *
24 * GPL HEADER END
25 */
26 /*
27 * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
29 *
30 * Copyright (c) 2011, 2012, Intel Corporation.
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 osc_async_page {
55 int oap_magic;
56 unsigned short oap_cmd;
57 unsigned short oap_interrupted:1;
58
59 struct list_head oap_pending_item;
60 struct list_head oap_rpc_item;
61
62 u64 oap_obj_off;
63 unsigned oap_page_off;
64 enum async_flags oap_async_flags;
65
66 struct brw_page oap_brw_page;
67
68 struct ptlrpc_request *oap_request;
69 struct client_obd *oap_cli;
70 struct osc_object *oap_obj;
71
72 struct ldlm_lock *oap_ldlm_lock;
73 spinlock_t oap_lock;
74 };
75
76 #define oap_page oap_brw_page.pg
77 #define oap_count oap_brw_page.count
78 #define oap_brw_flags oap_brw_page.flag
79
80 struct osc_cache_waiter {
81 struct list_head ocw_entry;
82 wait_queue_head_t ocw_waitq;
83 struct osc_async_page *ocw_oap;
84 int ocw_grant;
85 int ocw_rc;
86 };
87
88 int osc_create(const struct lu_env *env, struct obd_export *exp,
89 struct obdo *oa, struct lov_stripe_md **ea,
90 struct obd_trans_info *oti);
91 int osc_real_create(struct obd_export *exp, struct obdo *oa,
92 struct lov_stripe_md **ea, struct obd_trans_info *oti);
93 void osc_wake_cache_waiters(struct client_obd *cli);
94 int osc_shrink_grant_to_target(struct client_obd *cli, __u64 target_bytes);
95 void osc_update_next_shrink(struct client_obd *cli);
96
97 /*
98 * cl integration.
99 */
100 #include "../include/cl_object.h"
101
102 extern struct ptlrpc_request_set *PTLRPCD_SET;
103
104 int osc_enqueue_base(struct obd_export *exp, struct ldlm_res_id *res_id,
105 __u64 *flags, ldlm_policy_data_t *policy,
106 struct ost_lvb *lvb, int kms_valid,
107 obd_enqueue_update_f upcall,
108 void *cookie, struct ldlm_enqueue_info *einfo,
109 struct lustre_handle *lockh,
110 struct ptlrpc_request_set *rqset, int async, int agl);
111 int osc_cancel_base(struct lustre_handle *lockh, __u32 mode);
112
113 int osc_match_base(struct obd_export *exp, struct ldlm_res_id *res_id,
114 __u32 type, ldlm_policy_data_t *policy, __u32 mode,
115 __u64 *flags, void *data, struct lustre_handle *lockh,
116 int unref);
117
118 int osc_setattr_async_base(struct obd_export *exp, struct obd_info *oinfo,
119 struct obd_trans_info *oti,
120 obd_enqueue_update_f upcall, void *cookie,
121 struct ptlrpc_request_set *rqset);
122 int osc_punch_base(struct obd_export *exp, struct obd_info *oinfo,
123 obd_enqueue_update_f upcall, void *cookie,
124 struct ptlrpc_request_set *rqset);
125 int osc_sync_base(struct obd_export *exp, struct obd_info *oinfo,
126 obd_enqueue_update_f upcall, void *cookie,
127 struct ptlrpc_request_set *rqset);
128
129 int osc_process_config_base(struct obd_device *obd, struct lustre_cfg *cfg);
130 int osc_build_rpc(const struct lu_env *env, struct client_obd *cli,
131 struct list_head *ext_list, int cmd, pdl_policy_t p);
132 int osc_lru_shrink(struct client_obd *cli, int target);
133
134 extern spinlock_t osc_ast_guard;
135
136 int osc_cleanup(struct obd_device *obd);
137 int osc_setup(struct obd_device *obd, struct lustre_cfg *lcfg);
138
139 #if defined (CONFIG_PROC_FS)
140 int lproc_osc_attach_seqstat(struct obd_device *dev);
141 void lprocfs_osc_init_vars(struct lprocfs_static_vars *lvars);
142 #else
lproc_osc_attach_seqstat(struct obd_device * dev)143 static inline int lproc_osc_attach_seqstat(struct obd_device *dev) {return 0;}
lprocfs_osc_init_vars(struct lprocfs_static_vars * lvars)144 static inline void lprocfs_osc_init_vars(struct lprocfs_static_vars *lvars)
145 {
146 memset(lvars, 0, sizeof(*lvars));
147 }
148 #endif
149
150 extern struct lu_device_type osc_device_type;
151
osc_recoverable_error(int rc)152 static inline int osc_recoverable_error(int rc)
153 {
154 return (rc == -EIO || rc == -EROFS || rc == -ENOMEM ||
155 rc == -EAGAIN || rc == -EINPROGRESS);
156 }
157
rpcs_in_flight(struct client_obd * cli)158 static inline unsigned long rpcs_in_flight(struct client_obd *cli)
159 {
160 return cli->cl_r_in_flight + cli->cl_w_in_flight;
161 }
162
163 struct osc_device {
164 struct cl_device od_cl;
165 struct obd_export *od_exp;
166
167 /* Write stats is actually protected by client_obd's lock. */
168 struct osc_stats {
169 uint64_t os_lockless_writes; /* by bytes */
170 uint64_t os_lockless_reads; /* by bytes */
171 uint64_t os_lockless_truncates; /* by times */
172 } od_stats;
173
174 /* configuration item(s) */
175 int od_contention_time;
176 int od_lockless_truncate;
177 };
178
obd2osc_dev(const struct obd_device * d)179 static inline struct osc_device *obd2osc_dev(const struct obd_device *d)
180 {
181 return container_of0(d->obd_lu_dev, struct osc_device, od_cl.cd_lu_dev);
182 }
183
184 int osc_dlm_lock_pageref(struct ldlm_lock *dlm);
185
186 extern struct kmem_cache *osc_quota_kmem;
187 struct osc_quota_info {
188 /** linkage for quota hash table */
189 struct hlist_node oqi_hash;
190 u32 oqi_id;
191 };
192 int osc_quota_setup(struct obd_device *obd);
193 int osc_quota_cleanup(struct obd_device *obd);
194 int osc_quota_setdq(struct client_obd *cli, const unsigned int qid[],
195 u32 valid, u32 flags);
196 int osc_quota_chkdq(struct client_obd *cli, const unsigned int qid[]);
197 int osc_quotactl(struct obd_device *unused, struct obd_export *exp,
198 struct obd_quotactl *oqctl);
199 int osc_quotacheck(struct obd_device *unused, struct obd_export *exp,
200 struct obd_quotactl *oqctl);
201 int osc_quota_poll_check(struct obd_export *exp, struct if_quotacheck *qchk);
202
203 #endif /* OSC_INTERNAL_H */
204