/* SPDX-License-Identifier: LGPL-2.1+ WITH Linux-syscall-note */
/*
 * Copyright (c) 1995-2001,2004 Silicon Graphics, Inc.  All Rights Reserved.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesset General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
#ifndef _LINUX_DQBLK_XFS_H
#define _LINUX_DQBLK_XFS_H

#include <linux/types.h>

/*
 * Disk quota - quotactl(2) commands for the XFS Quota Manager (XQM).
 */

#define XQM_CMD(x) (('X'<<8)+(x)) /* note: forms first QCMD argument */
#define XQM_COMMAND(x) (((x) & (0xff<<8)) == ('X'<<8)) /* test if for XFS */

#define XQM_USRQUOTA 0 /* system call user quota type */
#define XQM_GRPQUOTA 1 /* system call group quota type */
#define XQM_PRJQUOTA 2 /* system call project quota type */
#define XQM_MAXQUOTAS 3

#define Q_XQUOTAON XQM_CMD(1) /* enable accounting/enforcement */
#define Q_XQUOTAOFF XQM_CMD(2) /* disable accounting/enforcement */
#define Q_XGETQUOTA XQM_CMD(3) /* get disk limits and usage */
#define Q_XSETQLIM XQM_CMD(4) /* set disk limits */
#define Q_XGETQSTAT XQM_CMD(5) /* get quota subsystem status */
#define Q_XQUOTARM XQM_CMD(6) /* free disk space used by dquots */
#define Q_XQUOTASYNC XQM_CMD(7) /* delalloc flush, updates dquots */
#define Q_XGETQSTATV XQM_CMD(8) /* newer version of get quota */
#define Q_XGETNEXTQUOTA XQM_CMD(9) /* get disk limits and usage >= ID */

/*
 * fs_disk_quota structure:
 *
 * This contains the current quota information regarding a user/proj/group.
 * It is 64-bit aligned, and all the blk units are in BBs (Basic Blocks) of
 * 512 bytes.
 */
#define FS_DQUOT_VERSION 1 /* fs_disk_quota.d_version */
typedef struct fs_disk_quota {
 __s8  d_version; /* version of this structure */
 __s8  d_flags; /* FS_{USER,PROJ,GROUP}_QUOTA */
 __u16  d_fieldmask; /* field specifier */
 __u32  d_id;  /* user, project, or group ID */
 __u64  d_blk_hardlimit;/* absolute limit on disk blks */
 __u64  d_blk_softlimit;/* preferred limit on disk blks */
 __u64  d_ino_hardlimit;/* maximum # allocated inodes */
 __u64  d_ino_softlimit;/* preferred inode limit */
 __u64  d_bcount; /* # disk blocks owned by the user */
 __u64  d_icount; /* # inodes owned by the user */
 __s32  d_itimer; /* Zero if within inode limits. If
      * not, we refuse service at this time
 * (in seconds since Unix epoch) */
 __s32  d_btimer; /* similar to above; for disk blocks */
 __u16    d_iwarns;       /* # warnings issued wrt num inodes */
 __u16    d_bwarns;       /* # warnings issued wrt disk blocks */
 __s8  d_itimer_hi; /* upper 8 bits of timer values */
 __s8  d_btimer_hi;
 __s8  d_rtbtimer_hi;
 __s8  d_padding2; /* padding2 - for future use */
 __u64  d_rtb_hardlimit;/* absolute limit on realtime blks */
 __u64  d_rtb_softlimit;/* preferred limit on RT disk blks */
 __u64  d_rtbcount; /* # realtime blocks owned */
 __s32  d_rtbtimer; /* similar to above; for RT disk blks */
 __u16    d_rtbwarns;     /* # warnings issued wrt RT disk blks */
 __s16  d_padding3; /* padding3 - for future use */
 char  d_padding4[8]; /* yet more padding */
} fs_disk_quota_t;

/*
 * These fields are sent to Q_XSETQLIM to specify fields that need to change.
 */
#define FS_DQ_ISOFT (1<<0)
#define FS_DQ_IHARD (1<<1)
#define FS_DQ_BSOFT (1<<2)
#define FS_DQ_BHARD  (1<<3)
#define FS_DQ_RTBSOFT (1<<4)
#define FS_DQ_RTBHARD (1<<5)
#define FS_DQ_LIMIT_MASK (FS_DQ_ISOFT | FS_DQ_IHARD | FS_DQ_BSOFT | \
     FS_DQ_BHARD | FS_DQ_RTBSOFT | FS_DQ_RTBHARD)
/*
 * These timers can only be set in super user's dquot. For others, timers are
 * automatically started and stopped. Superusers timer values set the limits
 * for the rest.  In case these values are zero, the DQ_{F,B}TIMELIMIT values
 * defined below are used. 
 * These values also apply only to the d_fieldmask field for Q_XSETQLIM.
 */
#define FS_DQ_BTIMER (1<<6)
#define FS_DQ_ITIMER (1<<7)
#define FS_DQ_RTBTIMER  (1<<8)
#define FS_DQ_TIMER_MASK (FS_DQ_BTIMER | FS_DQ_ITIMER | FS_DQ_RTBTIMER)

/*
 * Warning counts are set in both super user's dquot and others. For others,
 * warnings are set/cleared by the administrators (or automatically by going
 * below the soft limit).  Superusers warning values set the warning limits
 * for the rest.  In case these values are zero, the DQ_{F,B}WARNLIMIT values
 * defined below are used. 
 * These values also apply only to the d_fieldmask field for Q_XSETQLIM.
 */
