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, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 021110-1307, USA
24 * Copyright (c) 2012, 2015, Intel Corporation.
25 * Use is subject to license terms.
27 * Author: Johann Lombardi <johann.lombardi@intel.com>
28 * Author: Niu Yawei <yawei.niu@intel.com>
31 #define DEBUG_SUBSYSTEM S_LQUOTA
33 #include <linux/version.h>
34 #include <linux/module.h>
35 #include <linux/init.h>
37 #include "lquota_internal.h"
39 struct kmem_cache *lqe_kmem;
41 struct lu_kmem_descr lquota_caches[] = {
43 .ckd_cache = &lqe_kmem,
44 .ckd_name = "lqe_kmem",
45 .ckd_size = sizeof(struct lquota_entry)
52 /* register lquota key */
53 LU_KEY_INIT_FINI(lquota, struct lquota_thread_info);
54 LU_CONTEXT_KEY_DEFINE(lquota, LCT_MD_THREAD | LCT_DT_THREAD | LCT_LOCAL);
55 LU_KEY_INIT_GENERIC(lquota);
58 * Look-up accounting object to collect space usage information for user
61 * \param env - is the environment passed by the caller
62 * \param dev - is the dt_device storing the accounting object
63 * \param type - is the quota type, either USRQUOTA or GRPQUOTA
65 struct dt_object *acct_obj_lookup(const struct lu_env *env,
66 struct dt_device *dev, int type)
68 struct lquota_thread_info *qti = lquota_info(env);
69 struct dt_object *obj = NULL;
72 lu_local_obj_fid(&qti->qti_fid,
73 type == USRQUOTA ? ACCT_USER_OID : ACCT_GROUP_OID);
75 /* lookup the accounting object */
76 obj = dt_locate(env, dev, &qti->qti_fid);
80 if (!dt_object_exists(obj)) {
81 lu_object_put(env, &obj->do_lu);
82 RETURN(ERR_PTR(-ENOENT));
85 if (obj->do_index_ops == NULL) {
88 /* set up indexing operations */
89 rc = obj->do_ops->do_index_try(env, obj, &dt_acct_features);
91 CERROR("%s: failed to set up indexing operations for %s"
92 " acct object rc:%d\n",
93 dev->dd_lu_dev.ld_obd->obd_name,
94 QTYPE_NAME(type), rc);
95 lu_object_put(env, &obj->do_lu);
103 * Initialize slave index object to collect local quota limit for user or group.
105 * \param env - is the environment passed by the caller
106 * \param dev - is the dt_device storing the slave index object
107 * \param type - is the quota type, either USRQUOTA or GRPQUOTA
109 static struct dt_object *quota_obj_lookup(const struct lu_env *env,
110 struct dt_device *dev, int type)
112 struct lquota_thread_info *qti = lquota_info(env);
113 struct dt_object *obj = NULL;
116 qti->qti_fid.f_seq = FID_SEQ_QUOTA;
117 qti->qti_fid.f_oid = type == USRQUOTA ? LQUOTA_USR_OID : LQUOTA_GRP_OID;
118 qti->qti_fid.f_ver = 0;
120 /* lookup the quota object */
121 obj = dt_locate(env, dev, &qti->qti_fid);
125 if (!dt_object_exists(obj)) {
126 lu_object_put(env, &obj->do_lu);
127 RETURN(ERR_PTR(-ENOENT));
130 if (obj->do_index_ops == NULL) {
133 /* set up indexing operations */
134 rc = obj->do_ops->do_index_try(env, obj,
135 &dt_quota_slv_features);
137 CERROR("%s: failed to set up indexing operations for %s"
138 " slave index object rc:%d\n",
139 dev->dd_lu_dev.ld_obd->obd_name,
140 QTYPE_NAME(type), rc);
141 lu_object_put(env, &obj->do_lu);
149 * Helper routine to retrieve slave information.
150 * This function converts a quotactl request into quota/accounting object
151 * operations. It is independant of the slave stack which is only accessible
152 * from the OSD layer.
154 * \param env - is the environment passed by the caller
155 * \param dev - is the dt_device this quotactl is executed on
156 * \param oqctl - is the quotactl request
158 int lquotactl_slv(const struct lu_env *env, struct dt_device *dev,
159 struct obd_quotactl *oqctl)
161 struct lquota_thread_info *qti = lquota_info(env);
163 struct dt_object *obj;
164 struct obd_dqblk *dqblk = &oqctl->qc_dqblk;
168 if (oqctl->qc_cmd != Q_GETOQUOTA) {
169 /* as in many other places, dev->dd_lu_dev.ld_obd->obd_name
170 * point to an invalid obd_name, to be fixed in LU-1574 */
171 CERROR("%s: Unsupported quotactl command: %x\n",
172 dev->dd_lu_dev.ld_obd->obd_name, oqctl->qc_cmd);
176 if (oqctl->qc_type != USRQUOTA && oqctl->qc_type != GRPQUOTA)
177 /* no support for directory quota yet */
180 /* qc_id is a 32-bit field while a key has 64 bits */
183 /* Step 1: collect accounting information */
185 obj = acct_obj_lookup(env, dev, oqctl->qc_type);
188 if (obj->do_index_ops == NULL)
189 GOTO(out, rc = -EINVAL);
191 /* lookup record storing space accounting information for this ID */
192 rc = dt_lookup(env, obj, (struct dt_rec *)&qti->qti_acct_rec,
193 (struct dt_key *)&key);
197 memset(&oqctl->qc_dqblk, 0, sizeof(struct obd_dqblk));
198 dqblk->dqb_curspace = qti->qti_acct_rec.bspace;
199 dqblk->dqb_curinodes = qti->qti_acct_rec.ispace;
200 dqblk->dqb_valid = QIF_USAGE;
202 lu_object_put(env, &obj->do_lu);
204 /* Step 2: collect enforcement information */
206 obj = quota_obj_lookup(env, dev, oqctl->qc_type);
209 if (obj->do_index_ops == NULL)
212 memset(&qti->qti_slv_rec, 0, sizeof(qti->qti_slv_rec));
213 /* lookup record storing enforcement information for this ID */
214 rc = dt_lookup(env, obj, (struct dt_rec *)&qti->qti_slv_rec,
215 (struct dt_key *)&key);
216 if (rc < 0 && rc != -ENOENT)
219 if (lu_device_is_md(dev->dd_lu_dev.ld_site->ls_top_dev)) {
220 dqblk->dqb_ihardlimit = qti->qti_slv_rec.qsr_granted;
221 dqblk->dqb_bhardlimit = 0;
223 dqblk->dqb_ihardlimit = 0;
224 dqblk->dqb_bhardlimit = qti->qti_slv_rec.qsr_granted;
226 dqblk->dqb_valid |= QIF_LIMITS;
230 lu_object_put(env, &obj->do_lu);
233 EXPORT_SYMBOL(lquotactl_slv);
236 * Helper routine returning the FID associated with the global index storing
237 * quota settings for the storage pool \pool_id, resource type \pool_type and
238 * the quota type \quota_type.
240 void lquota_generate_fid(struct lu_fid *fid, int pool_id, int pool_type,
245 qtype = (quota_type == USRQUOTA) ? LQUOTA_TYPE_USR : LQUOTA_TYPE_GRP;
247 fid->f_seq = FID_SEQ_QUOTA_GLB;
248 fid->f_oid = (qtype << 24) | (pool_type << 16) | (__u16)pool_id;
253 * Helper routine used to extract pool ID, pool type and quota type from a
256 int lquota_extract_fid(const struct lu_fid *fid, int *pool_id, int *pool_type,
262 if (fid->f_seq != FID_SEQ_QUOTA_GLB)
265 if (pool_id != NULL) {
266 tmp = fid->f_oid & 0xffffU;
268 /* we only support pool ID 0 for the time being */
273 if (pool_type != NULL) {
274 tmp = (fid->f_oid >> 16) & 0xffU;
275 if (tmp >= LQUOTA_LAST_RES)
281 if (quota_type != NULL) {
282 tmp = fid->f_oid >> 24;
283 if (tmp >= LQUOTA_TYPE_MAX)
286 *quota_type = (tmp == LQUOTA_TYPE_USR) ? USRQUOTA : GRPQUOTA;
292 static int __init lquota_init(void)
297 lquota_key_init_generic(&lquota_thread_key, NULL);
298 lu_context_key_register(&lquota_thread_key);
300 rc = lu_kmem_init(lquota_caches);
306 GOTO(out_caches, rc);
317 lu_kmem_fini(lquota_caches);
319 lu_context_key_degister(&lquota_thread_key);
323 static void __exit lquota_exit(void)
327 lu_kmem_fini(lquota_caches);
328 lu_context_key_degister(&lquota_thread_key);
331 MODULE_AUTHOR("OpenSFS, Inc. <http://www.lustre.org/>");
332 MODULE_DESCRIPTION("Lustre Quota");
333 MODULE_VERSION(LUSTRE_VERSION_STRING);
334 MODULE_LICENSE("GPL");
336 module_init(lquota_init);
337 module_exit(lquota_exit);