[thirdparty/xfsprogs-dev.git] / db / field.h

/*
 * Copyright (c) 2000-2001,2005 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 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.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write the Free Software Foundation,
 * Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

typedef enum fldt	{
	FLDT_AEXTNUM,
	FLDT_AGBLOCK,
	FLDT_AGBLOCKNZ,
	FLDT_AGF,
	FLDT_AGFL,
	FLDT_AGFL_CRC,
	FLDT_AGI,
	FLDT_AGINO,
	FLDT_AGINONN,
	FLDT_AGNUMBER,

	/* attr fields */
	FLDT_ATTR,
	FLDT_ATTR_BLKINFO,
	FLDT_ATTR_LEAF_ENTRY,
	FLDT_ATTR_LEAF_HDR,
	FLDT_ATTR_LEAF_MAP,
	FLDT_ATTR_LEAF_NAME,
	FLDT_ATTR_NODE_ENTRY,
	FLDT_ATTR_NODE_HDR,
	FLDT_ATTR_SF_ENTRY,
	FLDT_ATTR_SF_HDR,
	FLDT_ATTRBLOCK,
	FLDT_ATTRSHORT,

	/* attr 3 specific fields */
	FLDT_ATTR3,
	FLDT_ATTR3_LEAF_HDR,
	FLDT_ATTR3_NODE_HDR,

	FLDT_BMAPBTA,
	FLDT_BMAPBTA_CRC,
	FLDT_BMAPBTAKEY,
	FLDT_BMAPBTAPTR,
	FLDT_BMAPBTAREC,
	FLDT_BMAPBTD,
	FLDT_BMAPBTD_CRC,
	FLDT_BMAPBTDKEY,
	FLDT_BMAPBTDPTR,
	FLDT_BMAPBTDREC,
	FLDT_BMROOTA,
	FLDT_BMROOTAKEY,
	FLDT_BMROOTAPTR,
	FLDT_BMROOTD,
	FLDT_BMROOTDKEY,
	FLDT_BMROOTDPTR,
	FLDT_BNOBT,
	FLDT_BNOBT_CRC,
	FLDT_BNOBTKEY,
	FLDT_BNOBTPTR,
	FLDT_BNOBTREC,
	FLDT_CEXTFLG,
	FLDT_CEXTLEN,
	FLDT_CFILEOFFA,
	FLDT_CFILEOFFD,
	FLDT_CFSBLOCK,
	FLDT_CHARNS,
	FLDT_CHARS,
	FLDT_CNTBT,
	FLDT_CNTBT_CRC,
	FLDT_CNTBTKEY,
	FLDT_CNTBTPTR,
	FLDT_CNTBTREC,

	/* CRC field type */
	FLDT_CRC,

	FLDT_DEV,
	FLDT_DFILOFFA,
	FLDT_DFILOFFD,
	FLDT_DFSBNO,
	FLDT_DINODE_A,
	FLDT_DINODE_CORE,
	FLDT_DINODE_FMT,
	FLDT_DINODE_U,
	FLDT_DINODE_V3,

	/* dir v2 fields */
	FLDT_DIR2,
	FLDT_DIR2_BLOCK_TAIL,
	FLDT_DIR2_DATA_FREE,
	FLDT_DIR2_DATA_HDR,
	FLDT_DIR2_DATA_OFF,
	FLDT_DIR2_DATA_OFFNZ,
	FLDT_DIR2_DATA_UNION,
	FLDT_DIR2_FREE_HDR,
	FLDT_DIR2_INO4,
	FLDT_DIR2_INO8,
	FLDT_DIR2_INOU,
	FLDT_DIR2_LEAF_ENTRY,
	FLDT_DIR2_LEAF_HDR,
	FLDT_DIR2_LEAF_TAIL,
	FLDT_DIR2_SF_ENTRY,
	FLDT_DIR2_SF_HDR,
	FLDT_DIR2_SF_OFF,
	FLDT_DIR2SF,

	/* dir v3 fields */
	FLDT_DIR3,
	FLDT_DIR3_BLKHDR,
	FLDT_DIR3_DATA_HDR,
	FLDT_DIR3_FREE_HDR,
	FLDT_DIR3_LEAF_HDR,
	FLDT_DIR3_DATA_UNION,
	FLDT_DIR3_SF_ENTRY,
	FLDT_DIR3SF,

	/* dir v2/3 node fields */
	FLDT_DA_BLKINFO,
	FLDT_DA_NODE_ENTRY,
	FLDT_DA_NODE_HDR,
	FLDT_DA3_BLKINFO,
	FLDT_DA3_NODE_HDR,

	FLDT_DIRBLOCK,
	FLDT_DISK_DQUOT,
	FLDT_DQBLK,
	FLDT_DQID,
	FLDT_DRFSBNO,
	FLDT_DRTBNO,
	FLDT_EXTLEN,
	FLDT_EXTNUM,
	FLDT_FSIZE,
	FLDT_INO,
	FLDT_INOBT,
	FLDT_INOBT_CRC,
	FLDT_INOBT_SPCRC,
	FLDT_INOBTKEY,
	FLDT_INOBTPTR,
	FLDT_INOBTREC,
	FLDT_INOBTSPREC,
	FLDT_INODE,
	FLDT_INODE_CRC,
	FLDT_INOFREE,
	FLDT_INT16D,
	FLDT_INT32D,
	FLDT_INT64D,
	FLDT_INT8D,
	FLDT_NSEC,
	FLDT_QCNT,
	FLDT_QWARNCNT,
	FLDT_SB,

	/* CRC enabled symlink */
	FLDT_SYMLINK_CRC,

	FLDT_TIME,
	FLDT_TIMESTAMP,
	FLDT_UINT1,
	FLDT_UINT16D,
	FLDT_UINT16O,
	FLDT_UINT16X,
	FLDT_UINT32D,
	FLDT_UINT32O,
	FLDT_UINT32X,
	FLDT_UINT64D,
	FLDT_UINT64O,
	FLDT_UINT64X,
	FLDT_UINT8D,
	FLDT_UINT8O,
	FLDT_UINT8X,
	FLDT_UUID,
	FLDT_ZZZ			/* mark last entry */
} fldt_t;

