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