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, 2014, 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 <dt_object.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 */
51 #define LL_MAXQUOTAS 2
54 struct lquota_id_info;
57 /* Gather all quota record type in an union that can be used to read any records
58 * from disk. All fields of these records must be 64-bit aligned, otherwise the
59 * OSD layer may swab them incorrectly. */
61 struct lquota_glb_rec lqr_glb_rec;
62 struct lquota_slv_rec lqr_slv_rec;
63 struct lquota_acct_rec lqr_acct_rec;
66 /* Index features supported by the global index objects
67 * Only used for migration purpose and should be removed once on-disk migration
68 * is no longer needed */
69 extern struct dt_index_features dt_quota_iusr_features;
70 extern struct dt_index_features dt_quota_busr_features;
71 extern struct dt_index_features dt_quota_igrp_features;
72 extern struct dt_index_features dt_quota_bgrp_features;
74 /* Name used in the configuration logs to identify the default metadata pool
75 * (composed of all the MDTs, with pool ID 0) and the default data pool (all
76 * the OSTs, with pool ID 0 too). */
77 #define QUOTA_METAPOOL_NAME "mdt="
78 #define QUOTA_DATAPOOL_NAME "ost="
81 * Quota Master Target support
84 /* Request handlers for quota master operations.
85 * This is used by the MDT to pass quota/lock requests to the quota master
86 * target. This won't be needed any more once the QMT is a real target and
87 * does not rely any more on the MDT service threads and namespace. */
89 /* Handle quotactl request from client. */
90 int (*qmth_quotactl)(const struct lu_env *, struct lu_device *,
91 struct obd_quotactl *);
93 /* Handle dqacq/dqrel request from slave. */
94 int (*qmth_dqacq)(const struct lu_env *, struct lu_device *,
95 struct ptlrpc_request *);
97 /* LDLM intent policy associated with quota locks */
98 int (*qmth_intent_policy)(const struct lu_env *, struct lu_device *,
99 struct ptlrpc_request *, struct ldlm_lock **,
102 /* Initialize LVB of ldlm resource associated with quota objects */
103 int (*qmth_lvbo_init)(struct lu_device *, struct ldlm_resource *);
105 /* Update LVB of ldlm resource associated with quota objects */
106 int (*qmth_lvbo_update)(struct lu_device *, struct ldlm_resource *,
107 struct ptlrpc_request *, int);
109 /* Return size of LVB to be packed in ldlm message */
110 int (*qmth_lvbo_size)(struct lu_device *, struct ldlm_lock *);
112 /* Fill request buffer with lvb */
113 int (*qmth_lvbo_fill)(struct lu_device *, struct ldlm_lock *, void *,
116 /* Free lvb associated with ldlm resource */
117 int (*qmth_lvbo_free)(struct lu_device *, struct ldlm_resource *);
120 /* actual handlers are defined in lustre/quota/qmt_handler.c */
121 extern struct qmt_handlers qmt_hdls;
124 * Quota enforcement support on slaves
129 /* The quota slave feature is implemented under the form of a library.
130 * The API is the following:
132 * - qsd_init(): the user (mostly the OSD layer) should first allocate a qsd
133 * instance via qsd_init(). This creates all required structures
134 * to manage quota enforcement for this target and performs all
135 * low-level initialization which does not involve any lustre
136 * object. qsd_init() should typically be called when the OSD
139 * - qsd_prepare(): This sets up on-disk objects associated with the quota slave
140 * feature and initiates the quota reintegration procedure if
141 * needed. qsd_prepare() should typically be called when
142 * ->ldo_prepare is invoked.
144 * - qsd_start(): a qsd instance should be started once recovery is completed
145 * (i.e. when ->ldo_recovery_complete is called). This is used
146 * to notify the qsd layer that quota should now be enforced
147 * again via the qsd_op_begin/end functions. The last step of the
148 * reintegration prodecure (namely usage reconciliation) will be
149 * completed during start.
151 * - qsd_fini(): is used to release a qsd_instance structure allocated with
152 * qsd_init(). This releases all quota slave objects and frees the
153 * structures associated with the qsd_instance.
155 * - qsd_op_begin(): is used to enforce quota, it must be called in the
156 * declaration of each operation. qsd_op_end() should then be
157 * invoked later once all operations have been completed in
158 * order to release/adjust the quota space.
159 * Running qsd_op_begin() before qsd_start() isn't fatal and
160 * will return success.
161 * Once qsd_start() has been run, qsd_op_begin() will block
162 * until the reintegration procedure is completed.
164 * - qsd_op_end(): performs the post operation quota processing. This must be
165 * called after the operation transaction stopped.
166 * While qsd_op_begin() must be invoked each time a new
167 * operation is declared, qsd_op_end() should be called only
168 * once for the whole transaction.
170 * - qsd_op_adjust(): triggers pre-acquire/release if necessary.
172 * Below are the function prototypes to be used by OSD layer to manage quota
173 * enforcement. Arguments are documented where each function is defined. */
175 struct qsd_instance *qsd_init(const struct lu_env *, char *, struct dt_device *,
176 struct proc_dir_entry *);
177 int qsd_prepare(const struct lu_env *, struct qsd_instance *);
178 int qsd_start(const struct lu_env *, struct qsd_instance *);
179 void qsd_fini(const struct lu_env *, struct qsd_instance *);
180 int qsd_op_begin(const struct lu_env *, struct qsd_instance *,
181 struct lquota_trans *, struct lquota_id_info *, int *);
182 void qsd_op_end(const struct lu_env *, struct qsd_instance *,
183 struct lquota_trans *);
184 void qsd_op_adjust(const struct lu_env *, struct qsd_instance *,
185 union lquota_id *, int);
188 * Quota information attached to a transaction
193 struct lquota_id_info {
194 /* quota identifier */
195 union lquota_id lqi_id;
197 /* USRQUOTA or GRPQUOTA for now, could be expanded for
198 * directory quota or other types later. */
201 /* inodes or kbytes to be consumed or released, it could
202 * be negative when releasing space. */
205 /* quota slave entry structure associated with this ID */
206 struct lquota_entry *lqi_qentry;
208 /* whether we are reporting blocks or inodes */
212 /* Since we enforce only inode quota in meta pool (MDTs), and block quota in
213 * data pool (OSTs), there are at most 4 quota ids being enforced in a single
214 * transaction, which is chown transaction:
215 * original uid and gid, new uid and gid.
217 * This value might need to be revised when directory quota is added. */
218 #define QUOTA_MAX_TRANSIDS 4
220 /* all qids involved in a single transaction */
221 struct lquota_trans {
222 unsigned short lqt_id_cnt;
223 struct lquota_id_info lqt_ids[QUOTA_MAX_TRANSIDS];
226 /* flags for quota local enforcement */
227 #define QUOTA_FL_OVER_USRQUOTA 0x01
228 #define QUOTA_FL_OVER_GRPQUOTA 0x02
229 #define QUOTA_FL_SYNC 0x04
231 #define IS_LQUOTA_RES(res) \
232 (res->lr_name.name[LUSTRE_RES_ID_SEQ_OFF] == FID_SEQ_QUOTA || \
233 res->lr_name.name[LUSTRE_RES_ID_SEQ_OFF] == FID_SEQ_QUOTA_GLB)
235 /* helper function used by MDT & OFD to retrieve quota accounting information
237 int lquotactl_slv(const struct lu_env *, struct dt_device *,
238 struct obd_quotactl *);
240 #endif /* _LUSTRE_QUOTA_H */