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.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2011, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
33 #ifndef OSC_INTERNAL_H
34 #define OSC_INTERNAL_H
36 #define OAP_MAGIC 8675309
38 #include <libcfs/linux/linux-mem.h>
39 #include <lustre_osc.h>
41 extern atomic_t osc_pool_req_count;
42 extern unsigned int osc_reqpool_maxreqcount;
43 extern struct ptlrpc_request_pool *osc_rq_pool;
45 void osc_wake_cache_waiters(struct client_obd *cli);
46 int osc_shrink_grant_to_target(struct client_obd *cli, __u64 target_bytes);
47 void osc_schedule_grant_work(void);
48 void osc_update_next_shrink(struct client_obd *cli);
49 int lru_queue_work(const struct lu_env *env, void *data);
50 int osc_extent_finish(const struct lu_env *env, struct osc_extent *ext,
52 int osc_extent_release(const struct lu_env *env, struct osc_extent *ext);
53 int osc_lock_discard_pages(const struct lu_env *env, struct osc_object *osc,
54 pgoff_t start, pgoff_t end, bool discard);
56 extern struct ptlrpc_request_set *PTLRPCD_SET;
58 int osc_enqueue_base(struct obd_export *exp, struct ldlm_res_id *res_id,
59 __u64 *flags, union ldlm_policy_data *policy,
60 struct ost_lvb *lvb, int kms_valid,
61 osc_enqueue_upcall_f upcall,
62 void *cookie, struct ldlm_enqueue_info *einfo,
63 struct ptlrpc_request_set *rqset, int async,
66 int osc_match_base(struct obd_export *exp, struct ldlm_res_id *res_id,
67 enum ldlm_type type, union ldlm_policy_data *policy,
68 enum ldlm_mode mode, __u64 *flags, void *data,
69 struct lustre_handle *lockh, int unref);
71 int osc_setattr_async(struct obd_export *exp, struct obdo *oa,
72 obd_enqueue_update_f upcall, void *cookie,
73 struct ptlrpc_request_set *rqset);
74 int osc_sync_base(struct osc_object *obj, struct obdo *oa,
75 obd_enqueue_update_f upcall, void *cookie,
76 struct ptlrpc_request_set *rqset);
77 int osc_ladvise_base(struct obd_export *exp, struct obdo *oa,
78 struct ladvise_hdr *ladvise_hdr,
79 obd_enqueue_update_f upcall, void *cookie,
80 struct ptlrpc_request_set *rqset);
81 int osc_process_config_base(struct obd_device *obd, struct lustre_cfg *cfg);
82 int osc_build_rpc(const struct lu_env *env, struct client_obd *cli,
83 struct list_head *ext_list, int cmd);
84 unsigned long osc_lru_reserve(struct client_obd *cli, unsigned long npages);
85 void osc_lru_unreserve(struct client_obd *cli, unsigned long npages);
87 extern struct lu_kmem_descr osc_caches[];
89 unsigned long osc_ldlm_weigh_ast(struct ldlm_lock *dlmlock);
91 int osc_cleanup(struct obd_device *obd);
92 int osc_setup(struct obd_device *obd, struct lustre_cfg *lcfg);
94 int osc_tunables_init(struct obd_device *obd);
96 extern struct lu_device_type osc_device_type;
98 static inline struct cl_io *osc_env_thread_io(const struct lu_env *env)
100 struct cl_io *io = &osc_env_info(env)->oti_io;
102 memset(io, 0, sizeof(*io));
106 static inline int osc_is_object(const struct lu_object *obj)
108 return obj->lo_dev->ld_type == &osc_device_type;
111 static inline struct osc_lock *osc_lock_at(const struct cl_lock *lock)
113 return cl2osc_lock(cl_lock_at(lock, &osc_device_type));
116 int osc_lock_init(const struct lu_env *env, struct cl_object *obj,
117 struct cl_lock *lock, const struct cl_io *io);
118 int osc_io_init(const struct lu_env *env, struct cl_object *obj,
120 struct lu_object *osc_object_alloc(const struct lu_env *env,
121 const struct lu_object_header *hdr,
122 struct lu_device *dev);
124 static inline int osc_recoverable_error(int rc)
126 return (rc == -EIO || rc == -EROFS || rc == -ENOMEM ||
127 rc == -EAGAIN || rc == -EINPROGRESS);
130 static inline unsigned long rpcs_in_flight(struct client_obd *cli)
132 return cli->cl_r_in_flight + cli->cl_w_in_flight;
135 static inline char *cli_name(struct client_obd *cli)
137 return cli->cl_import->imp_obd->obd_name;
141 #define min_t(type,x,y) \
142 ({ type __x = (x); type __y = (y); __x < __y ? __x: __y; })
145 struct osc_async_args {
146 struct obd_info *aa_oi;
149 int osc_quota_setup(struct obd_device *obd);
150 int osc_quota_cleanup(struct obd_device *obd);
151 int osc_quota_setdq(struct client_obd *cli, __u64 xid, const unsigned int qid[],
152 u64 valid, u32 flags);
153 int osc_quota_chkdq(struct client_obd *cli, const unsigned int qid[]);
154 int osc_quotactl(struct obd_device *unused, struct obd_export *exp,
155 struct obd_quotactl *oqctl);
156 void osc_inc_unstable_pages(struct ptlrpc_request *req);
157 void osc_dec_unstable_pages(struct ptlrpc_request *req);
158 bool osc_over_unstable_soft_limit(struct client_obd *cli);
159 void osc_page_touch_at(const struct lu_env *env, struct cl_object *obj,
160 pgoff_t idx, size_t to);
162 struct ldlm_lock *osc_obj_dlmlock_at_pgoff(const struct lu_env *env,
163 struct osc_object *obj,
165 enum osc_dap_flags flags);
167 int osc_object_invalidate(const struct lu_env *env, struct osc_object *osc);
169 /** osc shrink list to link all osc client obd */
170 extern struct list_head osc_shrink_list;
171 /** spin lock to protect osc_shrink_list */
172 extern spinlock_t osc_shrink_lock;
173 extern unsigned long osc_cache_shrink_count(struct shrinker *sk,
174 struct shrink_control *sc);
175 extern unsigned long osc_cache_shrink_scan(struct shrinker *sk,
176 struct shrink_control *sc);
177 static inline unsigned int osc_max_write_chunks(const struct client_obd *cli)
182 * The maximum size of a single transaction is about 64MB in ZFS.
183 * #define DMU_MAX_ACCESS (64 * 1024 * 1024)
185 * Since ZFS is a copy-on-write file system, a single dirty page in
186 * a chunk will result in the rewrite of the whole chunk, therefore
187 * an RPC shouldn't be allowed to contain too many chunks otherwise
188 * it will make transaction size much bigger than 64MB, especially
189 * with big block size for ZFS.
191 * This piece of code is to make sure that OSC won't send write RPCs
192 * with too many chunks. The maximum chunk size that an RPC can cover
193 * is set to PTLRPC_MAX_BRW_SIZE, which is defined to 16MB. Ideally
194 * OST should tell the client what the biggest transaction size is,
195 * but it's good enough for now.
197 * This limitation doesn't apply to ldiskfs, which allows as many
198 * chunks in one RPC as we want. However, it won't have any benefits
199 * to have too many discontiguous pages in one RPC.
201 * An osc_extent won't cover over a RPC size, so the chunks in an
202 * osc_extent won't bigger than PTLRPC_MAX_BRW_SIZE >> chunkbits.
204 return PTLRPC_MAX_BRW_SIZE >> cli->cl_chunkbits;
207 static inline void osc_set_io_portal(struct ptlrpc_request *req)
209 struct obd_import *imp = req->rq_import;
211 /* Distinguish OSC from MDC here to use OST or MDS portal */
212 if (OCD_HAS_FLAG(&imp->imp_connect_data, IBITS))
213 req->rq_request_portal = MDS_IO_PORTAL;
215 req->rq_request_portal = OST_IO_PORTAL;
217 #endif /* OSC_INTERNAL_H */