xnu-7195.101.1.tar.gz

[apple/xnu.git] / bsd / sys / quota.h

diff --git a/bsd/sys/quota.h b/bsd/sys/quota.h
index 765ba3ac3db61b272091ba1053418f28c0b1424f..cecc86d70739a823dce44dcd927ba98c4a0e7946 100644 (file)
--- a/bsd/sys/quota.h
+++ b/bsd/sys/quota.h
@@ -1,17 +1,20 @@
 /*
 /*

- * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2019 Apple Inc. All rights reserved.
+ *
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@

  *
  *

- * @APPLE_LICENSE_HEADER_START@
- * 
- * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
- * 

  * This file contains Original Code and/or Modifications of Original Code
  * as defined in and that are subject to the Apple Public Source License
  * Version 2.0 (the 'License'). You may not use this file except in
  * This file contains Original Code and/or Modifications of Original Code
  * as defined in and that are subject to the Apple Public Source License
  * Version 2.0 (the 'License'). You may not use this file except in

- * compliance with the License. Please obtain a copy of the License at
- * http://www.opensource.apple.com/apsl/ and read it before using this
- * file.
- * 
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
+ *
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ *

  * The Original Code and all software distributed under the License are
  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * The Original Code and all software distributed under the License are
  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,


@@ -19,8 +22,8 @@
  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  * Please see the License for the specific language governing rights and
  * limitations under the License.
  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  * Please see the License for the specific language governing rights and
  * limitations under the License.

- * 
- * @APPLE_LICENSE_HEADER_END@
+ *
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@

  */
 /*
  * Copyright (c) 1982, 1986, 1993
  */
 /*
  * Copyright (c) 1982, 1986, 1993


@@ -65,6 +68,13 @@
 #define _SYS_QUOTA_H
 
 #include <sys/appleapiopts.h>
 #define _SYS_QUOTA_H
 
 #include <sys/appleapiopts.h>

+#include <sys/cdefs.h>
+#include <sys/types.h> /* u_int32_t */
+#ifdef KERNEL_PRIVATE
+#include <kern/locks.h>
+#endif
+
+#include <mach/boolean.h>

 
 #ifdef __APPLE_API_UNSTABLE
 /*
 
 #ifdef __APPLE_API_UNSTABLE
 /*


@@ -76,8 +86,8 @@
  * failure). The timer is started when the user crosses their soft limit, it
  * is reset when they go below their soft limit.
  */
  * failure). The timer is started when the user crosses their soft limit, it
  * is reset when they go below their soft limit.
  */

-#define        MAX_IQ_TIME     (7*24*60*60)    /* seconds in 1 week */
-#define        MAX_DQ_TIME     (7*24*60*60)    /* seconds in 1 week */
+#define MAX_IQ_TIME     (7*24*60*60)    /* seconds in 1 week */
+#define MAX_DQ_TIME     (7*24*60*60)    /* seconds in 1 week */

 
 /*
  * The following constants define the usage of the quota file array in the
 
 /*
  * The following constants define the usage of the quota file array in the


@@ -86,38 +96,38 @@
  * the remainder of the quota code treats them generically and need not be
  * inspected when changing the size of the array.
  */
  * the remainder of the quota code treats them generically and need not be
  * inspected when changing the size of the array.
  */

-#define        MAXQUOTAS       2
-#define        USRQUOTA        0       /* element used for user quotas */
-#define        GRPQUOTA        1       /* element used for group quotas */
+#define MAXQUOTAS       2
+#define USRQUOTA        0       /* element used for user quotas */
+#define GRPQUOTA        1       /* element used for group quotas */

 
 /*
  * Definitions for the default names of the quotas files.
  */
 #define INITQFNAMES { \
 
 /*
  * Definitions for the default names of the quotas files.
  */
 #define INITQFNAMES { \

-       "user",         /* USRQUOTA */ \
-       "group",        /* GRPQUOTA */ \
+       "user",         /* USRQUOTA */ \
+       "group",        /* GRPQUOTA */ \

        "undefined", \
 };
        "undefined", \
 };

-#define        QUOTAFILENAME   ".quota"
+#define QUOTAFILENAME   ".quota"

 #define QUOTAOPSNAME    ".quota.ops"
 #define QUOTAOPSNAME    ".quota.ops"

