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);
48 extern struct ptlrpc_request_set *PTLRPCD_SET;
50 typedef int (*osc_enqueue_upcall_f)(void *cookie, struct lustre_handle *lockh,
53 int osc_enqueue_base(struct obd_export *exp, struct ldlm_res_id *res_id,
54 __u64 *flags, union ldlm_policy_data *policy,
55 struct ost_lvb *lvb, int kms_valid,
56 osc_enqueue_upcall_f upcall,
57 void *cookie, struct ldlm_enqueue_info *einfo,
58 struct ptlrpc_request_set *rqset, int async, int agl);
60 int osc_match_base(struct obd_export *exp, struct ldlm_res_id *res_id,
61 enum ldlm_type type, union ldlm_policy_data *policy,
62 enum ldlm_mode mode, __u64 *flags, void *data,
63 struct lustre_handle *lockh, int unref);
65 int osc_setattr_async(struct obd_export *exp, struct obdo *oa,
66 obd_enqueue_update_f upcall, void *cookie,
67 struct ptlrpc_request_set *rqset);
68 int osc_punch_base(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 long osc_lru_shrink(const struct lu_env *env, struct client_obd *cli,
82 long target, bool force);
83 unsigned long osc_lru_reserve(struct client_obd *cli, unsigned long npages);
84 void osc_lru_unreserve(struct client_obd *cli, unsigned long npages);
86 extern struct lu_kmem_descr osc_caches[];
88 unsigned long osc_ldlm_weigh_ast(struct ldlm_lock *dlmlock);
90 int osc_cleanup(struct obd_device *obd);
91 int osc_setup(struct obd_device *obd, struct lustre_cfg *lcfg);
94 extern struct lprocfs_vars lprocfs_osc_obd_vars[];
95 int lproc_osc_attach_seqstat(struct obd_device *dev);
97 static inline int lproc_osc_attach_seqstat(struct obd_device *dev) {return 0;}
100 extern struct lu_device_type osc_device_type;
102 static inline int osc_is_object(const struct lu_object *obj)
104 return obj->lo_dev->ld_type == &osc_device_type;
107 static inline struct osc_lock *osc_lock_at(const struct cl_lock *lock)
109 return cl2osc_lock(cl_lock_at(lock, &osc_device_type));
112 int osc_lock_init(const struct lu_env *env, struct cl_object *obj,
113 struct cl_lock *lock, const struct cl_io *io);
114 int osc_io_init(const struct lu_env *env, struct cl_object *obj,
116 struct lu_object *osc_object_alloc(const struct lu_env *env,
117 const struct lu_object_header *hdr,
118 struct lu_device *dev);
120 static inline int osc_recoverable_error(int rc)
122 return (rc == -EIO || rc == -EROFS || rc == -ENOMEM ||
123 rc == -EAGAIN || rc == -EINPROGRESS);
126 static inline unsigned long rpcs_in_flight(struct client_obd *cli)
128 return cli->cl_r_in_flight + cli->cl_w_in_flight;
131 static inline char *cli_name(struct client_obd *cli)
133 return cli->cl_import->imp_obd->obd_name;
137 #define min_t(type,x,y) \
138 ({ type __x = (x); type __y = (y); __x < __y ? __x: __y; })
141 struct osc_async_args {
142 struct obd_info *aa_oi;
145 int osc_quota_setup(struct obd_device *obd);
146 int osc_quota_cleanup(struct obd_device *obd);
147 int osc_quota_setdq(struct client_obd *cli, const unsigned int qid[],
148 u64 valid, u32 flags);
149 int osc_quota_chkdq(struct client_obd *cli, const unsigned int qid[]);
150 int osc_quotactl(struct obd_device *unused, struct obd_export *exp,
151 struct obd_quotactl *oqctl);
152 void osc_inc_unstable_pages(struct ptlrpc_request *req);
153 void osc_dec_unstable_pages(struct ptlrpc_request *req);
154 bool osc_over_unstable_soft_limit(struct client_obd *cli);
156 * Bit flags for osc_dlm_lock_at_pageoff().
160 * Just check if the desired lock exists, it won't hold reference
163 OSC_DAP_FL_TEST_LOCK = 1 << 0,
165 * Return the lock even if it is being canceled.
167 OSC_DAP_FL_CANCELING = 1 << 1
169 struct ldlm_lock *osc_dlmlock_at_pgoff(const struct lu_env *env,
170 struct osc_object *obj, pgoff_t index,
171 enum osc_dap_flags flags);
172 void osc_pack_req_body(struct ptlrpc_request *req, struct obdo *oa);
173 int osc_object_invalidate(const struct lu_env *env, struct osc_object *osc);
175 /** osc shrink list to link all osc client obd */
176 extern struct list_head osc_shrink_list;
177 /** spin lock to protect osc_shrink_list */
178 extern spinlock_t osc_shrink_lock;
179 extern unsigned long osc_cache_shrink_count(struct shrinker *sk,
180 struct shrink_control *sc);
181 extern unsigned long osc_cache_shrink_scan(struct shrinker *sk,
182 struct shrink_control *sc);
184 #endif /* OSC_INTERNAL_H */