fs/xfs/quota/xfs_qm.h

   1 /*
   2  * Copyright (c) 2000-2003 Silicon Graphics, Inc.  All Rights Reserved.
   3  *
   4  * This program is free software; you can redistribute it and/or modify it
   5  * under the terms of version 2 of the GNU General Public License as
   6  * published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it would be useful, but
   9  * WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  11  *
  12  * Further, this software is distributed without any warranty that it is
  13  * free of the rightful claim of any third person regarding infringement
  14  * or the like.  Any license provided herein, whether implied or
  15  * otherwise, applies only to this software file.  Patent licenses, if
  16  * any, provided herein do not apply to combinations of this program with
  17  * other software, or any other product whatsoever.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write the Free Software Foundation, Inc., 59
  21  * Temple Place - Suite 330, Boston MA 02111-1307, USA.
  22  *
  23  * Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
  24  * Mountain View, CA  94043, or:
  25  *
  26  * http://www.sgi.com
  27  *
  28  * For further information regarding this notice, see:
  29  *
  30  * http://oss.sgi.com/projects/GenInfo/SGIGPLNoticeExplan/
  31  */
  32 #ifndef __XFS_QM_H__
  33 #define __XFS_QM_H__
  34
  35 #include "xfs_dquot_item.h"
  36 #include "xfs_dquot.h"
  37 #include "xfs_quota_priv.h"
  38 #include "xfs_qm_stats.h"
  39
  40 struct xfs_qm;
  41 struct xfs_inode;
  42
  43 extern mutex_t          xfs_Gqm_lock;
  44 extern struct xfs_qm    *xfs_Gqm;
  45 extern kmem_zone_t      *qm_dqzone;
  46 extern kmem_zone_t      *qm_dqtrxzone;
  47
  48 /*
  49  * Used in xfs_qm_sync called by xfs_sync to count the max times that it can
  50  * iterate over the mountpt's dquot list in one call.
  51  */
  52 #define XFS_QM_SYNC_MAX_RESTARTS        7
  53
  54 /*
  55  * Ditto, for xfs_qm_dqreclaim_one.
  56  */
  57 #define XFS_QM_RECLAIM_MAX_RESTARTS     4
  58
  59 /*
  60  * Ideal ratio of free to in use dquots. Quota manager makes an attempt
  61  * to keep this balance.
  62  */
  63 #define XFS_QM_DQFREE_RATIO             2
  64
  65 /*
  66  * Dquot hashtable constants/threshold values.
  67  */
  68 #define XFS_QM_NCSIZE_THRESHOLD         5000
  69 #define XFS_QM_HASHSIZE_LOW             32
  70 #define XFS_QM_HASHSIZE_HIGH            64
  71
  72 /*
  73  * We output a cmn_err when quotachecking a quota file with more than
  74  * this many fsbs.
  75  */
  76 #define XFS_QM_BIG_QCHECK_NBLKS         500
  77
  78 /*
  79  * This defines the unit of allocation of dquots.
  80  * Currently, it is just one file system block, and a 4K blk contains 30
  81  * (136 * 30 = 4080) dquots. It's probably not worth trying to make
  82  * this more dynamic.
  83  * XXXsup However, if this number is changed, we have to make sure that we don't
  84  * implicitly assume that we do allocations in chunks of a single filesystem
  85  * block in the dquot/xqm code.
  86  */
  87 #define XFS_DQUOT_CLUSTER_SIZE_FSB      (xfs_filblks_t)1
  88 /*
  89  * When doing a quotacheck, we log dquot clusters of this many FSBs at most
  90  * in a single transaction. We don't want to ask for too huge a log reservation.
  91  */
  92 #define XFS_QM_MAX_DQCLUSTER_LOGSZ      3
  93
  94 typedef xfs_dqhash_t    xfs_dqlist_t;
  95 /*
  96  * The freelist head. The first two fields match the first two in the
  97  * xfs_dquot_t structure (in xfs_dqmarker_t)
  98  */
  99 typedef struct xfs_frlist {
 100        struct xfs_dquot *qh_next;
 101        struct xfs_dquot *qh_prev;
 102        mutex_t           qh_lock;
 103        uint              qh_version;
 104        uint              qh_nelems;
 105 } xfs_frlist_t;
 106
 107 /*
 108  * Quota Manager (global) structure. Lives only in core.
 109  */
 110 typedef struct xfs_qm {
 111         xfs_dqlist_t    *qm_usr_dqhtable;/* udquot hash table */
 112         xfs_dqlist_t    *qm_grp_dqhtable;/* gdquot hash table */
 113         uint             qm_dqhashmask;  /* # buckets in dq hashtab - 1 */
 114         xfs_frlist_t     qm_dqfreelist;  /* freelist of dquots */
 115         atomic_t         qm_totaldquots; /* total incore dquots */
 116         uint             qm_nrefs;       /* file systems with quota on */
 117         int              qm_dqfree_ratio;/* ratio of free to inuse dquots */
 118         kmem_zone_t     *qm_dqzone;      /* dquot mem-alloc zone */
 119         kmem_zone_t     *qm_dqtrxzone;   /* t_dqinfo of transactions */
 120 } xfs_qm_t;
 121
 122 /*
 123  * Various quota information for individual filesystems.
 124  * The mount structure keeps a pointer to this.
 125  */
 126 typedef struct xfs_quotainfo {
 127         xfs_inode_t     *qi_uquotaip;    /* user quota inode */
 128         xfs_inode_t     *qi_gquotaip;    /* group quota inode */
 129         lock_t           qi_pinlock;     /* dquot pinning mutex */
 130         xfs_dqlist_t     qi_dqlist;      /* all dquots in filesys */
 131         int              qi_dqreclaims;  /* a change here indicates
 132                                             a removal in the dqlist */
 133         time_t           qi_btimelimit;  /* limit for blks timer */
 134         time_t           qi_itimelimit;  /* limit for inodes timer */
 135         time_t           qi_rtbtimelimit;/* limit for rt blks timer */
 136         xfs_qwarncnt_t   qi_bwarnlimit;  /* limit for num warnings */
 137         xfs_qwarncnt_t   qi_iwarnlimit;  /* limit for num warnings */
 138         mutex_t          qi_quotaofflock;/* to serialize quotaoff */
 139         /* Some useful precalculated constants */
 140         xfs_filblks_t    qi_dqchunklen;  /* # BBs in a chunk of dqs */
 141         uint             qi_dqperchunk;  /* # ondisk dqs in above chunk */
 142 } xfs_quotainfo_t;
 143
 144
 145 extern xfs_dqtrxops_t   xfs_trans_dquot_ops;
 146
 147 extern void     xfs_trans_mod_dquot(xfs_trans_t *, xfs_dquot_t *, uint, long);
 148 extern int      xfs_trans_reserve_quota_bydquots(xfs_trans_t *, xfs_mount_t *,
 149                         xfs_dquot_t *, xfs_dquot_t *, long, long, uint);
 150 extern void     xfs_trans_dqjoin(xfs_trans_t *, xfs_dquot_t *);
 151 extern void     xfs_trans_log_dquot(xfs_trans_t *, xfs_dquot_t *);
 152
 153 /*
 154  * We keep the usr and grp dquots separately so that locking will be easier
 155  * to do at commit time. All transactions that we know of at this point
 156  * affect no more than two dquots of one type. Hence, the TRANS_MAXDQS value.
 157  */
 158 #define XFS_QM_TRANS_MAXDQS             2
 159 typedef struct xfs_dquot_acct {
 160         xfs_dqtrx_t     dqa_usrdquots[XFS_QM_TRANS_MAXDQS];
 161         xfs_dqtrx_t     dqa_grpdquots[XFS_QM_TRANS_MAXDQS];
 162 } xfs_dquot_acct_t;
 163
 164 /*
 165  * Users are allowed to have a usage exceeding their softlimit for
 166  * a period this long.
 167  */
 168 #define XFS_QM_BTIMELIMIT       (7 * 24*60*60)          /* 1 week */
 169 #define XFS_QM_RTBTIMELIMIT     (7 * 24*60*60)          /* 1 week */
 170 #define XFS_QM_ITIMELIMIT       (7 * 24*60*60)          /* 1 week */
 171
 172 #define XFS_QM_BWARNLIMIT       5
 173 #define XFS_QM_IWARNLIMIT       5
 174
 175 #define XFS_QM_LOCK(xqm)        (mutex_lock(&xqm##_lock, PINOD))
 176 #define XFS_QM_UNLOCK(xqm)      (mutex_unlock(&xqm##_lock))
 177 #define XFS_QM_HOLD(xqm)        ((xqm)->qm_nrefs++)
 178 #define XFS_QM_RELE(xqm)        ((xqm)->qm_nrefs--)
 179
 180 extern int              xfs_qm_init_quotainfo(xfs_mount_t *);
 181 extern void             xfs_qm_destroy_quotainfo(xfs_mount_t *);
 182 extern int              xfs_qm_mount_quotas(xfs_mount_t *);
 183 extern void             xfs_qm_mount_quotainit(xfs_mount_t *, uint);
 184 extern void             xfs_qm_unmount_quotadestroy(xfs_mount_t *);
 185 extern int              xfs_qm_unmount_quotas(xfs_mount_t *);
 186 extern int              xfs_qm_write_sb_changes(xfs_mount_t *, __int64_t);
 187 extern int              xfs_qm_sync(xfs_mount_t *, short);
 188
 189 /* dquot stuff */
 190 extern void             xfs_qm_dqunlink(xfs_dquot_t *);
 191 extern boolean_t        xfs_qm_dqalloc_incore(xfs_dquot_t **);
 192 extern int              xfs_qm_dqattach(xfs_inode_t *, uint);
 193 extern void             xfs_qm_dqdetach(xfs_inode_t *);
 194 extern int              xfs_qm_dqpurge_all(xfs_mount_t *, uint);
 195 extern void             xfs_qm_dqrele_all_inodes(xfs_mount_t *, uint);
 196
 197 /* vop stuff */
 198 extern int              xfs_qm_vop_dqalloc(xfs_mount_t *, xfs_inode_t *,
 199                                         uid_t, gid_t, uint,
 200                                         xfs_dquot_t **, xfs_dquot_t **);
 201 extern void             xfs_qm_vop_dqattach_and_dqmod_newinode(
 202                                         xfs_trans_t *, xfs_inode_t *,
 203                                         xfs_dquot_t *, xfs_dquot_t *);
 204 extern int              xfs_qm_vop_rename_dqattach(xfs_inode_t **);
 205 extern xfs_dquot_t *    xfs_qm_vop_chown(xfs_trans_t *, xfs_inode_t *,
 206                                         xfs_dquot_t **, xfs_dquot_t *);
 207 extern int              xfs_qm_vop_chown_reserve(xfs_trans_t *, xfs_inode_t *,
 208                                         xfs_dquot_t *, xfs_dquot_t *, uint);
 209
 210 /* list stuff */
 211 extern void             xfs_qm_freelist_init(xfs_frlist_t *);
 212 extern void             xfs_qm_freelist_destroy(xfs_frlist_t *);
 213 extern void             xfs_qm_freelist_insert(xfs_frlist_t *, xfs_dquot_t *);
 214 extern void             xfs_qm_freelist_append(xfs_frlist_t *, xfs_dquot_t *);
 215 extern void             xfs_qm_freelist_unlink(xfs_dquot_t *);
 216 extern int              xfs_qm_freelist_lock_nowait(xfs_qm_t *);
 217 extern int              xfs_qm_mplist_nowait(xfs_mount_t *);
 218 extern int              xfs_qm_dqhashlock_nowait(xfs_dquot_t *);
 219
 220 /* system call interface */
 221 extern int              xfs_qm_quotactl(bhv_desc_t *, int, int, xfs_caddr_t);
 222
 223 #ifdef DEBUG
 224 extern int              xfs_qm_internalqcheck(xfs_mount_t *);
 225 #else
 226 #define xfs_qm_internalqcheck(mp)       (0)
 227 #endif
 228
 229 #endif /* __XFS_QM_H__ */