lustre/include/lustre_quota.h

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   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.
   9  *
  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).
  15  *
  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
  20  *
  21  * GPL HEADER END
  22  */
  23 /*
  24  * Copyright (c) 2012, Intel Corporation.
  25  * Use is subject to license terms.
  26  */
  27
  28 #ifndef _LUSTRE_QUOTA_H
  29 #define _LUSTRE_QUOTA_H
  30
  31 /** \defgroup quota quota
  32  *
  33  */
  34
  35 #if defined(__linux__)
  36 #include <linux/lustre_quota.h>
  37 #elif defined(__APPLE__)
  38 #include <darwin/lustre_quota.h>
  39 #endif
  40
  41 #include <dt_object.h>
  42 #include <lustre_fid.h>
  43 #include <lustre_dlm.h>
  44
  45 #ifndef MAX_IQ_TIME
  46 #define MAX_IQ_TIME  604800     /* (7*24*60*60) 1 week */
  47 #endif
  48
  49 #ifndef MAX_DQ_TIME
  50 #define MAX_DQ_TIME  604800     /* (7*24*60*60) 1 week */
  51 #endif
  52
  53 struct lquota_id_info;
  54 struct lquota_trans;
  55
  56 /* Gather all quota record type in an union that can be used to read any records
  57  * from disk. All fields of these records must be 64-bit aligned, otherwise the
  58  * OSD layer may swab them incorrectly. */
  59 union lquota_rec {
  60         struct lquota_glb_rec   lqr_glb_rec;
  61         struct lquota_slv_rec   lqr_slv_rec;
  62         struct lquota_acct_rec  lqr_acct_rec;
  63 };
  64
  65 /* Index features supported by the global index objects
  66  * Only used for migration purpose and should be removed once on-disk migration
  67  * is no longer needed */
  68 extern struct dt_index_features dt_quota_iusr_features;
  69 extern struct dt_index_features dt_quota_busr_features;
  70 extern struct dt_index_features dt_quota_igrp_features;
  71 extern struct dt_index_features dt_quota_bgrp_features;
  72
  73 /* Name used in the configuration logs to identify the default metadata pool
  74  * (composed of all the MDTs, with pool ID 0) and the default data pool (all
  75  * the OSTs, with pool ID 0 too). */
  76 #define QUOTA_METAPOOL_NAME   "mdt="
  77 #define QUOTA_DATAPOOL_NAME   "ost="
  78
  79 /*
  80  * Quota Master Target support
  81  */
  82
  83 /* Request handlers for quota master operations.
  84  * This is used by the MDT to pass quota/lock requests to the quota master
  85  * target. This won't be needed any more once the QMT is a real target and
  86  * does not rely any more on the MDT service threads and namespace. */
  87 struct qmt_handlers {
  88         /* Handle quotactl request from client. */
  89         int (*qmth_quotactl)(const struct lu_env *, struct lu_device *,
  90                              struct obd_quotactl *);
  91
  92         /* Handle dqacq/dqrel request from slave. */
  93         int (*qmth_dqacq)(const struct lu_env *, struct lu_device *,
  94                           struct ptlrpc_request *);
  95
  96         /* LDLM intent policy associated with quota locks */
  97         int (*qmth_intent_policy)(const struct lu_env *, struct lu_device *,
  98                                   struct ptlrpc_request *, struct ldlm_lock **,
  99                                   int);
 100
 101         /* Initialize LVB of ldlm resource associated with quota objects */
 102         int (*qmth_lvbo_init)(struct lu_device *, struct ldlm_resource *);
 103
 104         /* Update LVB of ldlm resource associated with quota objects */
 105         int (*qmth_lvbo_update)(struct lu_device *, struct ldlm_resource *,
 106                                 struct ptlrpc_request *, int);
 107
 108         /* Return size of LVB to be packed in ldlm message */
 109         int (*qmth_lvbo_size)(struct lu_device *, struct ldlm_lock *);
 110
 111         /* Fill request buffer with lvb */
 112         int (*qmth_lvbo_fill)(struct lu_device *, struct ldlm_lock *, void *,
 113                               int);
 114
 115         /* Free lvb associated with ldlm resource */
 116         int (*qmth_lvbo_free)(struct lu_device *, struct ldlm_resource *);
 117 };
 118
 119 /* actual handlers are defined in lustre/quota/qmt_handler.c */
 120 extern struct qmt_handlers qmt_hdls;
 121
 122 /*
 123  * Quota enforcement support on slaves
 124  */
 125
 126 struct qsd_instance;
 127
 128 /* The quota slave feature is implemented under the form of a library.
 129  * The API is the following:
 130  *
 131  * - qsd_init(): the user (mostly the OSD layer) should first allocate a qsd
 132  *               instance via qsd_init(). This creates all required structures
 133  *               to manage quota enforcement for this target and performs all
 134  *               low-level initialization which does not involve any lustre
 135  *               object. qsd_init() should typically be called when the OSD
 136  *               is being set up.
 137  *
 138  * - qsd_prepare(): This sets up on-disk objects associated with the quota slave
 139  *                  feature and initiates the quota reintegration procedure if
 140  *                  needed. qsd_prepare() should typically be called when
 141  *                  ->ldo_prepare is invoked.
 142  *
 143  * - qsd_start(): a qsd instance should be started once recovery is completed
 144  *                (i.e. when ->ldo_recovery_complete is called). This is used
 145  *                to notify the qsd layer that quota should now be enforced
 146  *                again via the qsd_op_begin/end functions. The last step of the
 147  *                reintegration prodecure (namely usage reconciliation) will be
 148  *                completed during start.
 149  *
 150  * - qsd_fini(): is used to release a qsd_instance structure allocated with
 151  *               qsd_init(). This releases all quota slave objects and frees the
 152  *               structures associated with the qsd_instance.
 153  *
 154  * - qsd_op_begin(): is used to enforce quota, it must be called in the
 155  *                   declaration of each operation. qsd_op_end() should then be
 156  *                   invoked later once all operations have been completed in
 157  *                   order to release/adjust the quota space.
 158  *                   Running qsd_op_begin() before qsd_start() isn't fatal and
 159  *                   will return success.
 160  *                   Once qsd_start() has been run, qsd_op_begin() will block
 161  *                   until the reintegration procedure is completed.
 162  *
 163  * - qsd_op_end(): performs the post operation quota processing. This must be
 164  *                 called after the operation transaction stopped.
 165  *                 While qsd_op_begin() must be invoked each time a new
 166  *                 operation is declared, qsd_op_end() should be called only
 167  *                 once for the whole transaction.
 168  *
 169  * - qsd_op_adjust(): triggers pre-acquire/release if necessary.
 170  *
 171  * Below are the function prototypes to be used by OSD layer to manage quota
 172  * enforcement. Arguments are documented where each function is defined.  */
 173
 174 struct qsd_instance *qsd_init(const struct lu_env *, char *, struct dt_device *,
 175                               cfs_proc_dir_entry_t *);
 176 int qsd_prepare(const struct lu_env *, struct qsd_instance *);
 177 int qsd_start(const struct lu_env *, struct qsd_instance *);
 178 void qsd_fini(const struct lu_env *, struct qsd_instance *);
 179 int qsd_op_begin(const struct lu_env *, struct qsd_instance *,
 180                  struct lquota_trans *, struct lquota_id_info *, int *);
 181 void qsd_op_end(const struct lu_env *, struct qsd_instance *,
 182                 struct lquota_trans *);
 183 void qsd_op_adjust(const struct lu_env *, struct qsd_instance *,
 184                    union lquota_id *, int);
 185 /* This is exported for the ldiskfs quota migration only,
 186  * see convert_quota_file() */
 187 int lquota_disk_write_glb(const struct lu_env *, struct dt_object *,
 188                           __u64, struct lquota_glb_rec *);
 189
 190 /*
 191  * Quota information attached to a transaction
 192  */
 193
 194 struct lquota_entry;
 195
 196 struct lquota_id_info {
 197         /* quota identifier */
 198         union lquota_id          lqi_id;
 199
 200         /* USRQUOTA or GRPQUOTA for now, could be expanded for
 201          * directory quota or other types later.  */
 202         int                      lqi_type;
 203
 204         /* inodes or kbytes to be consumed or released, it could
 205          * be negative when releasing space.  */
 206         long long                lqi_space;
 207
 208         /* quota slave entry structure associated with this ID */
 209         struct lquota_entry     *lqi_qentry;
 210
 211         /* whether we are reporting blocks or inodes */
 212         bool                     lqi_is_blk;
 213 };
 214
 215 /* Since we enforce only inode quota in meta pool (MDTs), and block quota in
 216  * data pool (OSTs), there are at most 4 quota ids being enforced in a single
 217  * transaction, which is chown transaction:
 218  * original uid and gid, new uid and gid.
 219  *
 220  * This value might need to be revised when directory quota is added.  */
 221 #define QUOTA_MAX_TRANSIDS    4
 222
 223 /* all qids involved in a single transaction */
 224 struct lquota_trans {
 225         unsigned short          lqt_id_cnt;
 226         struct lquota_id_info   lqt_ids[QUOTA_MAX_TRANSIDS];
 227 };
 228
 229 /* flags for quota local enforcement */
 230 #define QUOTA_FL_OVER_USRQUOTA  0x01
 231 #define QUOTA_FL_OVER_GRPQUOTA  0x02
 232 #define QUOTA_FL_SYNC           0x04
 233
 234 #define IS_LQUOTA_RES(res)                                              \
 235         (res->lr_name.name[LUSTRE_RES_ID_SEQ_OFF] == FID_SEQ_QUOTA ||   \
 236          res->lr_name.name[LUSTRE_RES_ID_SEQ_OFF] == FID_SEQ_QUOTA_GLB)
 237
 238 /* helper function used by MDT & OFD to retrieve quota accounting information
 239  * on slave */
 240 int lquotactl_slv(const struct lu_env *, struct dt_device *,
 241                   struct obd_quotactl *);
 242 /** @} quota */
 243 #endif /* _LUSTRE_QUOTA_H */