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, 2017, Intel Corporation.
25 * Use is subject to license terms.
28 #ifndef _LUSTRE_QUOTA_H
29 #define _LUSTRE_QUOTA_H
31 /** \defgroup quota quota
36 #include <linux/quota.h>
37 #include <linux/quotaops.h>
38 #include <linux/sort.h>
39 #include <lustre_fid.h>
40 #include <lustre_dlm.h>
43 #define MAX_IQ_TIME 604800 /* (7*24*60*60) 1 week */
47 #define MAX_DQ_TIME 604800 /* (7*24*60*60) 1 week */
50 struct lquota_id_info;
53 /* Gather all quota record type in an union that can be used to read any records
54 * from disk. All fields of these records must be 64-bit aligned, otherwise the
55 * OSD layer may swab them incorrectly. */
57 struct lquota_glb_rec lqr_glb_rec;
58 struct lquota_slv_rec lqr_slv_rec;
59 struct lquota_acct_rec lqr_acct_rec;
62 /* flags for inode/block quota accounting */
63 enum osd_qid_declare_flags {
64 OSD_QID_INODE = BIT(0),
66 OSD_QID_FORCE = BIT(2),
69 /* Index features supported by the global index objects
70 * Only used for migration purpose and should be removed once on-disk migration
71 * is no longer needed */
72 extern struct dt_index_features dt_quota_iusr_features;
73 extern struct dt_index_features dt_quota_busr_features;
74 extern struct dt_index_features dt_quota_igrp_features;
75 extern struct dt_index_features dt_quota_bgrp_features;
77 /* Name used in the configuration logs to identify the default metadata pool
78 * (composed of all the MDTs, with pool ID 0) and the default data pool (all
79 * the OSTs, with pool ID 0 too). */
80 #define QUOTA_METAPOOL_NAME "mdt="
81 #define QUOTA_DATAPOOL_NAME "ost="
84 * Quota Master Target support
87 /* Request handlers for quota master operations.
88 * This is used by the MDT to pass quota/lock requests to the quota master
89 * target. This won't be needed any more once the QMT is a real target and
90 * does not rely any more on the MDT service threads and namespace. */
92 /* Handle quotactl request from client. */
93 int (*qmth_quotactl)(const struct lu_env *, struct lu_device *,
94 struct obd_quotactl *);
96 /* Handle dqacq/dqrel request from slave. */
97 int (*qmth_dqacq)(const struct lu_env *, struct lu_device *,
98 struct ptlrpc_request *);
100 /* LDLM intent policy associated with quota locks */
101 int (*qmth_intent_policy)(const struct lu_env *, struct lu_device *,
102 struct ptlrpc_request *, struct ldlm_lock **,
105 /* Initialize LVB of ldlm resource associated with quota objects */
106 int (*qmth_lvbo_init)(struct lu_device *, struct ldlm_resource *);
108 /* Update LVB of ldlm resource associated with quota objects */
109 int (*qmth_lvbo_update)(struct lu_device *, struct ldlm_resource *,
110 struct ptlrpc_request *, int);
112 /* Return size of LVB to be packed in ldlm message */
113 int (*qmth_lvbo_size)(struct lu_device *, struct ldlm_lock *);
115 /* Fill request buffer with lvb */
116 int (*qmth_lvbo_fill)(struct lu_device *, struct ldlm_lock *, void *,
119 /* Free lvb associated with ldlm resource */
120 int (*qmth_lvbo_free)(struct lu_device *, struct ldlm_resource *);
123 /* actual handlers are defined in lustre/quota/qmt_handler.c */
124 extern struct qmt_handlers qmt_hdls;
127 * Quota enforcement support on slaves
132 /* The quota slave feature is implemented under the form of a library.
133 * The API is the following:
135 * - qsd_init(): the user (mostly the OSD layer) should first allocate a qsd
136 * instance via qsd_init(). This creates all required structures
137 * to manage quota enforcement for this target and performs all
138 * low-level initialization which does not involve any lustre
139 * object. qsd_init() should typically be called when the OSD
142 * - qsd_prepare(): This sets up on-disk objects associated with the quota slave
143 * feature and initiates the quota reintegration procedure if
144 * needed. qsd_prepare() should typically be called when
145 * ->ldo_prepare is invoked.
147 * - qsd_start(): a qsd instance should be started once recovery is completed
148 * (i.e. when ->ldo_recovery_complete is called). This is used
149 * to notify the qsd layer that quota should now be enforced
150 * again via the qsd_op_begin/end functions. The last step of the
151 * reintegration prodecure (namely usage reconciliation) will be
152 * completed during start.
154 * - qsd_fini(): is used to release a qsd_instance structure allocated with
155 * qsd_init(). This releases all quota slave objects and frees the
156 * structures associated with the qsd_instance.
158 * - qsd_op_begin(): is used to enforce quota, it must be called in the
159 * declaration of each operation. qsd_op_end() should then be
160 * invoked later once all operations have been completed in
161 * order to release/adjust the quota space.
162 * Running qsd_op_begin() before qsd_start() isn't fatal and
163 * will return success.
164 * Once qsd_start() has been run, qsd_op_begin() will block
165 * until the reintegration procedure is completed.
167 * - qsd_op_end(): performs the post operation quota processing. This must be
168 * called after the operation transaction stopped.
169 * While qsd_op_begin() must be invoked each time a new
170 * operation is declared, qsd_op_end() should be called only
171 * once for the whole transaction.
173 * - qsd_op_adjust(): triggers pre-acquire/release if necessary.
175 * Below are the function prototypes to be used by OSD layer to manage quota
176 * enforcement. Arguments are documented where each function is defined. */
178 /* flags for quota local enforcement */
179 enum osd_quota_local_flags {
180 QUOTA_FL_OVER_USRQUOTA = BIT(0),
181 QUOTA_FL_OVER_GRPQUOTA = BIT(1),
182 QUOTA_FL_SYNC = BIT(2),
183 QUOTA_FL_OVER_PRJQUOTA = BIT(3),
186 struct qsd_instance *qsd_init(const struct lu_env *, char *, struct dt_device *,
187 struct proc_dir_entry *, bool is_md, bool excl);
188 int qsd_prepare(const struct lu_env *, struct qsd_instance *);
189 int qsd_start(const struct lu_env *, struct qsd_instance *);
190 void qsd_fini(const struct lu_env *, struct qsd_instance *);
191 int qsd_op_begin(const struct lu_env *, struct qsd_instance *,
192 struct lquota_trans *, struct lquota_id_info *,
193 enum osd_quota_local_flags *);
194 void qsd_op_end(const struct lu_env *, struct qsd_instance *,
195 struct lquota_trans *);
196 void qsd_op_adjust(const struct lu_env *, struct qsd_instance *,
197 union lquota_id *, int);
198 int qsd_transfer(const struct lu_env *env, struct qsd_instance *qsd,
199 struct lquota_trans *trans, unsigned int qtype,
200 u64 orig_id, u64 new_id, u64 bspace,
201 struct lquota_id_info *qi);
202 int qsd_reserve_or_free_quota(const struct lu_env *env,
203 struct qsd_instance *qsd,
204 struct lquota_id_info *qi);
207 * Quota information attached to a transaction
212 struct lquota_id_info {
213 /* quota identifier */
214 union lquota_id lqi_id;
216 /* USRQUOTA or GRPQUOTA for now, could be expanded for
217 * directory quota or other types later. */
220 /* inodes or kbytes to be consumed or released, it could
221 * be negative when releasing space. */
224 /* quota slave entry structure associated with this ID */
225 struct lquota_entry *lqi_qentry;
227 /* whether we are reporting blocks or inodes */
231 /* With the DoM, both inode quota in meta pool and block quota in data pool
232 * will be enforced at MDT, there are at most 4 quota ids being enforced in
233 * a single transaction for inode and block quota, which is chown transaction:
234 * original uid and gid, new uid and gid.
236 * Given a parent dir and a sub dir, with different uid, gid and project id,
237 * need <parent,child> x <user,group,project> x <block,inode> = 12 ids */
238 #define QUOTA_MAX_TRANSIDS 12
240 /* all qids involved in a single transaction */
241 struct lquota_trans {
242 unsigned short lqt_id_cnt;
243 struct lquota_id_info lqt_ids[QUOTA_MAX_TRANSIDS];
246 #define IS_LQUOTA_RES(res) \
247 (res->lr_name.name[LUSTRE_RES_ID_SEQ_OFF] == FID_SEQ_QUOTA || \
248 res->lr_name.name[LUSTRE_RES_ID_SEQ_OFF] == FID_SEQ_QUOTA_GLB)
250 /* helper function used by MDT & OFD to retrieve quota accounting information
252 int lquotactl_slv(const struct lu_env *, struct dt_device *,
253 struct obd_quotactl *);
255 #endif /* _LUSTRE_QUOTA_H */