Viewing: lquota_lib.c
// SPDX-License-Identifier: GPL-2.0
/*
* Copyright (c) 2012, 2017, Intel Corporation.
* Use is subject to license terms.
*/
/*
* Author: Johann Lombardi <johann.lombardi@intel.com>
* Author: Niu Yawei <yawei.niu@intel.com>
*/
#define DEBUG_SUBSYSTEM S_LQUOTA
#include <linux/version.h>
#include <linux/module.h>
#include <linux/init.h>
#include "lquota_internal.h"
struct kmem_cache *lqe_kmem;
static struct lu_kmem_descr lquota_caches[] = {
{
.ckd_cache = &lqe_kmem,
.ckd_name = "lqe_kmem",
.ckd_size = sizeof(struct lquota_entry)
},
{
.ckd_cache = NULL
}
};
/* register lquota key */
LU_KEY_INIT_FINI(lquota, struct lquota_thread_info);
LU_CONTEXT_KEY_DEFINE(lquota, LCT_MD_THREAD | LCT_DT_THREAD | LCT_LOCAL);
LU_KEY_INIT_GENERIC(lquota);
void lqe_ref_free(struct kref *kref)
{
struct lquota_entry *lqe = container_of(kref, struct lquota_entry,
lqe_ref);
LASSERT(!lqe->lqe_gl);
OBD_SLAB_FREE_PTR(lqe, lqe_kmem);
}
static inline __u32 qtype2acct_oid(int qtype)
{
switch (qtype) {
case USRQUOTA:
return ACCT_USER_OID;
case GRPQUOTA:
return ACCT_GROUP_OID;
case PRJQUOTA:
return ACCT_PROJECT_OID;
}
return ACCT_GROUP_OID;
}
/**
* acct_obj_lookup() - Look-up accounting object to collect space usage
* information for user or group.
* @env: is the environment passed by the caller
* @dev: is the dt_device storing the accounting object
* @type: is the quota type, either USRQUOTA or GRPQUOTA
*
* Return dt_object on success or %-ENOENT if not found
*/
struct dt_object *acct_obj_lookup(const struct lu_env *env,
struct dt_device *dev, int type)
{
struct lquota_thread_info *qti = lquota_info(env);
struct dt_object *obj = NULL;
ENTRY;
lu_local_obj_fid(&qti->qti_fid, qtype2acct_oid(type));
/* lookup the accounting object */
obj = dt_locate(env, dev, &qti->qti_fid);
if (IS_ERR(obj))
RETURN(obj);
if (!dt_object_exists(obj)) {
dt_object_put(env, obj);
RETURN(ERR_PTR(-ENOENT));
}
if (obj->do_index_ops == NULL) {
int rc;
/* set up indexing operations */
rc = obj->do_ops->do_index_try(env, obj, &dt_acct_features);
if (rc) {
CERROR("%s: failed to set up indexing operations for %s acct object rc:%d\n",
dev->dd_lu_dev.ld_obd->obd_name,
qtype_name(type), rc);
dt_object_put(env, obj);
RETURN(ERR_PTR(rc));
}
}
RETURN(obj);
}
/**
* quota_obj_lookup() - Initialize slave index object to collect local quota
* limit for user or group.
* @env: is the environment passed by the caller
* @dev: is the dt_device storing the slave index object
* @pool: is the pool type, either LQUOTA_RES_MD or LQUOTA_RES_DT
* @type: is the quota type, either USRQUOTA or GRPQUOTA
*
* Return dt_object on success or %-ENOENT if not found
*/
static struct dt_object *quota_obj_lookup(const struct lu_env *env,
struct dt_device *dev, int pool,
int type)
{
struct lquota_thread_info *qti = lquota_info(env);
struct dt_object *obj = NULL;
int is_md;
ENTRY;
is_md = lu_device_is_md(dev->dd_lu_dev.ld_site->ls_top_dev);
if ((is_md && pool == LQUOTA_RES_MD) ||
(!is_md && pool == LQUOTA_RES_DT))
qti->qti_fid.f_oid = qtype2slv_oid(type);
else
qti->qti_fid.f_oid = pool << 16 | qtype2slv_oid(type);
qti->qti_fid.f_seq = FID_SEQ_QUOTA;
qti->qti_fid.f_ver = 0;
/* lookup the quota object */
obj = dt_locate(env, dev, &qti->qti_fid);
if (IS_ERR(obj))
RETURN(obj);
if (!dt_object_exists(obj)) {
dt_object_put(env, obj);
RETURN(ERR_PTR(-ENOENT));
}
if (obj->do_index_ops == NULL) {
int rc;
/* set up indexing operations */
rc = obj->do_ops->do_index_try(env, obj,
&dt_quota_slv_features);
if (rc) {
CERROR("%s: failed to set up indexing operations for %s slave index object rc:%d\n",
dev->dd_lu_dev.ld_obd->obd_name,
qtype_name(type), rc);
dt_object_put(env, obj);
RETURN(ERR_PTR(rc));
}
}
RETURN(obj);
}
/*
* Iterate quota settings managed by \a obj.
*
* \param env - is the environment passed by the caller
* \param dev - is the backend device holding the quota object
* \param obj - is the quota object to be iterated
* \param oqctl - is the quota ioctl object passed in by caller
* \param buf - is the buffer to save the retrieved quota settings
* \param size - is the size of the buffer
* \param is_glb - true to iterate the global quota settings
* \param is_md - true to iterate LQUOTA_MD quota settings
*/
int lquota_obj_iter(const struct lu_env *env, struct dt_device *dev,
struct dt_object *obj, struct lu_nodemap *nodemap,
struct lquota_entry *lqe_def, struct obd_quotactl *oqctl,
char *buf, int size, bool is_glb, bool is_md)
{
struct lquota_thread_info *qti = lquota_info(env);
const struct dt_it_ops *iops;
struct dt_it *it;
struct dt_key *key;
struct dt_rec *rec = (struct dt_rec *)&qti->qti_rec;
__u64 offset;
bool skip = true;
int cur = 0, rc;
int rec_size;
ENTRY;
iops = &obj->do_index_ops->dio_it;
it = iops->init(env, obj, 0);
if (IS_ERR(it)) {
rc = PTR_ERR(it);
CERROR("%s: failed to initialize iterator: rc = %ld\n",
obj->do_lu.lo_dev->ld_obd->obd_name, PTR_ERR(it));
RETURN(rc);
}
rc = iops->load(env, it, 0);
if (rc <= 0) {
if (is_md)
oqctl->qc_iter_md_offset = 0;
else
oqctl->qc_iter_dt_offset = 0;
GOTO(out_fini, rc);
}
if ((is_md && oqctl->qc_iter_md_offset == 0) ||
(!is_md && oqctl->qc_iter_dt_offset == 0))
skip = false;
if (is_glb)
rec_size = sizeof(struct lquota_glb_rec);
else
rec_size = sizeof(struct lquota_acct_rec);
if (is_md)
offset = oqctl->qc_iter_md_offset;
else
offset = oqctl->qc_iter_dt_offset;
while ((size - cur) > (sizeof(__u64) + rec_size)) {
__u32 orig_id, cli_id, fs_id;
if (!skip)
goto get_setting;
if (offset == iops->store(env, it))
skip = false;
else {
rc = iops->next(env, it);
if (rc < 0) {
CERROR("%s: next failed: rc = %d\n",
obj->do_lu.lo_dev->ld_obd->obd_name, rc);
break;
}
/* reach the end */
if (rc > 0) {
if (is_md)
oqctl->qc_iter_md_offset = 0;
else
oqctl->qc_iter_dt_offset = 0;
break;
}
continue;
}
get_setting:
key = iops->key(env, it);
if (IS_ERR(key)) {
CERROR("%s: failed to get key: rc = %ld\n",
obj->do_lu.lo_dev->ld_obd->obd_name,
PTR_ERR(key));
GOTO(out_fini, rc = PTR_ERR(key));
}
rc = iops->rec(env, it, rec, 0);
if (rc) {
CERROR("%s: failed to get rec: rc = %d\n",
obj->do_lu.lo_dev->ld_obd->obd_name, rc);
GOTO(out_fini, rc);
}
orig_id = *(__u64 *)key;
if (oqctl->qc_iter_qid_end != 0 &&
(orig_id < oqctl->qc_iter_qid_start ||
orig_id > oqctl->qc_iter_qid_end))
goto next;
/* This place could be optimised for a case when trusted=0.
* In a such case we should return only two records for ROOT and
* for the squashed id.
*/
cli_id = nodemap_map_id(nodemap, oqctl->qc_type,
NODEMAP_FS_TO_CLIENT,
orig_id);
fs_id = nodemap_map_id(nodemap, oqctl->qc_type,
NODEMAP_CLIENT_TO_FS, cli_id);
/* If remapped fs id does not match original id, it means the id
* is squashed and does correspond to the squashed value.
*/
if (fs_id != orig_id)
goto next;
*(__u64 *)key = cli_id;
memcpy(buf + cur, key, sizeof(__u64));
cur += sizeof(__u64);
if (is_glb && lqe_def != NULL) {
struct lquota_glb_rec *glb_rec;
glb_rec = (struct lquota_glb_rec *)rec;
if (glb_rec->qbr_hardlimit == 0 &&
glb_rec->qbr_softlimit == 0 &&
(LQUOTA_FLAG(glb_rec->qbr_time) &
LQUOTA_FLAG_DEFAULT)) {
glb_rec->qbr_softlimit = lqe_def->lqe_softlimit;
glb_rec->qbr_hardlimit = lqe_def->lqe_hardlimit;
}
}
memcpy(buf + cur, rec, rec_size);
cur += rec_size;
next:
rc = iops->next(env, it);
if (rc < 0) {
CERROR("%s: next failed: rc = %d\n",
obj->do_lu.lo_dev->ld_obd->obd_name, rc);
GOTO(out_fini, rc);
}
/* reach the end */
if (rc > 0) {
if (is_md)
oqctl->qc_iter_md_offset = 0;
else
oqctl->qc_iter_dt_offset = 0;
break;
}
if (is_md)
oqctl->qc_iter_md_offset = iops->store(env, it);
else
oqctl->qc_iter_dt_offset = iops->store(env, it);
}
out_fini:
if (rc >= 0) {
if (is_md)
oqctl->qc_iter_md_buflen = cur;
else
oqctl->qc_iter_dt_buflen = cur;
rc = 0;
}
iops->put(env, it);
iops->fini(env, it);
return rc < 0 ? rc : 0;
}
/*
* Helper routine to retrieve slave information.
* This function converts a quotactl request into quota/accounting object
* operations. It is independant of the slave stack which is only accessible
* from the OSD layer.
*
* \param env - is the environment passed by the caller
* \param dev - is the dt_device this quotactl is executed on
* \param oqctl - is the quotactl request
*/
int lquotactl_slv(const struct lu_env *env, struct dt_device *dev,
struct lu_nodemap *nodemap, struct obd_quotactl *oqctl,
char *buffer)
{
struct lquota_thread_info *qti = lquota_info(env);
struct dt_object *obj, *obj_aux = NULL;
struct obd_dqblk *dqblk = &oqctl->qc_dqblk;
int size = buffer == NULL ? 0 : LQUOTA_ITER_BUFLEN;
__u64 key;
int rc;
ENTRY;
if (oqctl->qc_cmd != Q_GETOQUOTA &&
oqctl->qc_cmd != LUSTRE_Q_ITEROQUOTA) {
/* as in many other places, dev->dd_lu_dev.ld_obd->obd_name
* point to an invalid obd_name, to be fixed in LU-1574 */
CERROR("%s: Unsupported quotactl command: %x\n",
dev->dd_lu_dev.ld_obd->obd_name, oqctl->qc_cmd);
RETURN(-EOPNOTSUPP);
}
if (oqctl->qc_type < 0 || oqctl->qc_type >= LL_MAXQUOTAS)
RETURN(-EOPNOTSUPP);
/* qc_id is a 32-bit field while a key has 64 bits */
key = oqctl->qc_id;
/* Step 1: collect accounting information */
obj = acct_obj_lookup(env, dev, oqctl->qc_type);
if (IS_ERR(obj))
RETURN(-EOPNOTSUPP);
if (obj->do_index_ops == NULL)
GOTO(out, rc = -EINVAL);
if (oqctl->qc_cmd == LUSTRE_Q_ITEROQUOTA) {
if (lu_device_is_md(dev->dd_lu_dev.ld_site->ls_top_dev))
rc = lquota_obj_iter(env, dev, obj, nodemap, NULL,
oqctl, buffer, size, false, true);
else
rc = lquota_obj_iter(env, dev, obj, nodemap, NULL,
oqctl, buffer, size, false, false);
GOTO(out, rc);
}
/* lookup record storing space accounting information for this ID */
rc = dt_lookup(env, obj, (struct dt_rec *)&qti->qti_acct_rec,
(struct dt_key *)&key);
if (rc < 0)
GOTO(out, rc);
memset(&oqctl->qc_dqblk, 0, sizeof(struct obd_dqblk));
dqblk->dqb_curspace = qti->qti_acct_rec.bspace;
dqblk->dqb_curinodes = qti->qti_acct_rec.ispace;
dqblk->dqb_valid = QIF_USAGE;
dt_object_put(env, obj);
/* Step 2: collect enforcement information */
if (lu_device_is_md(dev->dd_lu_dev.ld_site->ls_top_dev))
obj = quota_obj_lookup(env, dev, LQUOTA_RES_MD, oqctl->qc_type);
else
obj = quota_obj_lookup(env, dev, LQUOTA_RES_DT, oqctl->qc_type);
if (IS_ERR(obj))
RETURN(0);
if (obj->do_index_ops == NULL)
GOTO(out, rc = 0);
memset(&qti->qti_slv_rec, 0, sizeof(qti->qti_slv_rec));
/* lookup record storing enforcement information for this ID */
rc = dt_lookup(env, obj, (struct dt_rec *)&qti->qti_slv_rec,
(struct dt_key *)&key);
if (rc < 0 && rc != -ENOENT)
GOTO(out, rc = 0);
if (lu_device_is_md(dev->dd_lu_dev.ld_site->ls_top_dev)) {
dqblk->dqb_ihardlimit = qti->qti_slv_rec.qsr_granted;
dqblk->dqb_bhardlimit = 0;
obj_aux = quota_obj_lookup(env, dev, LQUOTA_RES_DT,
oqctl->qc_type);
if (IS_ERR(obj_aux)) {
obj_aux = NULL;
GOTO(out, rc = 0);
}
if (obj_aux->do_index_ops == NULL)
GOTO(out, rc = 0);
memset(&qti->qti_slv_rec, 0, sizeof(qti->qti_slv_rec));
rc = dt_lookup(env, obj_aux, (struct dt_rec *)&qti->qti_slv_rec,
(struct dt_key *)&key);
if (rc < 0 && rc != -ENOENT)
GOTO(out, rc = 0);
dqblk->dqb_bhardlimit = qti->qti_slv_rec.qsr_granted;
} else {
dqblk->dqb_ihardlimit = 0;
dqblk->dqb_bhardlimit = qti->qti_slv_rec.qsr_granted;
}
dqblk->dqb_valid |= QIF_LIMITS;
GOTO(out, rc = 0);
out:
dt_object_put(env, obj);
if (obj_aux != NULL)
dt_object_put(env, obj_aux);
return rc;
}
EXPORT_SYMBOL(lquotactl_slv);
static inline __u8 qtype2lqtype(int qtype)
{
switch (qtype) {
case USRQUOTA:
return LQUOTA_TYPE_USR;
case GRPQUOTA:
return LQUOTA_TYPE_GRP;
case PRJQUOTA:
return LQUOTA_TYPE_PRJ;
}
return LQUOTA_TYPE_GRP;
}
static inline int lqtype2qtype(int lqtype)
{
switch (lqtype) {
case LQUOTA_TYPE_USR:
return USRQUOTA;
case LQUOTA_TYPE_GRP:
return GRPQUOTA;
case LQUOTA_TYPE_PRJ:
return PRJQUOTA;
}
return GRPQUOTA;
}
/**
* lquota_generate_fid() - Helper routine returning the FID associated with the
* global index storing quota settings for default
* storage pool, resource type @pool_type and the quota
* type @quota_type.
* @fid: FID associated with global index [out]
* @pool_type: Quota resource type
* @quota_type: Quota types (URS, GRP, PRJ)
*/
void lquota_generate_fid(struct lu_fid *fid, int pool_type, int quota_type)
{
__u8 lqtype = qtype2lqtype(quota_type);
fid->f_seq = FID_SEQ_QUOTA_GLB;
fid->f_oid = (lqtype << 24) | (pool_type << 16);
fid->f_ver = 0;
}
/**
* lquota_extract_fid() - Helper routine used to extract pool type and quota
* type from a given FID.
* @fid: FID to extrace quota and pool type
* @pool_type: Quota resource type
* @quota_type: Quota types (URS, GRP, PRJ)
*
* Return:
* * %0 on success
* * %negative on failure
*/
int lquota_extract_fid(const struct lu_fid *fid,
enum lquota_res_type *pool_type,
enum lquota_type *quota_type)
{
unsigned int lqtype;
ENTRY;
if (fid->f_seq != FID_SEQ_QUOTA_GLB)
RETURN(-EINVAL);
if (pool_type != NULL) {
lqtype = (fid->f_oid >> 16) & 0xffU;
if (lqtype >= LQUOTA_LAST_RES)
RETURN(-ENOTSUPP);
*pool_type = lqtype;
}
if (quota_type != NULL) {
lqtype = fid->f_oid >> 24;
if (lqtype >= LQUOTA_TYPE_MAX)
RETURN(-ENOTSUPP);
*quota_type = lqtype2qtype(lqtype);
}
RETURN(0);
}
static int __init lquota_init(void)
{
int rc;
ENTRY;
rc = libcfs_setup();
if (rc)
return rc;
lquota_key_init_generic(&lquota_thread_key, NULL);
lu_context_key_register(&lquota_thread_key);
rc = lu_kmem_init(lquota_caches);
if (rc)
GOTO(out_key, rc);
rc = qmt_glb_init();
if (rc)
GOTO(out_caches, rc);
rc = qsd_glb_init();
if (rc)
GOTO(out_qmt, rc);
RETURN(0);
out_qmt:
qmt_glb_fini();
out_caches:
lu_kmem_fini(lquota_caches);
out_key:
lu_context_key_degister(&lquota_thread_key);
return rc;
}
static void __exit lquota_exit(void)
{
qsd_glb_fini();
qmt_glb_fini();
lu_kmem_fini(lquota_caches);
lu_context_key_degister(&lquota_thread_key);
}
MODULE_AUTHOR("OpenSFS, Inc. <http://www.lustre.org/>");
MODULE_DESCRIPTION("Lustre Quota");
MODULE_VERSION(LUSTRE_VERSION_STRING);
MODULE_LICENSE("GPL");
late_initcall_sync(lquota_init);
module_exit(lquota_exit);
