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, 2016, 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 <lustre_osc.h>
40 extern atomic_t osc_pool_req_count;
41 extern unsigned int osc_reqpool_maxreqcount;
42 extern struct ptlrpc_request_pool *osc_rq_pool;
44 void osc_wake_cache_waiters(struct client_obd *cli);
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);
49 extern struct ptlrpc_request_set *PTLRPCD_SET;
51 typedef int (*osc_enqueue_upcall_f)(void *cookie, struct lustre_handle *lockh,
54 int osc_enqueue_base(struct obd_export *exp, struct ldlm_res_id *res_id,
55 __u64 *flags, union ldlm_policy_data *policy,
56 struct ost_lvb *lvb, int kms_valid,
57 osc_enqueue_upcall_f upcall,
58 void *cookie, struct ldlm_enqueue_info *einfo,
59 struct ptlrpc_request_set *rqset, int async,
62 int osc_match_base(struct obd_export *exp, struct ldlm_res_id *res_id,
63 enum ldlm_type type, union ldlm_policy_data *policy,
64 enum ldlm_mode mode, __u64 *flags, void *data,
65 struct lustre_handle *lockh, int unref);
67 int osc_setattr_async(struct obd_export *exp, struct obdo *oa,
68 obd_enqueue_update_f upcall, void *cookie,
69 struct ptlrpc_request_set *rqset);
70 int osc_punch_base(struct obd_export *exp, struct obdo *oa,
71 obd_enqueue_update_f upcall, void *cookie,
72 struct ptlrpc_request_set *rqset);
73 int osc_sync_base(struct osc_object *obj, struct obdo *oa,
74 obd_enqueue_update_f upcall, void *cookie,
75 struct ptlrpc_request_set *rqset);
76 int osc_ladvise_base(struct obd_export *exp, struct obdo *oa,
77 struct ladvise_hdr *ladvise_hdr,
78 obd_enqueue_update_f upcall, void *cookie,
79 struct ptlrpc_request_set *rqset);
80 int osc_process_config_base(struct obd_device *obd, struct lustre_cfg *cfg);
81 int osc_build_rpc(const struct lu_env *env, struct client_obd *cli,
82 struct list_head *ext_list, int cmd);
83 long osc_lru_shrink(const struct lu_env *env, struct client_obd *cli,
84 long target, bool force);
85 unsigned long osc_lru_reserve(struct client_obd *cli, unsigned long npages);
86 void osc_lru_unreserve(struct client_obd *cli, unsigned long npages);
88 extern struct lu_kmem_descr osc_caches[];
90 unsigned long osc_ldlm_weigh_ast(struct ldlm_lock *dlmlock);
92 int osc_cleanup(struct obd_device *obd);
93 int osc_setup(struct obd_device *obd, struct lustre_cfg *lcfg);
96 extern struct lprocfs_vars lprocfs_osc_obd_vars[];
97 int lproc_osc_attach_seqstat(struct obd_device *dev);
99 static inline int lproc_osc_attach_seqstat(struct obd_device *dev) {return 0;}
102 extern struct lu_device_type osc_device_type;
104 static inline int osc_is_object(const struct lu_object *obj)
106 return obj->lo_dev->ld_type == &osc_device_type;
109 static inline struct osc_lock *osc_lock_at(const struct cl_lock *lock)
111 return cl2osc_lock(cl_lock_at(lock, &osc_device_type));
114 int osc_lock_init(const struct lu_env *env, struct cl_object *obj,
115 struct cl_lock *lock, const struct cl_io *io);
116 int osc_io_init(const struct lu_env *env, struct cl_object *obj,
118 struct lu_object *osc_object_alloc(const struct lu_env *env,
119 const struct lu_object_header *hdr,
120 struct lu_device *dev);
122 static inline int osc_recoverable_error(int rc)
124 return (rc == -EIO || rc == -EROFS || rc == -ENOMEM ||
125 rc == -EAGAIN || rc == -EINPROGRESS);
128 static inline unsigned long rpcs_in_flight(struct client_obd *cli)
130 return cli->cl_r_in_flight + cli->cl_w_in_flight;
133 static inline char *cli_name(struct client_obd *cli)
135 return cli->cl_import->imp_obd->obd_name;
139 #define min_t(type,x,y) \
140 ({ type __x = (x); type __y = (y); __x < __y ? __x: __y; })
143 struct osc_async_args {
144 struct obd_info *aa_oi;
147 int osc_quota_setup(struct obd_device *obd);
148 int osc_quota_cleanup(struct obd_device *obd);
149 int osc_quota_setdq(struct client_obd *cli, const unsigned int qid[],
150 u64 valid, u32 flags);
151 int osc_quota_chkdq(struct client_obd *cli, const unsigned int qid[]);
152 int osc_quotactl(struct obd_device *unused, struct obd_export *exp,
153 struct obd_quotactl *oqctl);
154 void osc_inc_unstable_pages(struct ptlrpc_request *req);
155 void osc_dec_unstable_pages(struct ptlrpc_request *req);
156 bool osc_over_unstable_soft_limit(struct client_obd *cli);
158 * Bit flags for osc_dlm_lock_at_pageoff().
162 * Just check if the desired lock exists, it won't hold reference
165 OSC_DAP_FL_TEST_LOCK = 1 << 0,
167 * Return the lock even if it is being canceled.
169 OSC_DAP_FL_CANCELING = 1 << 1
171 struct ldlm_lock *osc_dlmlock_at_pgoff(const struct lu_env *env,
172 struct osc_object *obj, pgoff_t index,
173 enum osc_dap_flags flags);
174 void osc_pack_req_body(struct ptlrpc_request *req, struct obdo *oa);
175 int osc_object_invalidate(const struct lu_env *env, struct osc_object *osc);
177 /** osc shrink list to link all osc client obd */
178 extern struct list_head osc_shrink_list;
179 /** spin lock to protect osc_shrink_list */
180 extern spinlock_t osc_shrink_lock;
181 extern unsigned long osc_cache_shrink_count(struct shrinker *sk,
182 struct shrink_control *sc);
183 extern unsigned long osc_cache_shrink_scan(struct shrinker *sk,
184 struct shrink_control *sc);
186 #endif /* OSC_INTERNAL_H */