-#define        QUOTAGROUP      "operator"
+#define QUOTAGROUP      "operator"

 
 /*
  * Command definitions for the 'quotactl' system call.  The commands are
  * broken into a main command defined below and a subcommand that is used
  * to convey the type of quota that is being manipulated (see above).
  */
 
 /*
  * Command definitions for the 'quotactl' system call.  The commands are
  * broken into a main command defined below and a subcommand that is used
  * to convey the type of quota that is being manipulated (see above).
  */

-#define SUBCMDMASK     0x00ff
-#define SUBCMDSHIFT    8
-#define        QCMD(cmd, type) (((cmd) << SUBCMDSHIFT) | ((type) & SUBCMDMASK))
-
-#define        Q_QUOTAON       0x0100  /* enable quotas */
-#define        Q_QUOTAOFF      0x0200  /* disable quotas */
-#define        Q_GETQUOTA      0x0300  /* get limits and usage */
-#define        Q_SETQUOTA      0x0400  /* set limits and usage */
-#define        Q_SETUSE        0x0500  /* set usage */
-#define        Q_SYNC          0x0600  /* sync disk copy of a filesystems quotas */
-#define        Q_QUOTASTAT     0x0700  /* get quota on/off status */
+#define SUBCMDMASK      0x00ff
+#define SUBCMDSHIFT     8
+#define QCMD(cmd, type) (((cmd) << SUBCMDSHIFT) | ((type) & SUBCMDMASK))
+
+#define Q_QUOTAON       0x0100  /* enable quotas */
+#define Q_QUOTAOFF      0x0200  /* disable quotas */
+#define Q_GETQUOTA      0x0300  /* get limits and usage */
+#define Q_SETQUOTA      0x0400  /* set limits and usage */
+#define Q_SETUSE        0x0500  /* set usage */
+#define Q_SYNC          0x0600  /* sync disk copy of a filesystems quotas */
+#define Q_QUOTASTAT     0x0700  /* get quota on/off status */

 
 /*
  * The following two structures define the format of the disk
 
 /*
  * The following two structures define the format of the disk


@@ -137,36 +147,56 @@
  * file (a pointer is retained in the filesystem  mount structure).
  */
 struct dqfilehdr {
  * file (a pointer is retained in the filesystem  mount structure).
  */
 struct dqfilehdr {

-       u_int32_t dqh_magic;            
-       u_int32_t dqh_version;          /* == QF_VERSION */
-       u_int32_t dqh_maxentries;       /* must be a power of 2 */
-       u_int32_t dqh_entrycnt;         /* count of active entries */
-       u_int32_t dqh_flags;            /* reserved for now (0) */
-       time_t    dqh_chktime;          /* time of last quota check */
-       time_t    dqh_btime;            /* time limit for excessive disk use */
-       time_t    dqh_itime;            /* time limit for excessive files */
-       char      dqh_string[16];       /* tag string */
-       u_int32_t dqh_spare[4];         /* pad struct to power of 2 */
+       u_int32_t dqh_magic;
+       u_int32_t dqh_version;          /* == QF_VERSION */
+       u_int32_t dqh_maxentries;       /* must be a power of 2 */
+       u_int32_t dqh_entrycnt;         /* count of active entries */
+       u_int32_t dqh_flags;            /* reserved for now (0) */
+       u_int32_t dqh_chktime;          /* time of last quota check */
+       u_int32_t dqh_btime;            /* time limit for excessive disk use */
+       u_int32_t dqh_itime;            /* time limit for excessive files */
+       char      dqh_string[16];       /* tag string */
+       u_int32_t dqh_spare[4];         /* pad struct to power of 2 */

 };
 
 struct dqblk {
 };
 
 struct dqblk {

-       u_int64_t dqb_bhardlimit;       /* absolute limit on disk bytes alloc */
-       u_int64_t dqb_bsoftlimit;       /* preferred limit on disk bytes */
-       u_int64_t dqb_curbytes;         /* current byte count */
-       u_int32_t dqb_ihardlimit;       /* maximum # allocated inodes + 1 */
-       u_int32_t dqb_isoftlimit;       /* preferred inode limit */
-       u_int32_t dqb_curinodes;        /* current # allocated inodes */
-       time_t    dqb_btime;            /* time limit for excessive disk use */
-       time_t    dqb_itime;            /* time limit for excessive files */
-       u_int32_t dqb_id;               /* identifier (0 for empty entries) */
-       u_int32_t dqb_spare[4];         /* pad struct to power of 2 */
+       u_int64_t dqb_bhardlimit;       /* absolute limit on disk bytes alloc */
+       u_int64_t dqb_bsoftlimit;       /* preferred limit on disk bytes */
+       u_int64_t dqb_curbytes;         /* current byte count */
+       u_int32_t dqb_ihardlimit;       /* maximum # allocated inodes + 1 */
+       u_int32_t dqb_isoftlimit;       /* preferred inode limit */
+       u_int32_t dqb_curinodes;        /* current # allocated inodes */
+       u_int32_t dqb_btime;            /* time limit for excessive disk use */
+       u_int32_t dqb_itime;            /* time limit for excessive files */
+       u_int32_t dqb_id;               /* identifier (0 for empty entries) */
+       u_int32_t dqb_spare[4];         /* pad struct to power of 2 */

 };
 
 };
 