typedef int (*offset_fnc_t)(void *obj, int startoff, int idx);
#define	OI(o)	((offset_fnc_t)(intptr_t)(o))

typedef int (*count_fnc_t)(void *obj, int startoff);
#define	CI(c)	((count_fnc_t)(intptr_t)(c))
#define	C1	CI(1)

typedef struct field
{
	char		*name;
	fldt_t		ftyp;
	offset_fnc_t	offset;
	count_fnc_t	count;
	int		flags;
	typnm_t		next;
} field_t;

/*
 * flag values
 */
#define	FLD_ABASE1	1	/* field array base is 1 not 0 */
#define	FLD_SKIPALL	2	/* skip this field in an all-fields print */
#define	FLD_ARRAY	4	/* this field is an array */
#define	FLD_OFFSET	8	/* offset value is a function pointer */
#define	FLD_COUNT	16	/* count value is a function pointer */

typedef int (*size_fnc_t)(void *obj, int startoff, int idx);
#define	SI(s)	((size_fnc_t)(intptr_t)(s))

typedef struct ftattr
{
	fldt_t		ftyp;
	char		*name;
	prfnc_t		prfunc;
	char		*fmtstr;
	size_fnc_t	size;
	int		arg;
	adfnc_t		adfunc;
	const field_t	*subfld;
} ftattr_t;
extern const ftattr_t	ftattrtab[];

/*
 * arg values
 */
