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
  35 /*
  36  * A QSD instance implements quota enforcement support for a given OSD.
  37  * The instance can be created via qsd_init() and then freed with qsd_fini().
  38  * This structure gathers all quota parameters and pointers to on-disk indexes
  39  * required on quota slave to:
  40  * i. acquire/release quota space from the QMT;
  41  * ii. allocate this quota space to local requests.
  42  */
  43 struct qsd_instance {
  44         /* name of service which created this qsd instance */
  45         char                     qsd_svname[MAX_OBD_NAME];
  46
  47         /* pool ID is always 0 for now */
  48         int                      qsd_pool_id;
  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         cfs_proc_dir_entry_t    *qsd_proc;
  56
  57         /* on-disk directory where to store index files for this qsd instance */
  58         struct dt_object        *qsd_root;
  59
  60         /* We create 2 quota slave instances:
  61          * - one for user quota
  62          * - one for group quota
  63          *
  64          * This will have to be revisited if new quota types are added in the
  65          * future. For the time being, we can just use an array. */
  66         struct qsd_qtype_info   *qsd_type_array[MAXQUOTAS];
  67
  68         unsigned long            qsd_is_md:1,    /* managing quota for mdt */
  69                                  qsd_stopping:1; /* qsd_instance is stopping */
  70 };
  71
  72 /*
  73  * Per-type quota information.
  74  * Quota slave instance for a specific quota type. The qsd instance has one such
  75  * structure for each quota type (i.e. user & group).
  76  */
  77 struct qsd_qtype_info {
  78         /* reference count incremented by each user of this structure */
  79         cfs_atomic_t             qqi_ref;
  80
  81         /* quota type, either USRQUOTA or GRPQUOTA
  82          * immutable after creation. */
  83         int                      qqi_qtype;
  84
  85         /* Global index FID to use for this quota type */
  86         struct lu_fid            qqi_fid;
  87
  88         /* back pointer to qsd device
  89          * immutable after creation. */
  90         struct qsd_instance     *qqi_qsd;
  91
  92         /* Local index files storing quota settings for this quota type */
  93         struct dt_object        *qqi_acct_obj; /* accounting object */
  94         struct dt_object        *qqi_slv_obj;  /* slave index copy */
  95         struct dt_object        *qqi_glb_obj;  /* global index copy */
  96
  97         /* Current object versions */
  98         __u64                    qqi_slv_ver; /* slave index version */
  99         __u64                    qqi_glb_ver; /* global index version */
 100 };
 101
 102 /*
 103  * Helper functions & prototypes
 104  */
 105
 106 /* helper routine to find qsd_instance associated a lquota_entry */
 107 static inline struct qsd_qtype_info *lqe2qqi(struct lquota_entry *lqe)
 108 {
 109         LASSERT(!lqe_is_master(lqe));
 110         return (struct qsd_qtype_info *)lqe->lqe_site->lqs_parent;
 111 }
 112
 113 /* qqi_getref/putref is used to track users of a qqi structure  */
 114 static inline void qqi_getref(struct qsd_qtype_info *qqi)
 115 {
 116         cfs_atomic_inc(&qqi->qqi_ref);
 117 }
 118
 119 static inline void qqi_putref(struct qsd_qtype_info *qqi)
 120 {
 121         LASSERT(cfs_atomic_read(&qqi->qqi_ref) > 0);
 122         cfs_atomic_dec(&qqi->qqi_ref);
 123 }
 124
 125 #define QSD_RES_TYPE(qsd) ((qsd)->qsd_is_md ? LQUOTA_RES_MD : LQUOTA_RES_DT)
 126
 127 /* Common data shared by qsd-level handlers. This is allocated per-thread to
 128  * reduce stack consumption.  */
 129 struct qsd_thread_info {
 130         union lquota_rec                qti_rec;
 131         union lquota_id                 qti_id;
 132         struct lu_fid                   qti_fid;
 133         struct ldlm_res_id              qti_resid;
 134         struct ldlm_enqueue_info        qti_einfo;
 135         struct lustre_handle            qti_lockh;
 136         __u64                           qti_slv_ver;
 137         union ldlm_wire_lvb             qti_lvb;
 138         union {
 139                 struct quota_body       qti_body;
 140                 struct idx_info         qti_ii;
 141         };
 142         char                            qti_buf[MTI_NAME_MAXLEN];
 143 };
 144
 145 extern struct lu_context_key qsd_thread_key;
 146
 147 static inline
 148 struct qsd_thread_info *qsd_info(const struct lu_env *env)
 149 {
 150         struct qsd_thread_info *info;
 151
 152         info = lu_context_key_get(&env->le_ctx, &qsd_thread_key);
 153         if (info == NULL) {
 154                 lu_env_refill((struct lu_env *)env);
 155                 info = lu_context_key_get(&env->le_ctx, &qsd_thread_key);
 156         }
 157         LASSERT(info);
 158         return info;
 159 }
 160
 161 static inline void qsd_set_qunit(struct lquota_entry *lqe, __u64 qunit)
 162 {
 163         if (lqe->lqe_qunit == qunit)
 164                 return;
 165
 166         lqe->lqe_qunit = qunit;
 167
 168         /* With very large qunit support, we can't afford to have a static
 169          * qtune value, e.g. with a 1PB qunit and qtune set to 50%, we would
 170          * start pre-allocation when 512TB of free quota space remains.
 171          * Therefore, we adapt qtune depending on the actual qunit value */
 172         if (qunit == 0)                         /* if qunit is NULL           */
 173                 lqe->lqe_qtune = 0;             /*  qtune = 0                 */
 174         else if (qunit == 1024)                 /* if 1MB or 1K inodes        */
 175                 lqe->lqe_qtune = qunit >> 1;    /*  => 50%                    */
 176         else if (qunit <= 1024 * 1024)          /* up to 1GB or 1M inodes     */
 177                 lqe->lqe_qtune = qunit >> 2;    /*  => 25%                    */
 178         else if (qunit <= 4 * 1024 * 1024)      /* up to 16GB or 16M inodes   */
 179                 lqe->lqe_qtune = qunit >> 3;    /*  => 12.5%                  */
 180         else                                    /* above 4GB/4M               */
 181                 lqe->lqe_qtune = 1024 * 1024;   /*  value capped to 1GB/1M    */
 182
 183         LQUOTA_DEBUG(lqe, "changing qunit & qtune");
 184
 185         /* turn on pre-acquire when qunit is modified */
 186         lqe->lqe_nopreacq = false;
 187 }
 188
 189 /* qsd_entry.c */
 190 extern struct lquota_entry_operations qsd_lqe_ops;
 191 int qsd_refresh_usage(const struct lu_env *, struct lquota_entry *);
 192 int qsd_update_index(const struct lu_env *, struct qsd_qtype_info *,
 193                      union lquota_id *, bool, __u64, void *);
 194 int qsd_update_lqe(const struct lu_env *, struct lquota_entry *, bool,
 195                    void *);
 196 int qsd_write_version(const struct lu_env *, struct qsd_qtype_info *,
 197                       __u64, bool);
 198
 199 /* qsd_request.c */
 200 typedef void (*qsd_req_completion_t) (const struct lu_env *,
 201                                       struct qsd_qtype_info *,
 202                                       struct quota_body *, struct quota_body *,
 203                                       struct lustre_handle *,
 204                                       union ldlm_wire_lvb *, void *, int);
 205 int qsd_send_dqacq(const struct lu_env *, struct obd_export *,
 206                    struct quota_body *, bool, qsd_req_completion_t,
 207                    struct qsd_qtype_info *, struct lustre_handle *,
 208                    struct lquota_entry *);
 209 int qsd_intent_lock(const struct lu_env *, struct obd_export *,
 210                     struct quota_body *, bool, int, qsd_req_completion_t,
 211                     struct qsd_qtype_info *, union ldlm_wire_lvb *, void *);
 212 int qsd_fetch_index(const struct lu_env *, struct obd_export *,
 213                     struct idx_info *, unsigned int, cfs_page_t **, bool *);
 214
 215 /* qsd_writeback.c */
 216 /* XXX to be replaced with real function when reintegration landed. */
 217 static inline void qsd_bump_version(struct qsd_qtype_info *qqi, __u64 ver,
 218                                     bool global)
 219 {
 220 }
 221
 222 #endif /* _QSD_INTERNAL_H */