+#ifdef KERNEL_PRIVATE
+#include <machine/types.h>      /* user_time_t */
+/* LP64 version of struct dqblk.  time_t is a long and must grow when
+ * we're dealing with a 64-bit process.
+ * WARNING - keep in sync with struct dqblk
+ */

 
 

-#define INITQMAGICS { \
-       0xff31ff35,     /* USRQUOTA */ \
-       0xff31ff27,     /* GRPQUOTA */ \
+struct user_dqblk {
+       u_int64_t dqb_bhardlimit;       /* absolute limit on disk bytes alloc */
+       u_int64_t dqb_bsoftlimit;       /* preferred limit on disk bytes */
+       u_int64_t dqb_curbytes;         /* current byte count */
+       u_int32_t dqb_ihardlimit;       /* maximum # allocated inodes + 1 */
+       u_int32_t dqb_isoftlimit;       /* preferred inode limit */
+       u_int32_t dqb_curinodes;        /* current # allocated inodes */
+       u_int32_t dqb_btime;            /* time limit for excessive disk use */
+       u_int32_t dqb_itime;            /* time limit for excessive files */
+       u_int32_t dqb_id;               /* identifier (0 for empty entries) */
+       u_int32_t dqb_spare[4];         /* pad struct to power of 2 */

 };
 };

+#endif  /* KERNEL_PRIVATE */
+
+#define INITQMAGICS { \
+       0xff31ff35,     /* USRQUOTA */ \
+       0xff31ff27,     /* GRPQUOTA */ \
+}

 
 #define QF_VERSION          1
 #define QF_STRING_TAG       "QUOTA HASH FILE"
 
 #define QF_VERSION          1
 #define QF_STRING_TAG       "QUOTA HASH FILE"


