xnu-1699.26.8.tar.gz

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

diff --git a/bsd/sys/quota.h b/bsd/sys/quota.h
index 2e9aa080419a8cf242c978c5a14a9e7513a29cac..3693ff59212ca598052f5f38df4d795c7a9b1998 100644 (file)
--- a/bsd/sys/quota.h
+++ b/bsd/sys/quota.h
@@ -1,23 +1,29 @@
 /*
 /*

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

  *
  *

- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@

  * 
  * 

- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
+ * 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. 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.

  * 
  * 

- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * 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,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,

- * FITNESS FOR A PARTICULAR PURPOSE 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


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

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

 
 #ifdef __APPLE_API_UNSTABLE
 /*
 
 #ifdef __APPLE_API_UNSTABLE
 /*


@@ -139,9 +151,9 @@ struct dqfilehdr {
        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_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 */
+       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 */
 };
        char      dqh_string[16];       /* tag string */
        u_int32_t dqh_spare[4];         /* pad struct to power of 2 */
 };


@@ -153,12 +165,32 @@ struct dqblk {
        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_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_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 */
 };
 
        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
+ */
+
+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 */ \
 
 #define INITQMAGICS { \
        0xff31ff35,     /* USRQUOTA */ \


@@ -183,7 +215,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)


@@ -197,10 +229,10 @@ 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;
 


@@ -211,46 +243,41 @@ dqhashshift(u_long size)
 
 
 #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_OPENING     0x01    /* Q_QUOTAON  in progress */

 #define        QTF_CLOSING     0x02    /* Q_QUOTAOFF in progress */
 #define        QTF_CLOSING     0x02    /* Q_QUOTAOFF in progress */

+#define        QTF_WANTED      0x04    /* waiting for change of state */

 
 
 /*
 
 
 /*


@@ -263,23 +290,30 @@ struct dquot {
        LIST_ENTRY(dquot) dq_hash;      /* hash list */
        TAILQ_ENTRY(dquot) dq_freelist; /* free list */
        u_int16_t dq_flags;             /* flags, see below */
        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_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 */
        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 */

 };
 };

+

 /*
 /*

- * Flag values.
+ * dq_lflags 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_LLOCK        0x01            /* this quota locked (no MODS) */
+#define        DQ_LWANT        0x02            /* wakeup on unlock */
+
+/*
+ * dq_flags values
+ */
+#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.
  */


@@ -306,24 +340,36 @@ struct dquot {
 #define        CHOWN   0x02    /* (advisory) change initiated by chown */
 
 
 #define        CHOWN   0x02    /* (advisory) change initiated by chown */
 
 

+#ifdef XNU_KERNEL_PRIVATE

 /*
  * Functions that manage the in-core dquot and the
  * on-disk dqblk data structures.
  */
 __BEGIN_DECLS
 /*
  * Functions that manage the in-core dquot and the
  * on-disk dqblk data structures.
  */
 __BEGIN_DECLS

+void   dqfileinit(struct quotafile *);

 int    dqfileopen(struct quotafile *, int);
 void   dqfileclose(struct quotafile *, int);
 void   dqflush(struct vnode *);
 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 **);
+int    dqget(u_int32_t, struct quotafile *, int, struct dquot **);
+void   dqhashinit(void);

 void   dqinit(void);
 void   dqinit(void);

+int    dqisinitialized(void);

 void   dqref(struct dquot *);
 void   dqref(struct dquot *);

-void   dqrele(struct vnode *, struct dquot *);
-void   dqreclaim(struct vnode *, struct dquot *);
-int    dqsync(struct vnode *, struct dquot *);
+void   dqrele(struct dquot *);
+void   dqreclaim(struct dquot *);
+int    dqsync(struct dquot *);

 void   dqsync_orphans(struct quotafile *);
 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 /* XNU_KERNEL_PRIVATE */

 
 

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

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