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 int osc_shrink_grant_to_target(struct client_obd *cli, __u64 target_bytes);
46 void osc_update_next_shrink(struct client_obd *cli);
47 int lru_queue_work(const struct lu_env *env, void *data);
48 int osc_extent_finish(const struct lu_env *env, struct osc_extent *ext,
50 int osc_extent_release(const struct lu_env *env, struct osc_extent *ext);
51 int osc_lock_discard_pages(const struct lu_env *env, struct osc_object *osc,
52 pgoff_t start, pgoff_t end, bool discard);
54 extern struct ptlrpc_request_set *PTLRPCD_SET;
56 int osc_enqueue_base(struct obd_export *exp, struct ldlm_res_id *res_id,
57 __u64 *flags, union ldlm_policy_data *policy,
58 struct ost_lvb *lvb, osc_enqueue_upcall_f upcall,
59 void *cookie, struct ldlm_enqueue_info *einfo,
60 struct ptlrpc_request_set *rqset, int async,
63 int osc_match_base(struct obd_export *exp, struct ldlm_res_id *res_id,
64 enum ldlm_type type, union ldlm_policy_data *policy,
65 enum ldlm_mode mode, __u64 *flags, void *data,
66 struct lustre_handle *lockh, int unref);
68 int osc_setattr_async(struct obd_export *exp, struct obdo *oa,
69 obd_enqueue_update_f upcall, void *cookie,
70 struct ptlrpc_request_set *rqset);
71 int osc_sync_base(struct osc_object *obj, struct obdo *oa,
72 obd_enqueue_update_f upcall, void *cookie,
73 struct ptlrpc_request_set *rqset);
74 int osc_ladvise_base(struct obd_export *exp, struct obdo *oa,
75 struct ladvise_hdr *ladvise_hdr,
76 obd_enqueue_update_f upcall, void *cookie,
77 struct ptlrpc_request_set *rqset);
78 int osc_process_config_base(struct obd_device *obd, struct lustre_cfg *cfg);
79 int osc_build_rpc(const struct lu_env *env, struct client_obd *cli,
80 struct list_head *ext_list, int cmd);
81 unsigned long osc_lru_reserve(struct client_obd *cli, unsigned long npages);
82 void osc_lru_unreserve(struct client_obd *cli, unsigned long npages);
84 extern struct lu_kmem_descr osc_caches[];
86 unsigned long osc_ldlm_weigh_ast(struct ldlm_lock *dlmlock);
88 int osc_cleanup(struct obd_device *obd);
89 int osc_setup(struct obd_device *obd, struct lustre_cfg *lcfg);
91 int osc_tunables_init(struct obd_device *obd);
93 extern struct lu_device_type osc_device_type;
95 static inline struct cl_io *osc_env_thread_io(const struct lu_env *env)
97 struct cl_io *io = &osc_env_info(env)->oti_io;
99 memset(io, 0, sizeof(*io));
103 static inline int osc_is_object(const struct lu_object *obj)
105 return obj->lo_dev->ld_type == &osc_device_type;
108 static inline struct osc_lock *osc_lock_at(const struct cl_lock *lock)
110 return cl2osc_lock(cl_lock_at(lock, &osc_device_type));
113 int osc_lock_init(const struct lu_env *env, struct cl_object *obj,
114 struct cl_lock *lock, const struct cl_io *io);
115 int osc_io_init(const struct lu_env *env, struct cl_object *obj,
117 struct lu_object *osc_object_alloc(const struct lu_env *env,
118 const struct lu_object_header *hdr,
119 struct lu_device *dev);
121 static inline int osc_recoverable_error(int rc)
123 return (rc == -EIO || rc == -EROFS || rc == -ENOMEM ||
124 rc == -EAGAIN || rc == -EINPROGRESS);
127 static inline unsigned long rpcs_in_flight(struct client_obd *cli)
129 return cli->cl_r_in_flight + cli->cl_w_in_flight;
132 static inline char *cli_name(struct client_obd *cli)
134 return cli->cl_import->imp_obd->obd_name;
138 #define min_t(type,x,y) \
139 ({ type __x = (x); type __y = (y); __x < __y ? __x: __y; })
142 struct osc_async_args {
143 struct obd_info *aa_oi;
146 int osc_quota_setup(struct obd_device *obd);
147 int osc_quota_cleanup(struct obd_device *obd);
148 int osc_quota_setdq(struct client_obd *cli, __u64 xid, const unsigned int qid[],
149 u64 valid, u32 flags);
150 int osc_quota_chkdq(struct client_obd *cli, const unsigned int qid[]);
151 int osc_quotactl(struct obd_device *unused, struct obd_export *exp,
152 struct obd_quotactl *oqctl);
153 void osc_inc_unstable_pages(struct ptlrpc_request *req);
154 void osc_dec_unstable_pages(struct ptlrpc_request *req);
155 bool osc_over_unstable_soft_limit(struct client_obd *cli);
156 void osc_page_touch_at(const struct lu_env *env, struct cl_object *obj,
157 pgoff_t idx, size_t to);
159 struct ldlm_lock *osc_obj_dlmlock_at_pgoff(const struct lu_env *env,
160 struct osc_object *obj,
162 enum osc_dap_flags flags);
164 int osc_object_invalidate(const struct lu_env *env, struct osc_object *osc);
166 /** osc shrink list to link all osc client obd */
167 extern struct list_head osc_shrink_list;
168 /** spin lock to protect osc_shrink_list */
169 extern spinlock_t osc_shrink_lock;
170 extern unsigned long osc_cache_shrink_count(struct shrinker *sk,
171 struct shrink_control *sc);
172 extern unsigned long osc_cache_shrink_scan(struct shrinker *sk,
173 struct shrink_control *sc);
175 static inline void osc_set_io_portal(struct ptlrpc_request *req)
177 struct obd_import *imp = req->rq_import;
179 /* Distinguish OSC from MDC here to use OST or MDS portal */
180 if (OCD_HAS_FLAG(&imp->imp_connect_data, IBITS))
181 req->rq_request_portal = MDS_IO_PORTAL;
183 req->rq_request_portal = OST_IO_PORTAL;
185 #endif /* OSC_INTERNAL_H */