#define	FTARG_SKIPZERO	1	/* skip 0 words */
#define	FTARG_DONULL	2	/* make -1 words be "null" */
#define	FTARG_SKIPNULL	4	/* skip -1 words */
#define	FTARG_SIGNED	8	/* field value is signed */
#define	FTARG_SIZE	16	/* size field is a function */
#define	FTARG_SKIPNMS	32	/* skip printing names this time */
#define	FTARG_OKEMPTY	64	/* ok if this (union type) is empty */

extern int		bitoffset(const field_t *f, void *obj, int startoff,
				  int idx);
extern int		fcount(const field_t *f, void *obj, int startoff);
extern const field_t	*findfield(char *name, const field_t *fields,
				  void *obj, int startoff);
extern int		fsize(const field_t *f, void *obj, int startoff,
				  int idx);
Commit	Line	Data
2bd0ea18	1	/*
da23017d NS	2	* Copyright (c) 2000-2001,2005 Silicon Graphics, Inc.
da23017d NS	3	* All Rights Reserved.
dfc130f3	4	*
da23017d NS	5	* This program is free software; you can redistribute it and/or
da23017d NS	6	* modify it under the terms of the GNU General Public License as
2bd0ea18	7	* published by the Free Software Foundation.
dfc130f3	8	*
da23017d NS	9	* This program is distributed in the hope that it would be useful,
	10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	* GNU General Public License for more details.
dfc130f3	13	*
da23017d NS	14	* You should have received a copy of the GNU General Public License
	15	* along with this program; if not, write the Free Software Foundation,
	16	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
2bd0ea18 NS	17	*/
	18
	19	typedef enum fldt {
	20	FLDT_AEXTNUM,
	21	FLDT_AGBLOCK,
	22	FLDT_AGBLOCKNZ,
	23	FLDT_AGF,
	24	FLDT_AGFL,
c2907bd7	25	FLDT_AGFL_CRC,
2bd0ea18 NS	26	FLDT_AGI,
	27	FLDT_AGINO,
	28	FLDT_AGINONN,
	29	FLDT_AGNUMBER,
ad04ef4a DC	30
ad04ef4a DC	31	/* attr fields */
2bd0ea18 NS	32	FLDT_ATTR,
	33	FLDT_ATTR_BLKINFO,
	34	FLDT_ATTR_LEAF_ENTRY,
	35	FLDT_ATTR_LEAF_HDR,
	36	FLDT_ATTR_LEAF_MAP,
	37	FLDT_ATTR_LEAF_NAME,
	38	FLDT_ATTR_NODE_ENTRY,
	39	FLDT_ATTR_NODE_HDR,
	40	FLDT_ATTR_SF_ENTRY,
	41	FLDT_ATTR_SF_HDR,
	42	FLDT_ATTRBLOCK,
	43	FLDT_ATTRSHORT,
ad04ef4a DC	44
	45	/* attr 3 specific fields */
	46	FLDT_ATTR3,
	47	FLDT_ATTR3_LEAF_HDR,
	48	FLDT_ATTR3_NODE_HDR,
	49
2bd0ea18	50	FLDT_BMAPBTA,
c2907bd7	51	FLDT_BMAPBTA_CRC,
2bd0ea18 NS	52	FLDT_BMAPBTAKEY,
	53	FLDT_BMAPBTAPTR,
	54	FLDT_BMAPBTAREC,
	55	FLDT_BMAPBTD,
c2907bd7	56	FLDT_BMAPBTD_CRC,
2bd0ea18 NS	57	FLDT_BMAPBTDKEY,
	58	FLDT_BMAPBTDPTR,
	59	FLDT_BMAPBTDREC,
	60	FLDT_BMROOTA,
	61	FLDT_BMROOTAKEY,
	62	FLDT_BMROOTAPTR,
	63	FLDT_BMROOTD,
	64	FLDT_BMROOTDKEY,
	65	FLDT_BMROOTDPTR,
	66	FLDT_BNOBT,
c2907bd7	67	FLDT_BNOBT_CRC,
2bd0ea18 NS	68	FLDT_BNOBTKEY,
	69	FLDT_BNOBTPTR,
	70	FLDT_BNOBTREC,
	71	FLDT_CEXTFLG,
	72	FLDT_CEXTLEN,
	73	FLDT_CFILEOFFA,
	74	FLDT_CFILEOFFD,
	75	FLDT_CFSBLOCK,
	76	FLDT_CHARNS,
	77	FLDT_CHARS,
	78	FLDT_CNTBT,
c2907bd7	79	FLDT_CNTBT_CRC,
2bd0ea18 NS	80	FLDT_CNTBTKEY,
	81	FLDT_CNTBTPTR,
	82	FLDT_CNTBTREC,
0522f1cc DC	83
	84	/* CRC field type */
	85	FLDT_CRC,
	86
2bd0ea18 NS	87	FLDT_DEV,
	88	FLDT_DFILOFFA,
	89	FLDT_DFILOFFD,
	90	FLDT_DFSBNO,
	91	FLDT_DINODE_A,
	92	FLDT_DINODE_CORE,
	93	FLDT_DINODE_FMT,
	94	FLDT_DINODE_U,
c2907bd7	95	FLDT_DINODE_V3,
a364668b DC	96
a364668b DC	97	/* dir v2 fields */
2bd0ea18 NS	98	FLDT_DIR2,
	99	FLDT_DIR2_BLOCK_TAIL,
	100	FLDT_DIR2_DATA_FREE,
	101	FLDT_DIR2_DATA_HDR,
	102	FLDT_DIR2_DATA_OFF,
	103	FLDT_DIR2_DATA_OFFNZ,
	104	FLDT_DIR2_DATA_UNION,
	105	FLDT_DIR2_FREE_HDR,
	106	FLDT_DIR2_INO4,
	107	FLDT_DIR2_INO8,
	108	FLDT_DIR2_INOU,
	109	FLDT_DIR2_LEAF_ENTRY,
	110	FLDT_DIR2_LEAF_HDR,
	111	FLDT_DIR2_LEAF_TAIL,
	112	FLDT_DIR2_SF_ENTRY,
	113	FLDT_DIR2_SF_HDR,
	114	FLDT_DIR2_SF_OFF,
	115	FLDT_DIR2SF,
a364668b DC	116
	117	/* dir v3 fields */
	118	FLDT_DIR3,
	119	FLDT_DIR3_BLKHDR,
	120	FLDT_DIR3_DATA_HDR,
	121	FLDT_DIR3_FREE_HDR,
	122	FLDT_DIR3_LEAF_HDR,
3beed08e DC	123	FLDT_DIR3_DATA_UNION,
	124	FLDT_DIR3_SF_ENTRY,
	125	FLDT_DIR3SF,
a364668b DC	126
a364668b DC	127	/* dir v2/3 node fields */
9a048535 DC	128	FLDT_DA_BLKINFO,
	129	FLDT_DA_NODE_ENTRY,
	130	FLDT_DA_NODE_HDR,
a364668b DC	131	FLDT_DA3_BLKINFO,
	132	FLDT_DA3_NODE_HDR,
	133
2bd0ea18	134	FLDT_DIRBLOCK,
2bd0ea18 NS	135	FLDT_DISK_DQUOT,
	136	FLDT_DQBLK,
	137	FLDT_DQID,
	138	FLDT_DRFSBNO,
	139	FLDT_DRTBNO,
	140	FLDT_EXTLEN,
	141	FLDT_EXTNUM,
	142	FLDT_FSIZE,
	143	FLDT_INO,
	144	FLDT_INOBT,
c2907bd7	145	FLDT_INOBT_CRC,
061e316e	146	FLDT_INOBT_SPCRC,
2bd0ea18 NS	147	FLDT_INOBTKEY,
	148	FLDT_INOBTPTR,
	149	FLDT_INOBTREC,
061e316e	150	FLDT_INOBTSPREC,
2bd0ea18	151	FLDT_INODE,
c2907bd7	152	FLDT_INODE_CRC,
2bd0ea18 NS	153	FLDT_INOFREE,
	154	FLDT_INT16D,
	155	FLDT_INT32D,
	156	FLDT_INT64D,
	157	FLDT_INT8D,
	158	FLDT_NSEC,
	159	FLDT_QCNT,
	160	FLDT_QWARNCNT,
	161	FLDT_SB,
3cafd875 DC	162
	163	/* CRC enabled symlink */
	164	FLDT_SYMLINK_CRC,
	165
2bd0ea18 NS	166	FLDT_TIME,
	167	FLDT_TIMESTAMP,
	168	FLDT_UINT1,
	169	FLDT_UINT16D,
	170	FLDT_UINT16O,
	171	FLDT_UINT16X,
	172	FLDT_UINT32D,
	173	FLDT_UINT32O,
	174	FLDT_UINT32X,
	175	FLDT_UINT64D,
	176	FLDT_UINT64O,
	177	FLDT_UINT64X,
	178	FLDT_UINT8D,
	179	FLDT_UINT8O,
	180	FLDT_UINT8X,
	181	FLDT_UUID,
	182	FLDT_ZZZ /* mark last entry */
	183	} fldt_t;
	184
	185	typedef int (offset_fnc_t)(void obj, int startoff, int idx);