#define FS_DQ_BWARNS (1<<9)
#define FS_DQ_IWARNS (1<<10)
#define FS_DQ_RTBWARNS (1<<11)
#define FS_DQ_WARNS_MASK (FS_DQ_BWARNS | FS_DQ_IWARNS | FS_DQ_RTBWARNS)

/*
 * Accounting values.  These can only be set for filesystem with
 * non-transactional quotas that require quotacheck(8) in userspace.
 */
#define FS_DQ_BCOUNT  (1<<12)
#define FS_DQ_ICOUNT  (1<<13)
#define FS_DQ_RTBCOUNT  (1<<14)
#define FS_DQ_ACCT_MASK  (FS_DQ_BCOUNT | FS_DQ_ICOUNT | FS_DQ_RTBCOUNT)

/*
 * Quota expiration timestamps are 40-bit signed integers, with the upper 8
 * bits encoded in the _hi fields.
 */
#define FS_DQ_BIGTIME  (1<<15)

/*
 * Various flags related to quotactl(2).
 */
#define FS_QUOTA_UDQ_ACCT (1<<0)  /* user quota accounting */
#define FS_QUOTA_UDQ_ENFD (1<<1)  /* user quota limits enforcement */
#define FS_QUOTA_GDQ_ACCT (1<<2)  /* group quota accounting */
#define FS_QUOTA_GDQ_ENFD (1<<3)  /* group quota limits enforcement */
#define FS_QUOTA_PDQ_ACCT (1<<4)  /* project quota accounting */
#define FS_QUOTA_PDQ_ENFD (1<<5)  /* project quota limits enforcement */

#define FS_USER_QUOTA  (1<<0) /* user quota type */
#define FS_PROJ_QUOTA  (1<<1) /* project quota type */
#define FS_GROUP_QUOTA  (1<<2) /* group quota type */

/*
 * fs_quota_stat is the struct returned in Q_XGETQSTAT for a given file system.
 * Provides a centralized way to get meta information about the quota subsystem.
 * eg. space taken up for user and group quotas, number of dquots currently
 * incore.
 */
#define FS_QSTAT_VERSION 1 /* fs_quota_stat.qs_version */

/*
 * Some basic information about 'quota files'.
 */
typedef struct fs_qfilestat {
 __u64  qfs_ino; /* inode number */
 __u64  qfs_nblks; /* number of BBs 512-byte-blks */
 __u32  qfs_nextents; /* number of extents */
} fs_qfilestat_t;

typedef struct fs_quota_stat {
 __s8  qs_version; /* version number for future changes */
 __u16  qs_flags; /* FS_QUOTA_{U,P,G}DQ_{ACCT,ENFD} */
 __s8  qs_pad;  /* unused */
 fs_qfilestat_t qs_uquota; /* user quota storage information */
 fs_qfilestat_t qs_gquota; /* group quota storage information */
 __u32  qs_incoredqs; /* number of dquots incore */
 __s32  qs_btimelimit;  /* limit for blks timer */
 __s32  qs_itimelimit;  /* limit for inodes timer */
 __s32  qs_rtbtimelimit;/* limit for rt blks timer */
 __u16  qs_bwarnlimit; /* limit for num warnings */
 __u16  qs_iwarnlimit; /* limit for num warnings */
} fs_quota_stat_t;

/*
 * fs_quota_statv is used by Q_XGETQSTATV for a given file system. It provides
 * a centralized way to get meta information about the quota subsystem. eg.
 * space taken up for user, group, and project quotas, number of dquots
 * currently incore.
 *
 * This version has proper versioning support with appropriate padding for
 * future expansions, and ability to expand for future without creating any
 * backward compatibility issues.
 *
 * Q_XGETQSTATV uses the passed in value of the requested version via
 * fs_quota_statv.qs_version to determine the return data layout of
 * fs_quota_statv.  The kernel will fill the data fields relevant to that
 * version.
 *
 * If kernel does not support user space caller specified version, EINVAL will
 * be returned. User space caller can then reduce the version number and retry
 * the same command.
 */
#define FS_QSTATV_VERSION1 1 /* fs_quota_statv.qs_version */
/*
 * Some basic information about 'quota files' for Q_XGETQSTATV command
 */
struct fs_qfilestatv {
 __u64  qfs_ino; /* inode number */
 __u64  qfs_nblks; /* number of BBs 512-byte-blks */
 __u32  qfs_nextents; /* number of extents */
 __u32  qfs_pad; /* pad for 8-byte alignment */
};

struct fs_quota_statv {
 __s8   qs_version; /* version for future changes */
 __u8   qs_pad1; /* pad for 16bit alignment */
 __u16   qs_flags; /* FS_QUOTA_.* flags */
 __u32   qs_incoredqs; /* number of dquots incore */
 struct fs_qfilestatv qs_uquota; /* user quota information */
 struct fs_qfilestatv qs_gquota; /* group quota information */
 struct fs_qfilestatv qs_pquota; /* project quota information */
 __s32   qs_btimelimit;  /* limit for blks timer */
 __s32   qs_itimelimit;  /* limit for inodes timer */
 __s32   qs_rtbtimelimit;/* limit for rt blks timer */
 __u16   qs_bwarnlimit; /* limit for num warnings */
 __u16   qs_iwarnlimit; /* limit for num warnings */
 __u16   qs_rtbwarnlimit;/* limit for rt blks warnings */
 __u16   qs_pad3;
 __u32   qs_pad4;
 __u64   qs_pad2[7]; /* for future proofing */
};

#endif /* _LINUX_DQBLK_XFS_H */