File: [Development] / xfs-cmds / xfsprogs / include / xfs_fs.h (download)
Revision 1.9, Sun Oct 14 07:09:57 2001 UTC (16 years ago) by nathans
Branch: MAIN
Changes since 1.8: +64 -55
lines
cleanup comments refering to syssgi/fcntl specifics from IRIX.
add in the two new calls for EAs (basically revert to IRIX mechanism),
and add comments to the affect that attrctl interface will go away in
the future. tidy io error calls - these have no need to be conditional
here - should be done elsewhere (and now is).
|
/*
* Copyright (c) 2000 Silicon Graphics, Inc. All Rights Reserved.
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of version 2 of the GNU General Public License as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it would be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*
* Further, this software is distributed without any warranty that it is
* free of the rightful claim of any third person regarding infringement
* or the like. Any license provided herein, whether implied or
* otherwise, applies only to this software file. Patent licenses, if
* any, provided herein do not apply to combinations of this program with
* other software, or any other product whatsoever.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write the Free Software Foundation, Inc., 59
* Temple Place - Suite 330, Boston MA 02111-1307, USA.
*
* Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
* Mountain View, CA 94043, or:
*
* http://www.sgi.com
*
* For further information regarding this notice, see:
*
* http://oss.sgi.com/projects/GenInfo/SGIGPLNoticeExplan/
*/
#ifndef _LINUX_XFS_FS_H
#define _LINUX_XFS_FS_H
#include <linux/types.h>
#include <asm/ioctl.h>
/*
* SGI's XFS filesystem's major stuff (constants, structures)
*/
#define XFS_SUPER_MAGIC 0x58465342
#define XFS_NAME "xfs"
struct biosize {
__u32 biosz_flags;
__s32 biosz_read;
__s32 biosz_write;
__s32 dfl_biosz_read;
__s32 dfl_biosz_write;
};
/*
* Direct I/O attribute record used with XFS_IOC_DIOINFO
* d_miniosz is the min xfer size, xfer size multiple and file seek offset
* alignment.
*/
struct dioattr {
__u32 d_mem; /* data buffer memory alignment */
__u32 d_miniosz; /* min xfer size */
__u32 d_maxiosz; /* max xfer size */
};
/*
* Structure for XFS_IOC_FSGETXATTR[A] and XFS_IOC_FSSETXATTR.
*/
struct fsxattr {
__u32 fsx_xflags; /* xflags field value (get/set) */
__u32 fsx_extsize; /* extsize field value (get/set)*/
__u32 fsx_nextents; /* nextents field value (get) */
unsigned char fsx_pad[16];
};
/*
* Flags for the bs_xflags/fsx_xflags field
* There should be a one-to-one correspondence between these flags and the
* XFS_DIFLAG_s.
*/
#define XFS_XFLAG_REALTIME 0x00000001
#define XFS_XFLAG_PREALLOC 0x00000002
#define XFS_XFLAG_HASATTR 0x80000000 /* no DIFLAG for this */
#define XFS_XFLAG_ALL \
( XFS_XFLAG_REALTIME|XFS_XFLAG_PREALLOC|XFS_XFLAG_HASATTR )
/*
* Structure for XFS_IOC_GETBMAP.
* On input, fill in bmv_offset and bmv_length of the first structure
* to indicate the area of interest in the file, and bmv_entry with the
* number of array elements given. The first structure is updated on
* return to give the offset and length for the next call.
*/
struct getbmap {
__s64 bmv_offset; /* file offset of segment in blocks */
__s64 bmv_block; /* starting block (64-bit daddr_t) */
__s64 bmv_length; /* length of segment, blocks */
__s32 bmv_count; /* # of entries in array incl. 1st */
__s32 bmv_entries; /* # of entries filled in (output) */
};
/*
* Structure for XFS_IOC_GETBMAPX. Fields bmv_offset through bmv_entries
* are used exactly as in the getbmap structure. The getbmapx structure
* has additional bmv_iflags and bmv_oflags fields. The bmv_iflags field
* is only used for the first structure. It contains input flags
* specifying XFS_IOC_GETBMAPX actions. The bmv_oflags field is filled
* in by the XFS_IOC_GETBMAPX command for each returned structure after
* the first.
*/
struct getbmapx {
__s64 bmv_offset; /* file offset of segment in blocks */
__s64 bmv_block; /* starting block (64-bit daddr_t) */
__s64 bmv_length; /* length of segment, blocks */
__s32 bmv_count; /* # of entries in array incl. 1st */
__s32 bmv_entries; /* # of entries filled in (output). */
__s32 bmv_iflags; /* input flags (1st structure) */
__s32 bmv_oflags; /* output flags (after 1st structure)*/
__s32 bmv_unused1; /* future use */
__s32 bmv_unused2; /* future use */
};
/* bmv_iflags values - set by XFS_IOC_GETBMAPX caller. */
#define BMV_IF_ATTRFORK 0x1 /* return attr fork rather than data */
#define BMV_IF_NO_DMAPI_READ 0x2 /* Do not generate DMAPI read event */
#define BMV_IF_PREALLOC 0x4 /* rtn status BMV_OF_PREALLOC if req */
#define BMV_IF_VALID (BMV_IF_ATTRFORK|BMV_IF_NO_DMAPI_READ|BMV_IF_PREALLOC)
#ifdef __KERNEL__
#define BMV_IF_EXTENDED 0x40000000 /* getpmapx if set */
#endif
/* bmv_oflags values - returned for for each non-header segment */
#define BMV_OF_PREALLOC 0x1 /* segment = unwritten pre-allocation */
/* Convert getbmap <-> getbmapx - move fields from p1 to p2. */
#define GETBMAP_CONVERT(p1,p2) { \
p2.bmv_offset = p1.bmv_offset; \
p2.bmv_block = p1.bmv_block; \
p2.bmv_length = p1.bmv_length; \
p2.bmv_count = p1.bmv_count; \
p2.bmv_entries = p1.bmv_entries; }
/*
* Structure for XFS_IOC_FSSETDM.
* For use by backup and restore programs to set the XFS on-disk inode
* fields di_dmevmask and di_dmstate. These must be set to exactly and
* only values previously obtained via xfs_bulkstat! (Specifically the
* xfs_bstat_t fields bs_dmevmask and bs_dmstate.)
*/
struct fsdmidata {
__u32 fsd_dmevmask; /* corresponds to di_dmevmask */
__u16 fsd_padding;
__u16 fsd_dmstate; /* corresponds to di_dmstate */
};
/*
* File segment locking set data type for 64 bit access.
* Also used for all the RESV/FREE interfaces.
*/
typedef struct xfs_flock64 {
__s16 l_type;
__s16 l_whence;
__s64 l_start;
__s64 l_len; /* len == 0 means until end of file */
__s32 l_sysid;
pid_t l_pid;
__s32 l_pad[4]; /* reserve area */
} xfs_flock64_t;
/*
* Output for XFS_IOC_FSGEOMETRY
*/
typedef struct xfs_fsop_geom {
__u32 blocksize; /* filesystem (data) block size */
__u32 rtextsize; /* realtime extent size */
__u32 agblocks; /* fsblocks in an AG */
__u32 agcount; /* number of allocation groups */
__u32 logblocks; /* fsblocks in the log */
__u32 sectsize; /* (data) sector size, bytes */
__u32 inodesize; /* inode size in bytes */
__u32 imaxpct; /* max allowed inode space(%) */
__u64 datablocks; /* fsblocks in data subvolume */
__u64 rtblocks; /* fsblocks in realtime subvol */
__u64 rtextents; /* rt extents in realtime subvol*/
__u64 logstart; /* starting fsblock of the log */
unsigned char uuid[16]; /* unique id of the filesystem */
__u32 sunit; /* stripe unit, fsblocks */
__u32 swidth; /* stripe width, fsblocks */
__s32 version; /* structure version */
__u32 flags; /* superblock version flags */
__u32 logsectsize; /* log sector size, bytes */
__u32 rtsectsize; /* realtime sector size, bytes */
__u32 dirblocksize; /* directory block size, bytes */
} xfs_fsop_geom_t;
/* Output for XFS_FS_COUNTS */
typedef struct xfs_fsop_counts {
__u64 freedata; /* free data section blocks */
__u64 freertx; /* free rt extents */
__u64 freeino; /* free inodes */
__u64 allocino; /* total allocated inodes */
} xfs_fsop_counts_t;
/* Input/Output for XFS_GET_RESBLKS and XFS_SET_RESBLKS */
typedef struct xfs_fsop_resblks {
__u64 resblks;
__u64 resblks_avail;
} xfs_fsop_resblks_t;
#define XFS_FSOP_GEOM_VERSION 0
#define XFS_FSOP_GEOM_FLAGS_ATTR 0x01 /* attributes in use */
#define XFS_FSOP_GEOM_FLAGS_NLINK 0x02 /* 32-bit nlink values */
#define XFS_FSOP_GEOM_FLAGS_QUOTA 0x04 /* quotas enabled */
#define XFS_FSOP_GEOM_FLAGS_IALIGN 0x08 /* inode alignment */
#define XFS_FSOP_GEOM_FLAGS_DALIGN 0x10 /* large data alignment */
#define XFS_FSOP_GEOM_FLAGS_SHARED 0x20 /* read-only shared */
#define XFS_FSOP_GEOM_FLAGS_EXTFLG 0x40 /* special extent flag */
#define XFS_FSOP_GEOM_FLAGS_DIRV2 0x80 /* directory version 2 */
/*
* Minimum and maximum sizes need for growth checks
*/
#define XFS_MIN_AG_BLOCKS 64
#define XFS_MIN_LOG_BLOCKS 512
#define XFS_MAX_LOG_BLOCKS (64 * 1024)
#define XFS_MIN_LOG_BYTES (256 * 1024)
#define XFS_MAX_LOG_BYTES (128 * 1024 * 1024)
/*
* Structures for XFS_IOC_FSGROWFSDATA, XFS_IOC_FSGROWFSLOG & XFS_IOC_FSGROWFSRT
*/
typedef struct xfs_growfs_data {
__u64 newblocks; /* new data subvol size, fsblocks */
__u32 imaxpct; /* new inode space percentage limit */
} xfs_growfs_data_t;
typedef struct xfs_growfs_log {
__u32 newblocks; /* new log size, fsblocks */
__u32 isint; /* 1 if new log is internal */
} xfs_growfs_log_t;
typedef struct xfs_growfs_rt {
__u64 newblocks; /* new realtime size, fsblocks */
__u32 extsize; /* new realtime extent size, fsblocks */
} xfs_growfs_rt_t;
/*
* Structures returned from ioctl XFS_IOC_FSBULKSTAT & XFS_IOC_FSBULKSTAT_SINGLE
*/
typedef struct xfs_bstime {
time_t tv_sec; /* seconds */
__s32 tv_nsec; /* and nanoseconds */
} xfs_bstime_t;
typedef struct xfs_bstat {
__u64 bs_ino; /* inode number */
__u16 bs_mode; /* type and mode */
__u16 bs_nlink; /* number of links */
__u32 bs_uid; /* user id */
__u32 bs_gid; /* group id */
__u32 bs_rdev; /* device value */
__s32 bs_blksize; /* block size */
__s64 bs_size; /* file size */
xfs_bstime_t bs_atime; /* access time */
xfs_bstime_t bs_mtime; /* modify time */
xfs_bstime_t bs_ctime; /* inode change time */
int64_t bs_blocks; /* number of blocks */
__u32 bs_xflags; /* extended flags */
__s32 bs_extsize; /* extent size */
__s32 bs_extents; /* number of extents */
__u32 bs_gen; /* generation count */
__u16 bs_projid; /* project id */
unsigned char bs_pad[14]; /* pad space, unused */
__u32 bs_dmevmask; /* DMIG event mask */
__u16 bs_dmstate; /* DMIG state info */
__u16 bs_aextents; /* attribute number of extents */
} xfs_bstat_t;
/*
* The user-level BulkStat Request interface structure.
*/
typedef struct xfs_fsop_bulkreq {
__u64 *lastip; /* last inode # pointer */
__s32 icount; /* count of entries in buffer */
void *ubuffer; /* user buffer for inode desc. */
__s32 *ocount; /* output count pointer */
} xfs_fsop_bulkreq_t;
/*
* Structures returned from xfs_inumbers routine (XFS_IOC_FSINUMBERS).
*/
typedef struct xfs_inogrp {
__u64 xi_startino; /* starting inode number */
__s32 xi_alloccount; /* # bits set in allocmask */
__u64 xi_allocmask; /* mask of allocated inodes */
} xfs_inogrp_t;
/*
* Error injection.
*/
typedef struct xfs_error_injection {
__s32 fd;
__s32 errtag;
} xfs_error_injection_t;
/*
* The user-level Handle Request interface structure.
*/
typedef struct xfs_fsop_handlereq {
__u32 fd; /* fd for FD_TO_HANDLE */
void *path; /* user pathname */
__u32 oflags; /* open flags */
void *ihandle; /* user supplied handle */
__u32 ihandlen; /* user supplied length */
void *ohandle; /* user buffer for handle */
__u32 *ohandlen; /* user buffer length */
} xfs_fsop_handlereq_t;
/*
* Compound structures for passing args through Handle Request interfaces
* xfs_fssetdm_by_handle, xfs_attrlist_by_handle, xfs_attrmulti_by_handle
* - ioctls: XFS_IOC_FSSETDM_BY_HANDLE, XFS_IOC_ATTRLIST_BY_HANDLE, and
* XFS_IOC_ATTRMULTI_BY_HANDLE
*/
typedef struct xfs_fsop_setdm_handlereq {
struct xfs_fsop_handlereq hreq; /* handle interface structure */
struct fsdmidata *data; /* DMAPI data to set */
} xfs_fsop_setdm_handlereq_t;
typedef struct xfs_attrlist_cursor {
__u32 opaque[4];
} xfs_attrlist_cursor_t;
typedef struct xfs_fsop_attrlist_handlereq {
struct xfs_fsop_handlereq hreq; /* handle interface structure */
struct xfs_attrlist_cursor pos; /* opaque cookie, list offset */
__u32 flags; /* flags, use ROOT/USER names */
__u32 buflen; /* length of buffer supplied */
void *buffer; /* attrlist data to return */
} xfs_fsop_attrlist_handlereq_t;
typedef struct xfs_attr_multiop {
__u32 am_opcode;
__s32 am_error;
void *am_attrname;
void *am_attrvalue;
__u32 am_length;
__u32 am_flags;
} xfs_attr_multiop_t;
typedef struct xfs_fsop_attrmulti_handlereq {
struct xfs_fsop_handlereq hreq; /* handle interface structure */
__u32 opcount; /* count of following multiop */
struct xfs_attr_multiop *ops; /* attr_multi data to get/set */
} xfs_fsop_attrmulti_handlereq_t;
/*
* Structure for XFS_IOC_ATTRCTL_BY_HANDLE ioctl, will be removed later.
*/
typedef struct xfs_fsop_attr_handlereq {
struct xfs_fsop_handlereq *hreq;/* handle request interface */
/* structure */
struct attr_op *ops; /* array of attribute ops */
int count; /* number of attribute ops */
} xfs_fsop_attr_handlereq_t;
/*
* File system identifier. Should be unique (at least per machine).
*/
typedef struct {
__u32 val[2]; /* file system id type */
} xfs_fsid_t;
/*
* File identifier. Should be unique per filesystem on a single machine.
* This is typically called by a stateless file server in order to generate
* "file handles".
*/
#define MAXFIDSZ 46
typedef struct fid {
__u16 fid_len; /* length of data in bytes */
unsigned char fid_data[MAXFIDSZ]; /* data (variable length) */
} fid_t;
typedef struct xfs_fid {
__u16 xfs_fid_len; /* length of remainder */
__u16 xfs_fid_pad;
__u32 xfs_fid_gen; /* generation number */
__u64 xfs_fid_ino; /* 64 bits inode number */
} xfs_fid_t;
typedef struct xfs_fid2 {
__u16 fid_len; /* length of remainder */
__u16 fid_pad; /* padding, must be zero */
__u32 fid_gen; /* generation number */
__u64 fid_ino; /* inode number */
} xfs_fid2_t;
typedef struct xfs_handle {
union {
__s64 align; /* force alignment of ha_fid */
xfs_fsid_t _ha_fsid; /* unique file system identifier */
} ha_u;
xfs_fid_t ha_fid; /* file system specific file ID */
} xfs_handle_t;
#define ha_fsid ha_u._ha_fsid
#define XFS_HSIZE(handle) (((char *) &(handle).ha_fid.xfs_fid_pad \
- (char *) &(handle)) \
+ (handle).ha_fid.xfs_fid_len)
#define XFS_HANDLE_CMP(h1, h2) bcmp(h1, h2, sizeof (xfs_handle_t))
#define FSHSIZE sizeof (fsid_t)
/*
* ioctl commands that replace IRIX fcntl()'s
* For 'documentation' purposed more than anything else,
* the "cmd #" field reflects the IRIX fcntl number.
*/
#define XFS_IOC_ALLOCSP _IOW ('X', 10, struct xfs_flock64)
#define XFS_IOC_FREESP _IOW ('X', 11, struct xfs_flock64)
#define XFS_IOC_DIOINFO _IOR ('X', 30, struct dioattr)
#define XFS_IOC_FSGETXATTR _IOR ('X', 31, struct fsxattr)
#define XFS_IOC_FSSETXATTR _IOW ('X', 32, struct fsxattr)
#define XFS_IOC_ALLOCSP64 _IOW ('X', 36, struct xfs_flock64)
#define XFS_IOC_FREESP64 _IOW ('X', 37, struct xfs_flock64)
#define XFS_IOC_GETBMAP _IOWR('X', 38, struct getbmap)
#define XFS_IOC_FSSETDM _IOW ('X', 39, struct fsdmidata)
#define XFS_IOC_RESVSP _IOW ('X', 40, struct xfs_flock64)
#define XFS_IOC_UNRESVSP _IOW ('X', 41, struct xfs_flock64)
#define XFS_IOC_RESVSP64 _IOW ('X', 42, struct xfs_flock64)
#define XFS_IOC_UNRESVSP64 _IOW ('X', 43, struct xfs_flock64)
#define XFS_IOC_GETBMAPA _IOWR('X', 44, struct getbmap)
#define XFS_IOC_FSGETXATTRA _IOR ('X', 45, struct fsxattr)
#define XFS_IOC_SETBIOSIZE _IOW ('X', 46, struct biosize)
#define XFS_IOC_GETBIOSIZE _IOR ('X', 47, struct biosize)
#define XFS_IOC_GETBMAPX _IOWR('X', 56, struct getbmap)
/*
* ioctl commands that replace IRIX syssgi()'s
*/
#define XFS_IOC_FSGEOMETRY _IOR ('X', 100, struct xfs_fsop_geom)
#define XFS_IOC_FSBULKSTAT _IOWR('X', 101, struct xfs_fsop_bulkreq)
#define XFS_IOC_FSBULKSTAT_SINGLE _IOWR('X', 102, struct xfs_fsop_bulkreq)
#define XFS_IOC_FSINUMBERS _IOWR('X', 103, struct xfs_fsop_bulkreq)
#define XFS_IOC_PATH_TO_FSHANDLE _IOWR('X', 104, struct xfs_fsop_handlereq)
#define XFS_IOC_PATH_TO_HANDLE _IOWR('X', 105, struct xfs_fsop_handlereq)
#define XFS_IOC_FD_TO_HANDLE _IOWR('X', 106, struct xfs_fsop_handlereq)
#define XFS_IOC_OPEN_BY_HANDLE _IOWR('X', 107, struct xfs_fsop_handlereq)
#define XFS_IOC_READLINK_BY_HANDLE _IOWR('X', 108, struct xfs_fsop_handlereq)
#define XFS_IOC_SWAPEXT _IOWR('X', 109, struct xfs_swapext)
#define XFS_IOC_FSGROWFSDATA _IOW ('X', 110, struct xfs_growfs_data)
#define XFS_IOC_FSGROWFSLOG _IOW ('X', 111, struct xfs_growfs_log)
#define XFS_IOC_FSGROWFSRT _IOW ('X', 112, struct xfs_growfs_rt)
#define XFS_IOC_FSCOUNTS _IOR ('X', 113, struct xfs_fsop_counts)
#define XFS_IOC_SET_RESBLKS _IOR ('X', 114, struct xfs_fsop_resblks)
#define XFS_IOC_GET_RESBLKS _IOR ('X', 115, struct xfs_fsop_resblks)
#define XFS_IOC_ERROR_INJECTION _IOW ('X', 116, struct xfs_error_injection)
#define XFS_IOC_ERROR_CLEARALL _IOW ('X', 117, struct xfs_error_injection)
/* XFS_IOC_ATTRCTL_BY_HANDLE -- deprecated 118 */
#define XFS_IOC_ATTRCTL_BY_HANDLE _IOWR('X', 118, struct xfs_fsop_attr_handlereq)
#define XFS_IOC_FREEZE _IOWR('X', 119, int)
#define XFS_IOC_THAW _IOWR('X', 120, int)
#define XFS_IOC_FSSETDM_BY_HANDLE _IOW ('X', 121, struct xfs_fsop_setdm_handlereq)
#define XFS_IOC_ATTRLIST_BY_HANDLE _IOW ('X', 122, struct xfs_fsop_attrlist_handlereq)
#define XFS_IOC_ATTRMULTI_BY_HANDLE _IOW ('X', 123, struct xfs_fsop_attrmulti_handlereq)
/*
* ioctl command to export information not in standard interfaces
* 140: IRIX statvfs.f_fstr field - UUID from the superblock
*/
#define XFS_IOC_GETFSUUID _IOR ('X', 140, unsigned char[16])
/*
* Block I/O parameterization. A basic block (BB) is the lowest size of
* filesystem allocation, and must == NBPSCTR. Length units given to bio
* routines are in BB's.
*/
#define BBSHIFT 9
#define BBSIZE (1<<BBSHIFT)
#define BBMASK (BBSIZE-1)
#define BTOBB(bytes) (((__u64)(bytes) + BBSIZE - 1) >> BBSHIFT)
#define BTOBBT(bytes) ((__u64)(bytes) >> BBSHIFT)
#define BBTOB(bbs) ((bbs) << BBSHIFT)
#define OFFTOBB(bytes) (((__u64)(bytes) + BBSIZE - 1) >> BBSHIFT)
#define OFFTOBBT(bytes) ((__u64)(bytes) >> BBSHIFT)
#define BBTOOFF(bbs) ((__u64)(bbs) << BBSHIFT)
#define SEEKLIMIT32 0x7fffffff
#define BBSEEKLIMIT32 BTOBBT(SEEKLIMIT32)
#define SEEKLIMIT 0x7fffffffffffffffLL
#define BBSEEKLIMIT OFFTOBBT(SEEKLIMIT)
#endif /* _LINUX_XFS_FS_H */