@@ -186,7 +216,7 @@ struct dqblk {
  * golden ratio to the machine's word size.
  */
 #define dqhash1(id, shift, mask)  \
  * golden ratio to the machine's word size.
  */
 #define dqhash1(id, shift, mask)  \

-       ((((id) * 2654435761UL) >> (shift)) & (mask))
+       ((((id) * 2654435761U) >> (shift)) & (mask))

 
 #define dqhash2(id, mask)  \
        (dqhash1((id), 11, (mask)>>1) | 1)
 
 #define dqhash2(id, mask)  \
        (dqhash1((id), 11, (mask)>>1) | 1)


@@ -200,60 +230,56 @@ struct dqblk {
  * Compute the hash shift value.
  * It is the word size, in bits, minus the hash table size, in bits.
  */
  * Compute the hash shift value.
  * It is the word size, in bits, minus the hash table size, in bits.
  */

-static __inline int dqhashshift(u_long);
+static __inline int dqhashshift(u_int32_t);

 
 static __inline int
 
 static __inline int

-dqhashshift(u_long size)
+dqhashshift(u_int32_t size)

 {
        int shift;
 
 {
        int shift;
 

-       for (shift = 32; size > 1; size >>= 1, --shift)
+       for (shift = 32; size > 1; size >>= 1, --shift) {

                continue;
                continue;

-       return (shift);
+       }
+       return shift;

 }
 
 
 #ifndef KERNEL
 }
 
 
 #ifndef KERNEL

-
-#include <sys/cdefs.h>
-

 __BEGIN_DECLS
 __BEGIN_DECLS

-int quotactl __P((char *, int, int, caddr_t));
+int quotactl(const char *, int, int, caddr_t);

 __END_DECLS
 #endif /* !KERNEL */
 
 __END_DECLS
 #endif /* !KERNEL */
 

-#ifdef KERNEL
+#ifdef KERNEL_PRIVATE

 #include <sys/queue.h>
 
 #include <sys/queue.h>
 

-/*
- * Macros to avoid subroutine calls to trivial functions.
- */
-#if DIAGNOSTIC
-#define        DQREF(dq)       dqref(dq)
-#else
-#define        DQREF(dq)       (dq)->dq_cnt++
-#endif

 
 
 /* Quota file info
  */
 struct quotafile {
 
 
 /* Quota file info
  */
 struct quotafile {

+       lck_mtx_t     qf_lock;       /* quota file mutex */

        struct vnode *qf_vp;         /* quota file vnode */
        struct vnode *qf_vp;         /* quota file vnode */

-       struct ucred *qf_cred;       /* quota file access cred */
+       kauth_cred_t  qf_cred;       /* quota file access cred */

        int           qf_shift;      /* primary hash shift */
        int           qf_maxentries; /* size of hash table (power of 2) */
        int           qf_shift;      /* primary hash shift */
        int           qf_maxentries; /* size of hash table (power of 2) */

-       int           qf_entrycnt;  /* count of active entries */
-       time_t        qf_btime;      /* block quota time limit */
-       time_t        qf_itime;      /* inode quota time limit */
+       int           qf_entrycnt;   /* count of active entries */
+       u_int32_t     qf_btime;      /* block quota time limit */
+       u_int32_t     qf_itime;      /* inode quota time limit */
+
+       /* the following 2 fields are protected */
+       /* by the quota list lock  */

        char          qf_qflags;     /* quota specific flags */
        char          qf_qflags;     /* quota specific flags */

+       int           qf_refcnt;     /* count of dquot refs on this file */

 };
 
 /*
  * Flags describing the runtime state of quotas.
  * (in qf_qflags)
  */
 };
 
 /*
  * Flags describing the runtime state of quotas.
  * (in qf_qflags)
  */

-#define        QTF_OPENING     0x01    /* Q_QUOTAON in progress */
-#define        QTF_CLOSING     0x02    /* Q_QUOTAOFF in progress */
+#define QTF_OPENING     0x01    /* Q_QUOTAON  in progress */
+#define QTF_CLOSING     0x02    /* Q_QUOTAOFF in progress */
+#define QTF_WANTED      0x04    /* waiting for change of state */

 
 
 /*
 
 
 /*


@@ -263,50 +289,57 @@ struct quotafile {
  * used entries.
  */
 struct dquot {
  * used entries.
  */
 struct dquot {

-       LIST_ENTRY(dquot) dq_hash;      /* hash list */
-       TAILQ_ENTRY(dquot) dq_freelist; /* free list */
-       u_int16_t dq_flags;             /* flags, see below */
-       u_int16_t dq_cnt;               /* count of active references */
-       u_int16_t dq_spare;             /* unused spare padding */
-       u_int16_t dq_type;              /* quota type of this dquot */
-       u_int32_t dq_id;                /* identifier this applies to */
-       u_int32_t dq_index;             /* index into quota file */
-       struct  quotafile *dq_qfile;    /* quota file that this is taken from */
-       struct  dqblk dq_dqb;           /* actual usage & quotas */
+       LIST_ENTRY(dquot) dq_hash;      /* hash list */
+       TAILQ_ENTRY(dquot) dq_freelist; /* free list */
+       u_int16_t dq_flags;             /* flags, see below */
+       u_int16_t dq_cnt_unused;        /* Replaced by dq_cnt below */
+       u_int16_t dq_lflags;            /* protected by the quota list lock */
+       u_int16_t dq_type;              /* quota type of this dquot */
+       u_int32_t dq_id;                /* identifier this applies to */
+       u_int32_t dq_index;             /* index into quota file */
+       struct  quotafile *dq_qfile;    /* quota file that this is taken from */
+       struct  dqblk dq_dqb;           /* actual usage & quotas */
+       uint32_t  dq_cnt;               /* count of active references */

 };
 };

+
+/*
+ * dq_lflags values
+ */
+#define DQ_LLOCK        0x01            /* this quota locked (no MODS) */
+#define DQ_LWANT        0x02            /* wakeup on unlock */
+

 /*
 /*

- * Flag values.
+ * dq_flags values

  */
  */

-#define        DQ_LOCK         0x01            /* this quota locked (no MODS) */
-#define        DQ_WANT         0x02            /* wakeup on unlock */
-#define        DQ_MOD          0x04            /* this quota modified since read */
-#define        DQ_FAKE         0x08            /* no limits here, just usage */
-#define        DQ_BLKS         0x10            /* has been warned about blk limit */
-#define        DQ_INODS        0x20            /* has been warned about inode limit */
+#define DQ_MOD          0x01            /* this quota modified since read */
+#define DQ_FAKE         0x02            /* no limits here, just usage */
+#define DQ_BLKS         0x04            /* has been warned about blk limit */
+#define DQ_INODS        0x08            /* has been warned about inode limit */
+

 /*
  * Shorthand notation.
  */
 /*
  * Shorthand notation.
  */

-#define        dq_bhardlimit   dq_dqb.dqb_bhardlimit
-#define        dq_bsoftlimit   dq_dqb.dqb_bsoftlimit
-#define        dq_curbytes     dq_dqb.dqb_curbytes
-#define        dq_ihardlimit   dq_dqb.dqb_ihardlimit
-#define        dq_isoftlimit   dq_dqb.dqb_isoftlimit
-#define        dq_curinodes    dq_dqb.dqb_curinodes
-#define        dq_btime        dq_dqb.dqb_btime
-#define        dq_itime        dq_dqb.dqb_itime
+#define dq_bhardlimit   dq_dqb.dqb_bhardlimit
+#define dq_bsoftlimit   dq_dqb.dqb_bsoftlimit
+#define dq_curbytes     dq_dqb.dqb_curbytes
+#define dq_ihardlimit   dq_dqb.dqb_ihardlimit
+#define dq_isoftlimit   dq_dqb.dqb_isoftlimit
+#define dq_curinodes    dq_dqb.dqb_curinodes
+#define dq_btime        dq_dqb.dqb_btime
+#define dq_itime        dq_dqb.dqb_itime

 
 /*
  * If the system has never checked for a quota for this file, then it is
  * set to NODQUOT.  Once a write attempt is made the inode pointer is set
  * to reference a dquot structure.
  */
 
 /*
  * If the system has never checked for a quota for this file, then it is
  * set to NODQUOT.  Once a write attempt is made the inode pointer is set
  * to reference a dquot structure.
  */

-#define        NODQUOT         NULL
+#define NODQUOT         NULL

 
 /*
  * Flags to chkdq() and chkiq()
  */
 
 /*
  * Flags to chkdq() and chkiq()
  */

-#define        FORCE   0x01    /* force usage changes independent of limits */
-#define        CHOWN   0x02    /* (advisory) change initiated by chown */
+#define FORCE   0x01    /* force usage changes independent of limits */
+#define CHOWN   0x02    /* (advisory) change initiated by chown */

 
 
 /*
 
 
 /*


@@ -314,19 +347,28 @@ struct dquot {
  * on-disk dqblk data structures.
  */
 __BEGIN_DECLS
  * on-disk dqblk data structures.
  */
 __BEGIN_DECLS

-int    dqfileopen(struct quotafile *, int);
-void   dqfileclose(struct quotafile *, int);
-void   dqflush(struct vnode *);
-int    dqget(struct vnode *, u_long, struct quotafile *, int, struct dquot **);
-void   dqinit(void);
-void   dqref(struct dquot *);
-void   dqrele(struct vnode *, struct dquot *);
-void   dqreclaim(struct vnode *, struct dquot *);
-int    dqsync(struct vnode *, struct dquot *);
-void   dqsync_orphans(struct quotafile *);
+void    dqfileinit(struct quotafile *);
+int     dqfileopen(struct quotafile *, int);
+void    dqfileclose(struct quotafile *, int);
+void    dqflush(struct vnode *);
+int     dqget(u_int32_t, struct quotafile *, int, struct dquot **);
+void    dqhashinit(void);
+int     dqisinitialized(void);
+void    dqref(struct dquot *);
+void    dqrele(struct dquot *);
+void    dqreclaim(struct dquot *);
+int     dqsync(struct dquot *);
+void    dqsync_orphans(struct quotafile *);
+void    dqlock(struct dquot *);
+void    dqunlock(struct dquot *);
+
+int     qf_get(struct quotafile *, int type);
+void    qf_put(struct quotafile *, int type);
+
+__private_extern__ void  munge_dqblk(struct dqblk *dqblkp, struct user_dqblk *user_dqblkp, boolean_t to64);

 __END_DECLS
 
 __END_DECLS
 

-#endif /* KERNEL */
+#endif /* KERNEL_PRIVATE */

 
 #endif /* __APPLE_API_UNSTABLE */
 
 
 #endif /* __APPLE_API_UNSTABLE */