lustre/quota/qsd_internal.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 Whamcloud, Inc.
  25  * Use is subject to license terms.
  26  */
  27
  28 #include "lquota_internal.h"
  29
  30 #ifndef _QSD_INTERNAL_H
  31 #define _QSD_INTERNAL_H
  32
  33 struct qsd_type_info;
  34 struct qsd_fsinfo;
  35
  36 /*
  37  * A QSD instance implements quota enforcement support for a given OSD.
  38  * The instance can be created via qsd_init() and then freed with qsd_fini().
  39  * This structure gathers all quota parameters and pointers to on-disk indexes
  40  * required on quota slave to:
  41  * i. acquire/release quota space from the QMT;
  42  * ii. allocate this quota space to local requests.
  43  */
  44 struct qsd_instance {
  45         /* name of service which created this qsd instance */
  46         char                     qsd_svname[MAX_OBD_NAME];
  47
  48         /* pool ID is always 0 for now */
  49         int                      qsd_pool_id;
  50
  51         /* dt_device associated with this qsd instance */
  52         struct dt_device        *qsd_dev;
  53
  54         /* procfs directory where information related to the underlying slaves
  55          * are exported */
  56         cfs_proc_dir_entry_t    *qsd_proc;
  57
  58         /* export used for the connection to quota master */
  59         struct obd_export     *qsd_exp;
  60
  61         /* ldlm namespace used for quota locks */
  62         struct ldlm_namespace *qsd_ns;
  63
  64         /* on-disk directory where to store index files for this qsd instance */
  65         struct dt_object        *qsd_root;
  66
  67         /* We create 2 quota slave instances:
  68          * - one for user quota
  69          * - one for group quota
  70          *
  71          * This will have to be revisited if new quota types are added in the
  72          * future. For the time being, we can just use an array. */
  73         struct qsd_qtype_info   *qsd_type_array[MAXQUOTAS];
  74
  75         /* per-filesystem quota information */
  76         struct qsd_fsinfo       *qsd_fsinfo;
  77
  78         /* link into qfs_qsd_list of qfs_fsinfo */
  79         cfs_list_t               qsd_link;
  80
  81         /* list of lqe entry which might need quota space adjustment */
  82         cfs_list_t               qsd_adjust_list;
  83
  84         /* lock protecting adjust list */
  85         cfs_spinlock_t           qsd_adjust_lock;
  86
  87         /* dedicated thread for updating slave index files. */
  88         struct ptlrpc_thread     qsd_upd_thread;
  89
  90         /* list of update tasks */
  91         cfs_list_t               qsd_upd_list;
  92
  93         /* r/w spinlock protecting:
  94          * - the state flags
  95          * - the qsd update list
  96          * - the deferred list
  97          * - flags of the qsd_qtype_info */
  98         cfs_rwlock_t             qsd_lock;
  99
 100         /* Default quota settings which apply to all identifiers */
 101         /* when blk qunit reaches this value, later write reqs from client
 102          * should be sync. b=16642 */
 103         unsigned long            qsd_sync_threshold;
 104
 105         unsigned long            qsd_is_md:1,    /* managing quota for mdt */
 106                                  qsd_started:1,  /* instance is now started */
 107                                  qsd_prepared:1, /* qsd_prepare() successfully
 108                                                   * called */
 109                                  qsd_exp_valid:1,/* qsd_exp is now valid */
 110                                  qsd_stopping:1; /* qsd_instance is stopping */
 111 };
 112
 113 /*
 114  * Per-type quota information.
 115  * Quota slave instance for a specific quota type. The qsd instance has one such
 116  * structure for each quota type (i.e. user & group).
 117  */
 118 struct qsd_qtype_info {
 119         /* reference count incremented by each user of this structure */
 120         cfs_atomic_t             qqi_ref;
 121
 122         /* quota type, either USRQUOTA or GRPQUOTA
 123          * immutable after creation. */
 124         int                      qqi_qtype;
 125
 126         /* Global index FID to use for this quota type */
 127         struct lu_fid            qqi_fid;
 128
 129         /* Slave index FID allocated by the master */
 130         struct lu_fid            qqi_slv_fid;
 131
 132         /* back pointer to qsd device
 133          * immutable after creation. */
 134         struct qsd_instance     *qqi_qsd;
 135
 136         /* handle of global quota lock */
 137         struct lustre_handle     qqi_lockh;
 138
 139         /* Local index files storing quota settings for this quota type */
 140         struct dt_object        *qqi_acct_obj; /* accounting object */
 141         struct dt_object        *qqi_slv_obj;  /* slave index copy */
 142         struct dt_object        *qqi_glb_obj;  /* global index copy */
 143
 144         /* Current object versions */
 145         __u64                    qqi_slv_ver; /* slave index version */
 146         __u64                    qqi_glb_ver; /* global index version */
 147
 148         /* per quota ID information. All lquota entry are kept in a hash table
 149          * and read from disk on cache miss. */
 150         struct lquota_site      *qqi_site;
 151
 152         /* Reintegration thread */
 153         struct ptlrpc_thread     qqi_reint_thread;
 154
 155         /* statistics on operations performed by this slave */
 156         struct lprocfs_stats    *qqi_stats;
 157
 158         /* deferred update for the global index copy */
 159         cfs_list_t               qqi_deferred_glb;
 160         /* deferred update for the slave index copy */
 161         cfs_list_t               qqi_deferred_slv;
 162
 163         /* Various flags representing the current state of the slave for this
 164          * quota type. */
 165         unsigned long            qqi_glb_uptodate:1, /* global index uptodate
 166                                                         with master */
 167                                  qqi_slv_uptodate:1, /* slave index uptodate
 168                                                         with master */
 169                                  qqi_reint:1;    /* in reintegration or not */
 170
 171         /* A list of references to this instance, for debugging */
 172         struct lu_ref            qqi_reference;
 173 };
 174
 175 /*
 176  * Per-filesystem quota information
 177  * Structure tracking quota enforcement status on a per-filesystem basis
 178  */
 179 struct qsd_fsinfo {
 180         /* filesystem name */
 181         char                    qfs_name[MTI_NAME_MAXLEN];
 182
 183         /* what type of quota is enabled for each resource type. */
 184         unsigned int            qfs_enabled[LQUOTA_NR_RES];
 185
 186         /* list of all qsd_instance for this fs */
 187         cfs_list_t              qfs_qsd_list;
 188         cfs_semaphore_t         qfs_sem;
 189
 190         /* link to the global quota fsinfo list.  */
 191         cfs_list_t              qfs_link;
 192
 193         /* reference count */
 194         int                     qfs_ref;
 195 };
 196
 197 /*
 198  * Helper functions & prototypes
 199  */
 200
 201 /* helper routine to find qsd_instance associated a lquota_entry */
 202 static inline struct qsd_qtype_info *lqe2qqi(struct lquota_entry *lqe)
 203 {
 204         LASSERT(!lqe_is_master(lqe));
 205         return (struct qsd_qtype_info *)lqe->lqe_site->lqs_parent;
 206 }
 207
 208 /* qqi_getref/putref is used to track users of a qqi structure  */
 209 static inline void qqi_getref(struct qsd_qtype_info *qqi)
 210 {
 211         cfs_atomic_inc(&qqi->qqi_ref);
 212 }
 213
 214 static inline void qqi_putref(struct qsd_qtype_info *qqi)
 215 {
 216         LASSERT(cfs_atomic_read(&qqi->qqi_ref) > 0);
 217         cfs_atomic_dec(&qqi->qqi_ref);
 218 }
 219
 220 /* all kind of operations supported by qsd_dqacq() */
 221 enum qsd_ops {
 222         QSD_ADJ, /* adjust quota space based on current qunit */
 223         QSD_ACQ, /* acquire space for requests */
 224         QSD_REL, /* release all space quota space uncondionnally */
 225         QSD_REP, /* report space usage during reintegration */
 226 };
 227
 228 #define QSD_RES_TYPE(qsd) ((qsd)->qsd_is_md ? LQUOTA_RES_MD : LQUOTA_RES_DT)
 229
 230 /* udpate record for slave & global index copy */
 231 struct qsd_upd_rec {
 232         cfs_list_t              qur_link; /* link into qsd_upd_list */
 233         union lquota_id         qur_qid;
 234         union lquota_rec        qur_rec;
 235         struct qsd_qtype_info  *qur_qqi;
 236         struct lquota_entry    *qur_lqe;
 237         __u64                   qur_ver;
 238         bool                    qur_global;
 239 };
 240
 241 /* Common data shared by qsd-level handlers. This is allocated per-thread to
 242  * reduce stack consumption.  */
 243 struct qsd_thread_info {
 244         union lquota_rec                qti_rec;
 245         union lquota_id                 qti_id;
 246         struct lu_fid                   qti_fid;
 247         struct ldlm_res_id              qti_resid;
 248         struct ldlm_enqueue_info        qti_einfo;
 249         struct lustre_handle            qti_lockh;
 250         __u64                           qti_slv_ver;
 251         union ldlm_wire_lvb             qti_lvb;
 252         union {
 253                 struct quota_body       qti_body;
 254                 struct idx_info         qti_ii;
 255         };
 256         char                            qti_buf[MTI_NAME_MAXLEN];
 257 };
 258
 259 extern struct lu_context_key qsd_thread_key;
 260
 261 static inline
 262 struct qsd_thread_info *qsd_info(const struct lu_env *env)
 263 {
 264         struct qsd_thread_info *info;
 265
 266         info = lu_context_key_get(&env->le_ctx, &qsd_thread_key);
 267         if (info == NULL) {
 268                 lu_env_refill((struct lu_env *)env);
 269                 info = lu_context_key_get(&env->le_ctx, &qsd_thread_key);
 270         }
 271         LASSERT(info);
 272         return info;
 273 }
 274
 275 /* helper function to check whether a given quota type is enabled */
 276 static inline int qsd_type_enabled(struct qsd_instance *qsd, int type)
 277 {
 278         int     enabled, pool;
 279
 280         LASSERT(qsd != NULL);
 281         LASSERT(type < MAXQUOTAS);
 282
 283         if (qsd->qsd_fsinfo == NULL)
 284                 return 0;
 285
 286         pool = qsd->qsd_is_md ? LQUOTA_RES_MD : LQUOTA_RES_DT;
 287         enabled = qsd->qsd_fsinfo->qfs_enabled[pool - LQUOTA_FIRST_RES];
 288
 289         return enabled & (1 << type);
 290 }
 291
 292 /* helper function to set new qunit and compute associated qtune value */
 293 static inline void qsd_set_qunit(struct lquota_entry *lqe, __u64 qunit)
 294 {
 295         if (lqe->lqe_qunit == qunit)
 296                 return;
 297
 298         lqe->lqe_qunit = qunit;
 299
 300         /* With very large qunit support, we can't afford to have a static
 301          * qtune value, e.g. with a 1PB qunit and qtune set to 50%, we would
 302          * start pre-allocation when 512TB of free quota space remains.
 303          * Therefore, we adapt qtune depending on the actual qunit value */
 304         if (qunit == 0)                         /* if qunit is NULL           */
 305                 lqe->lqe_qtune = 0;             /*  qtune = 0                 */
 306         else if (qunit == 1024)                 /* if 1MB or 1K inodes        */
 307                 lqe->lqe_qtune = qunit >> 1;    /*  => 50%                    */
 308         else if (qunit <= 1024 * 1024)          /* up to 1GB or 1M inodes     */
 309                 lqe->lqe_qtune = qunit >> 2;    /*  => 25%                    */
 310         else if (qunit <= 4 * 1024 * 1024)      /* up to 16GB or 16M inodes   */
 311                 lqe->lqe_qtune = qunit >> 3;    /*  => 12.5%                  */
 312         else                                    /* above 4GB/4M               */
 313                 lqe->lqe_qtune = 1024 * 1024;   /*  value capped to 1GB/1M    */
 314
 315         LQUOTA_DEBUG(lqe, "changing qunit & qtune");
 316
 317         /* turn on pre-acquire when qunit is modified */
 318         lqe->lqe_nopreacq = false;
 319 }
 320
 321 #define QSD_WB_INTERVAL 15 /* 15 seconds */
 322
 323 /* qsd_entry.c */
 324 extern struct lquota_entry_operations qsd_lqe_ops;
 325 int qsd_refresh_usage(const struct lu_env *, struct lquota_entry *);
 326 int qsd_update_index(const struct lu_env *, struct qsd_qtype_info *,
 327                      union lquota_id *, bool, __u64, void *);
 328 int qsd_update_lqe(const struct lu_env *, struct lquota_entry *, bool,
 329                    void *);
 330 int qsd_write_version(const struct lu_env *, struct qsd_qtype_info *,
 331                       __u64, bool);
 332
 333 /* qsd_lock.c */
 334 extern struct ldlm_enqueue_info qsd_glb_einfo;
 335 extern struct ldlm_enqueue_info qsd_id_einfo;
 336 int qsd_id_lock_match(struct lustre_handle *, struct lustre_handle *);
 337 int qsd_id_lock_cancel(const struct lu_env *, struct lquota_entry *);
 338
 339 /* qsd_reint.c */
 340 int qsd_start_reint_thread(struct qsd_qtype_info *);
 341 void qsd_stop_reint_thread(struct qsd_qtype_info *);
 342
 343 /* qsd_request.c */
 344 typedef void (*qsd_req_completion_t) (const struct lu_env *,
 345                                       struct qsd_qtype_info *,
 346                                       struct quota_body *, struct quota_body *,
 347                                       struct lustre_handle *,
 348                                       union ldlm_wire_lvb *, void *, int);
 349 int qsd_send_dqacq(const struct lu_env *, struct obd_export *,
 350                    struct quota_body *, bool, qsd_req_completion_t,
 351                    struct qsd_qtype_info *, struct lustre_handle *,
 352                    struct lquota_entry *);
 353 int qsd_intent_lock(const struct lu_env *, struct obd_export *,
 354                     struct quota_body *, bool, int, qsd_req_completion_t,
 355                     struct qsd_qtype_info *, union ldlm_wire_lvb *, void *);
 356 int qsd_fetch_index(const struct lu_env *, struct obd_export *,
 357                     struct idx_info *, unsigned int, cfs_page_t **, bool *);
 358
 359 /* qsd_writeback.c */
 360 void qsd_bump_version(struct qsd_qtype_info *, __u64, bool);
 361 void qsd_upd_schedule(struct qsd_qtype_info *, struct lquota_entry *,
 362                       union lquota_id *, union lquota_rec *, __u64, bool);
 363 /* qsd_config.c */
 364 struct qsd_fsinfo *qsd_get_fsinfo(char *, bool);
 365 void qsd_put_fsinfo(struct qsd_fsinfo *);
 366 int qsd_process_config(struct lustre_cfg *);
 367
 368 /* qsd_handler.c */
 369 int qsd_dqacq(const struct lu_env *, struct lquota_entry *, enum qsd_ops);
 370 __u64 qsd_calc_grants(struct lquota_entry *, __u64, __u32);
 371
 372 /* qsd_writeback.c */
 373 void qsd_upd_schedule(struct qsd_qtype_info *, struct lquota_entry *,
 374                       union lquota_id *, union lquota_rec *, __u64, bool);
 375 void qsd_bump_version(struct qsd_qtype_info *, __u64, bool);
 376 int qsd_start_upd_thread(struct qsd_instance *);
 377 void qsd_stop_upd_thread(struct qsd_instance *);
 378 void qsd_adjust_schedule(struct lquota_entry *, bool, bool);
 379 #endif /* _QSD_INTERNAL_H */