Whamcloud - gitweb
LU-14541 llite: Check vmpage in releasepage
[fs/lustre-release.git] / lustre / osc / osc_internal.h
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.gnu.org/licenses/gpl-2.0.html
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2011, 2017, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  */
31
32 #ifndef OSC_INTERNAL_H
33 #define OSC_INTERNAL_H
34
35 #define OAP_MAGIC 8675309
36
37 #include <libcfs/linux/linux-mem.h>
38 #include <lustre_osc.h>
39
40 extern atomic_t osc_pool_req_count;
41 extern unsigned int osc_reqpool_maxreqcount;
42 extern struct ptlrpc_request_pool *osc_rq_pool;
43
44 int osc_shrink_grant_to_target(struct client_obd *cli, __u64 target_bytes);
45 void osc_schedule_grant_work(void);
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,
49                       int sent, int rc);
50 void 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);
53
54 void osc_lock_lvb_update(const struct lu_env *env,
55                          struct osc_object *osc,
56                          struct ldlm_lock *dlmlock,
57                          struct ost_lvb *lvb);
58
59 int osc_enqueue_base(struct obd_export *exp, struct ldlm_res_id *res_id,
60                      __u64 *flags, union ldlm_policy_data *policy,
61                      struct ost_lvb *lvb, osc_enqueue_upcall_f upcall,
62                      void *cookie, struct ldlm_enqueue_info *einfo,
63                      struct ptlrpc_request_set *rqset, int async,
64                      bool speculative);
65
66 int osc_match_base(const struct lu_env *env, struct obd_export *exp,
67                    struct ldlm_res_id *res_id, enum ldlm_type type,
68                    union ldlm_policy_data *policy, enum ldlm_mode mode,
69                    __u64 *flags, struct osc_object *obj,
70                    struct lustre_handle *lockh, enum ldlm_match_flags match_flags);
71
72 int osc_setattr_async(struct obd_export *exp, struct obdo *oa,
73                       obd_enqueue_update_f upcall, void *cookie,
74                       struct ptlrpc_request_set *rqset);
75 int osc_fallocate_base(struct obd_export *exp, struct obdo *oa,
76                        obd_enqueue_update_f upcall, void *cookie,
77                        int mode);
78 int osc_sync_base(struct osc_object *obj, struct obdo *oa,
79                   obd_enqueue_update_f upcall, void *cookie,
80                   struct ptlrpc_request_set *rqset);
81 int osc_ladvise_base(struct obd_export *exp, struct obdo *oa,
82                      struct ladvise_hdr *ladvise_hdr,
83                      obd_enqueue_update_f upcall, void *cookie,
84                      struct ptlrpc_request_set *rqset);
85 int osc_process_config_base(struct obd_device *obd, struct lustre_cfg *cfg);
86 int osc_build_rpc(const struct lu_env *env, struct client_obd *cli,
87                   struct list_head *ext_list, int cmd);
88 void osc_send_empty_rpc(struct osc_object *osc, pgoff_t start);
89 unsigned long osc_lru_reserve(struct client_obd *cli, unsigned long npages);
90 void osc_lru_unreserve(struct client_obd *cli, unsigned long npages);
91
92 extern struct lu_kmem_descr osc_caches[];
93
94 unsigned long osc_ldlm_weigh_ast(struct ldlm_lock *dlmlock);
95
96 int osc_setup(struct obd_device *obd, struct lustre_cfg *lcfg);
97
98 int osc_tunables_init(struct obd_device *obd);
99
100 extern struct lu_device_type osc_device_type;
101
102 static inline struct cl_io *osc_env_thread_io(const struct lu_env *env)
103 {
104         struct cl_io *io = &osc_env_info(env)->oti_io;
105
106         memset(io, 0, sizeof(*io));
107         return io;
108 }
109
110 static inline int osc_is_object(const struct lu_object *obj)
111 {
112         return obj->lo_dev->ld_type == &osc_device_type;
113 }
114
115 static inline struct osc_lock *osc_lock_at(const struct cl_lock *lock)
116 {
117         return cl2osc_lock(cl_lock_at(lock, &osc_device_type));
118 }
119
120 int osc_lock_init(const struct lu_env *env, struct cl_object *obj,
121                   struct cl_lock *lock, const struct cl_io *io);
122 int osc_io_init(const struct lu_env *env, struct cl_object *obj,
123                 struct cl_io *io);
124 struct lu_object *osc_object_alloc(const struct lu_env *env,
125                                    const struct lu_object_header *hdr,
126                                    struct lu_device *dev);
127
128 static inline int osc_recoverable_error(int rc)
129 {
130         return (rc == -EIO || rc == -EROFS || rc == -ENOMEM ||
131                 rc == -EAGAIN || rc == -EINPROGRESS);
132 }
133
134 static inline unsigned long rpcs_in_flight(struct client_obd *cli)
135 {
136         return cli->cl_r_in_flight + cli->cl_w_in_flight;
137 }
138
139 static inline char *cli_name(struct client_obd *cli)
140 {
141         return cli->cl_import->imp_obd->obd_name;
142 }
143
144 static inline char list_empty_marker(struct list_head *list)
145 {
146         return list_empty(list) ? '-' : '+';
147 }
148
149 struct osc_async_args {
150         struct obd_info *aa_oi;
151 };
152
153 int osc_quota_setup(struct obd_device *obd);
154 int osc_quota_cleanup(struct obd_device *obd);
155 int osc_quota_setdq(struct client_obd *cli, __u64 xid, const unsigned int qid[],
156                     u64 valid, u32 flags);
157 int osc_quota_chkdq(struct client_obd *cli, const unsigned int qid[]);
158 int osc_quotactl(struct obd_device *unused, struct obd_export *exp,
159                  struct obd_quotactl *oqctl);
160 void osc_inc_unstable_pages(struct ptlrpc_request *req);
161 void osc_dec_unstable_pages(struct ptlrpc_request *req);
162 bool osc_over_unstable_soft_limit(struct client_obd *cli);
163 void osc_page_touch_at(const struct lu_env *env, struct cl_object *obj,
164                        pgoff_t idx, size_t to);
165
166 struct ldlm_lock *osc_obj_dlmlock_at_pgoff(const struct lu_env *env,
167                                            struct osc_object *obj,
168                                            pgoff_t index,
169                                            enum osc_dap_flags flags);
170
171 int osc_object_invalidate(const struct lu_env *env, struct osc_object *osc);
172
173 /** osc shrink list to link all osc client obd */
174 extern struct list_head osc_shrink_list;
175 /** spin lock to protect osc_shrink_list */
176 extern spinlock_t osc_shrink_lock;
177 extern unsigned long osc_cache_shrink_count(struct shrinker *sk,
178                                             struct shrink_control *sc);
179 extern unsigned long osc_cache_shrink_scan(struct shrinker *sk,
180                                            struct shrink_control *sc);
181 static inline unsigned int osc_max_write_chunks(const struct client_obd *cli)
182 {
183         /*
184          * LU-8135:
185          *
186          * The maximum size of a single transaction is about 64MB in ZFS.
187          * #define DMU_MAX_ACCESS (64 * 1024 * 1024)
188          *
189          * Since ZFS is a copy-on-write file system, a single dirty page in
190          * a chunk will result in the rewrite of the whole chunk, therefore
191          * an RPC shouldn't be allowed to contain too many chunks otherwise
192          * it will make transaction size much bigger than 64MB, especially
193          * with big block size for ZFS.
194          *
195          * This piece of code is to make sure that OSC won't send write RPCs
196          * with too many chunks. The maximum chunk size that an RPC can cover
197          * is set to PTLRPC_MAX_BRW_SIZE, which is defined to 16MB. Ideally
198          * OST should tell the client what the biggest transaction size is,
199          * but it's good enough for now.
200          *
201          * This limitation doesn't apply to ldiskfs, which allows as many
202          * chunks in one RPC as we want. However, it won't have any benefits
203          * to have too many discontiguous pages in one RPC.
204          *
205          * An osc_extent won't cover over a RPC size, so the chunks in an
206          * osc_extent won't bigger than PTLRPC_MAX_BRW_SIZE >> chunkbits.
207          */
208         return PTLRPC_MAX_BRW_SIZE >> cli->cl_chunkbits;
209 }
210
211 static inline void osc_set_io_portal(struct ptlrpc_request *req)
212 {
213         struct obd_import *imp = req->rq_import;
214
215         /* Distinguish OSC from MDC here to use OST or MDS portal */
216         if (OCD_HAS_FLAG(&imp->imp_connect_data, IBITS))
217                 req->rq_request_portal = MDS_IO_PORTAL;
218         else
219                 req->rq_request_portal = OST_IO_PORTAL;
220 }
221
222 #endif /* OSC_INTERNAL_H */