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, 2013, Intel Corporation.
  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         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         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         /* how long a service thread can wait for quota space.
 106          * value dynamically computed from obd_timeout and at_max if not
 107          * enforced here (via procfs) */
 108         int                      qsd_timeout;
 109
 110         unsigned long            qsd_is_md:1,    /* managing quota for mdt */
 111                                  qsd_started:1,  /* instance is now started */
 112                                  qsd_prepared:1, /* qsd_prepare() successfully
 113                                                   * called */
 114                                  qsd_exp_valid:1,/* qsd_exp is now valid */
 115                                  qsd_stopping:1, /* qsd_instance is stopping */
 116                                  qsd_acct_failed:1; /* failed to set up acct
 117                                                      * for one quota type */
 118 };
 119
 120 /*
 121  * Per-type quota information.
 122  * Quota slave instance for a specific quota type. The qsd instance has one such
 123  * structure for each quota type (i.e. user & group).
 124  */
 125 struct qsd_qtype_info {
 126         /* reference count incremented by each user of this structure */
 127         atomic_t                 qqi_ref;
 128
 129         /* quota type, either USRQUOTA or GRPQUOTA
 130          * immutable after creation. */
 131         int                      qqi_qtype;
 132
 133         /* Global index FID to use for this quota type */
 134         struct lu_fid            qqi_fid;
 135
 136         /* Slave index FID allocated by the master */
 137         struct lu_fid            qqi_slv_fid;
 138
 139         /* back pointer to qsd device
 140          * immutable after creation. */
 141         struct qsd_instance     *qqi_qsd;
 142
 143         /* handle of global quota lock */
 144         struct lustre_handle     qqi_lockh;
 145
 146         /* Local index files storing quota settings for this quota type */
 147         struct dt_object        *qqi_acct_obj; /* accounting object */
 148         struct dt_object        *qqi_slv_obj;  /* slave index copy */
 149         struct dt_object        *qqi_glb_obj;  /* global index copy */
 150
 151         /* Current object versions */
 152         __u64                    qqi_slv_ver; /* slave index version */
 153         __u64                    qqi_glb_ver; /* global index version */
 154
 155         /* per quota ID information. All lquota entry are kept in a hash table
 156          * and read from disk on cache miss. */
 157         struct lquota_site      *qqi_site;
 158
 159         /* Reintegration thread */
 160         struct ptlrpc_thread     qqi_reint_thread;
 161
 162         /* statistics on operations performed by this slave */
 163         struct lprocfs_stats    *qqi_stats;
 164
 165         /* deferred update for the global index copy */
 166         cfs_list_t               qqi_deferred_glb;
 167         /* deferred update for the slave index copy */
 168         cfs_list_t               qqi_deferred_slv;
 169
 170         /* Various flags representing the current state of the slave for this
 171          * quota type. */
 172         unsigned long            qqi_glb_uptodate:1, /* global index uptodate
 173                                                         with master */
 174                                  qqi_slv_uptodate:1, /* slave index uptodate
 175                                                         with master */
 176                                  qqi_reint:1;    /* in reintegration or not */
 177
 178         /* A list of references to this instance, for debugging */
 179         struct lu_ref            qqi_reference;
 180 };
 181
 182 /*
 183  * Per-filesystem quota information
 184  * Structure tracking quota enforcement status on a per-filesystem basis
 185  */
 186 struct qsd_fsinfo {
 187         /* filesystem name */
 188         char                    qfs_name[MTI_NAME_MAXLEN];
 189
 190         /* what type of quota is enabled for each resource type. */
 191         unsigned int            qfs_enabled[LQUOTA_NR_RES];
 192
 193         /* list of all qsd_instance for this fs */
 194         cfs_list_t              qfs_qsd_list;
 195         struct mutex            qfs_mutex;
 196
 197         /* link to the global quota fsinfo list.  */
 198         cfs_list_t              qfs_link;
 199
 200         /* reference count */
 201         int                     qfs_ref;
 202 };
 203
 204 /*
 205  * Helper functions & prototypes
 206  */
 207
 208 /* helper routine to find qsd_instance associated a lquota_entry */
 209 static inline struct qsd_qtype_info *lqe2qqi(struct lquota_entry *lqe)
 210 {
 211         LASSERT(!lqe_is_master(lqe));
 212         return (struct qsd_qtype_info *)lqe->lqe_site->lqs_parent;
 213 }
 214
 215 /* qqi_getref/putref is used to track users of a qqi structure  */
 216 static inline void qqi_getref(struct qsd_qtype_info *qqi)
 217 {
 218         atomic_inc(&qqi->qqi_ref);
 219 }
 220
 221 static inline void qqi_putref(struct qsd_qtype_info *qqi)
 222 {
 223         LASSERT(atomic_read(&qqi->qqi_ref) > 0);
 224         atomic_dec(&qqi->qqi_ref);
 225 }
 226
 227 #define QSD_RES_TYPE(qsd) ((qsd)->qsd_is_md ? LQUOTA_RES_MD : LQUOTA_RES_DT)
 228
 229 /* udpate record for slave & global index copy */
 230 struct qsd_upd_rec {
 231         cfs_list_t              qur_link; /* link into qsd_upd_list */
 232         union lquota_id         qur_qid;
 233         union lquota_rec        qur_rec;
 234         struct qsd_qtype_info  *qur_qqi;
 235         struct lquota_entry    *qur_lqe;
 236         __u64                   qur_ver;
 237         bool                    qur_global;
 238 };
 239
 240 /* Common data shared by qsd-level handlers. This is allocated per-thread to
 241  * reduce stack consumption.  */
 242 struct qsd_thread_info {
 243         union lquota_rec                qti_rec;
 244         union lquota_id                 qti_id;
 245         struct lu_fid                   qti_fid;
 246         struct ldlm_res_id              qti_resid;
 247         struct ldlm_enqueue_info        qti_einfo;
 248         struct lustre_handle            qti_lockh;
 249         __u64                           qti_slv_ver;
 250         struct lquota_lvb               qti_lvb;
 251         union {
 252                 struct quota_body       qti_body;
 253                 struct idx_info         qti_ii;
 254         };
 255         char                            qti_buf[MTI_NAME_MAXLEN];
 256 };
 257
 258 extern struct lu_context_key qsd_thread_key;
 259
 260 static inline
 261 struct qsd_thread_info *qsd_info(const struct lu_env *env)
 262 {
 263         struct qsd_thread_info *info;
 264
 265         info = lu_context_key_get(&env->le_ctx, &qsd_thread_key);
 266         if (info == NULL) {
 267                 lu_env_refill((struct lu_env *)env);
 268                 info = lu_context_key_get(&env->le_ctx, &qsd_thread_key);
 269         }
 270         LASSERT(info);
 271         return info;
 272 }
 273
 274 /* helper function to check whether a given quota type is enabled */
 275 static inline int qsd_type_enabled(struct qsd_instance *qsd, int type)
 276 {
 277         int     enabled, pool;
 278
 279         LASSERT(qsd != NULL);
 280         LASSERT(type < MAXQUOTAS);
 281
 282         if (qsd->qsd_fsinfo == NULL)
 283                 return 0;
 284
 285         pool = qsd->qsd_is_md ? LQUOTA_RES_MD : LQUOTA_RES_DT;
 286         enabled = qsd->qsd_fsinfo->qfs_enabled[pool - LQUOTA_FIRST_RES];
 287
 288         return enabled & (1 << type);
 289 }
 290
 291 /* helper function to set new qunit and compute associated qtune value */
 292 static inline void qsd_set_qunit(struct lquota_entry *lqe, __u64 qunit)
 293 {
 294         if (lqe->lqe_qunit == qunit)
 295                 return;
 296
 297         lqe->lqe_qunit = qunit;
 298
 299         /* With very large qunit support, we can't afford to have a static
 300          * qtune value, e.g. with a 1PB qunit and qtune set to 50%, we would
 301          * start pre-allocation when 512TB of free quota space remains.
 302          * Therefore, we adapt qtune depending on the actual qunit value */
 303         if (qunit == 0)                         /* if qunit is NULL           */
 304                 lqe->lqe_qtune = 0;             /*  qtune = 0                 */
 305         else if (qunit == 1024)                 /* if 1MB or 1K inodes        */
 306                 lqe->lqe_qtune = qunit >> 1;    /*  => 50%                    */
 307         else if (qunit <= 1024 * 1024)          /* up to 1GB or 1M inodes     */
 308                 lqe->lqe_qtune = qunit >> 2;    /*  => 25%                    */
 309         else if (qunit <= 4 * 1024 * 1024)      /* up to 16GB or 16M inodes   */
 310                 lqe->lqe_qtune = qunit >> 3;    /*  => 12.5%                  */
 311         else                                    /* above 4GB/4M               */
 312                 lqe->lqe_qtune = 1024 * 1024;   /*  value capped to 1GB/1M    */
 313
 314         LQUOTA_DEBUG(lqe, "changing qunit & qtune");
 315
 316         /* turn on pre-acquire when qunit is modified */
 317         lqe->lqe_nopreacq = false;
 318 }
 319
 320 /* helper function to set/clear edquot flag */
 321 static inline void qsd_set_edquot(struct lquota_entry *lqe, bool edquot)
 322 {
 323         lqe->lqe_edquot = edquot;
 324         if (edquot)
 325                 lqe->lqe_edquot_time = cfs_time_current_64();
 326 }
 327
 328 #define QSD_WB_INTERVAL 60 /* 60 seconds */
 329
 330 /* helper function calculating how long a service thread should be waiting for
 331  * quota space */
 332 static inline int qsd_wait_timeout(struct qsd_instance *qsd)
 333 {
 334         if (qsd->qsd_timeout != 0)
 335                 return qsd->qsd_timeout;
 336         return min_t(int, at_max / 2, obd_timeout / 2);
 337 }
 338
 339 /* qsd_entry.c */
 340 extern struct lquota_entry_operations qsd_lqe_ops;
 341 int qsd_refresh_usage(const struct lu_env *, struct lquota_entry *);
 342 int qsd_update_index(const struct lu_env *, struct qsd_qtype_info *,
 343                      union lquota_id *, bool, __u64, void *);
 344 int qsd_update_lqe(const struct lu_env *, struct lquota_entry *, bool,
 345                    void *);
 346 int qsd_write_version(const struct lu_env *, struct qsd_qtype_info *,
 347                       __u64, bool);
 348
 349 /* qsd_lock.c */
 350 extern struct ldlm_enqueue_info qsd_glb_einfo;
 351 extern struct ldlm_enqueue_info qsd_id_einfo;
 352 int qsd_id_lock_match(struct lustre_handle *, struct lustre_handle *);
 353 int qsd_id_lock_cancel(const struct lu_env *, struct lquota_entry *);
 354
 355 /* qsd_reint.c */
 356 int qsd_start_reint_thread(struct qsd_qtype_info *);
 357 void qsd_stop_reint_thread(struct qsd_qtype_info *);
 358
 359 /* qsd_request.c */
 360 typedef void (*qsd_req_completion_t) (const struct lu_env *,
 361                                       struct qsd_qtype_info *,
 362                                       struct quota_body *, struct quota_body *,
 363                                       struct lustre_handle *,
 364                                       struct lquota_lvb *, void *, int);
 365 int qsd_send_dqacq(const struct lu_env *, struct obd_export *,
 366                    struct quota_body *, bool, qsd_req_completion_t,
 367                    struct qsd_qtype_info *, struct lustre_handle *,
 368                    struct lquota_entry *);
 369 int qsd_intent_lock(const struct lu_env *, struct obd_export *,
 370                     struct quota_body *, bool, int, qsd_req_completion_t,
 371                     struct qsd_qtype_info *, struct lquota_lvb *, void *);
 372 int qsd_fetch_index(const struct lu_env *, struct obd_export *,
 373                     struct idx_info *, unsigned int, struct page **, bool *);
 374
 375 /* qsd_writeback.c */
 376 void qsd_bump_version(struct qsd_qtype_info *, __u64, bool);
 377 void qsd_upd_schedule(struct qsd_qtype_info *, struct lquota_entry *,
 378                       union lquota_id *, union lquota_rec *, __u64, bool);
 379 /* qsd_config.c */
 380 struct qsd_fsinfo *qsd_get_fsinfo(char *, bool);
 381 void qsd_put_fsinfo(struct qsd_fsinfo *);
 382 int qsd_process_config(struct lustre_cfg *);
 383
 384 /* qsd_handler.c */
 385 int qsd_adjust(const struct lu_env *, struct lquota_entry *);
 386
 387 /* qsd_writeback.c */
 388 void qsd_upd_schedule(struct qsd_qtype_info *, struct lquota_entry *,
 389                       union lquota_id *, union lquota_rec *, __u64, bool);
 390 void qsd_bump_version(struct qsd_qtype_info *, __u64, bool);
 391 int qsd_start_upd_thread(struct qsd_instance *);
 392 void qsd_stop_upd_thread(struct qsd_instance *);
 393 void qsd_adjust_schedule(struct lquota_entry *, bool, bool);
 394 #endif /* _QSD_INTERNAL_H */