ee6cd73e	186	#define OI(o) ((offset_fnc_t)(intptr_t)(o))
2bd0ea18 NS	187
2bd0ea18 NS	188	typedef int (count_fnc_t)(void obj, int startoff);
ee6cd73e	189	#define CI(c) ((count_fnc_t)(intptr_t)(c))
2bd0ea18 NS	190	#define C1 CI(1)
	191
	192	typedef struct field
	193	{
	194	char *name;
	195	fldt_t ftyp;
	196	offset_fnc_t offset;
	197	count_fnc_t count;
	198	int flags;
	199	typnm_t next;
	200	} field_t;
	201
	202	/*
	203	* flag values
	204	*/
	205	#define FLD_ABASE1 1 /* field array base is 1 not 0 */
	206	#define FLD_SKIPALL 2 /* skip this field in an all-fields print */
	207	#define FLD_ARRAY 4 /* this field is an array */
	208	#define FLD_OFFSET 8 /* offset value is a function pointer */
	209	#define FLD_COUNT 16 /* count value is a function pointer */
	210
	211	typedef int (size_fnc_t)(void obj, int startoff, int idx);
ee6cd73e	212	#define SI(s) ((size_fnc_t)(intptr_t)(s))
2bd0ea18 NS	213
	214	typedef struct ftattr
	215	{
	216	fldt_t ftyp;
	217	char *name;
	218	prfnc_t prfunc;
	219	char *fmtstr;
	220	size_fnc_t size;
	221	int arg;
	222	adfnc_t adfunc;
	223	const field_t *subfld;
	224	} ftattr_t;
	225	extern const ftattr_t ftattrtab[];
	226
	227	/*
	228	* arg values
	229	*/
	230	#define FTARG_SKIPZERO 1 /* skip 0 words */
	231	#define FTARG_DONULL 2 /* make -1 words be "null" */
	232	#define FTARG_SKIPNULL 4 /* skip -1 words */
	233	#define FTARG_SIGNED 8 /* field value is signed */
	234	#define FTARG_SIZE 16 /* size field is a function */
	235	#define FTARG_SKIPNMS 32 /* skip printing names this time */
	236	#define FTARG_OKEMPTY 64 /* ok if this (union type) is empty */
	237
	238	extern int bitoffset(const field_t f, void obj, int startoff,
	239	int idx);
	240	extern int fcount(const field_t f, void obj, int startoff);
	241	extern const field_t findfield(char name, const field_t *fields,
dfc130f3	242	void *obj, int startoff);
2bd0ea18	243	extern int fsize(const field_t f, void obj, int startoff,
dfc130f3	244	int idx);