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