db/field.h

   1 /*
   2  * Copyright (c) 2000-2001,2005 Silicon Graphics, Inc.
   3  * All Rights Reserved.
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License as
   7  * published by the Free Software Foundation.
   8  *
   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.
  13  *
  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
  17  */
  18
  19 typedef enum fldt       {
  20         FLDT_AEXTNUM,
  21         FLDT_AGBLOCK,
  22         FLDT_AGBLOCKNZ,
  23         FLDT_AGF,
  24         FLDT_AGFL,
  25         FLDT_AGFL_CRC,
  26         FLDT_AGI,
  27         FLDT_AGINO,
  28         FLDT_AGINONN,
  29         FLDT_AGNUMBER,
  30
  31         /* attr fields */
  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,
  44
  45         /* attr 3 specific fields */
  46         FLDT_ATTR3,
  47         FLDT_ATTR3_LEAF_HDR,
  48         FLDT_ATTR3_NODE_HDR,
  49
  50         FLDT_BMAPBTA,
  51         FLDT_BMAPBTA_CRC,
  52         FLDT_BMAPBTAKEY,
  53         FLDT_BMAPBTAPTR,
  54         FLDT_BMAPBTAREC,
  55         FLDT_BMAPBTD,
  56         FLDT_BMAPBTD_CRC,
  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,
  67         FLDT_BNOBT_CRC,
  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_REXTLEN,
  79         FLDT_RFILEOFFD,
  80         FLDT_REXTFLG,
  81         FLDT_RATTRFORKFLG,
  82         FLDT_RBMBTFLG,
  83         FLDT_CNTBT,
  84         FLDT_CNTBT_CRC,
  85         FLDT_CNTBTKEY,
  86         FLDT_CNTBTPTR,
  87         FLDT_CNTBTREC,
  88         FLDT_RMAPBT_CRC,
  89         FLDT_RMAPBTKEY,
  90         FLDT_RMAPBTPTR,
  91         FLDT_RMAPBTREC,
  92
  93         /* CRC field type */
  94         FLDT_CRC,
  95
  96         FLDT_DEV,
  97         FLDT_DFILOFFA,
  98         FLDT_DFILOFFD,
  99         FLDT_DFSBNO,
 100         FLDT_DINODE_A,
 101         FLDT_DINODE_CORE,
 102         FLDT_DINODE_FMT,
 103         FLDT_DINODE_U,
 104         FLDT_DINODE_V3,
 105
 106         /* dir v2 fields */
 107         FLDT_DIR2,
 108         FLDT_DIR2_BLOCK_TAIL,
 109         FLDT_DIR2_DATA_FREE,
 110         FLDT_DIR2_DATA_HDR,
 111         FLDT_DIR2_DATA_OFF,
 112         FLDT_DIR2_DATA_OFFNZ,
 113         FLDT_DIR2_DATA_UNION,
 114         FLDT_DIR2_FREE_HDR,
 115         FLDT_DIR2_INO4,
 116         FLDT_DIR2_INO8,
 117         FLDT_DIR2_INOU,
 118         FLDT_DIR2_LEAF_ENTRY,
 119         FLDT_DIR2_LEAF_HDR,
 120         FLDT_DIR2_LEAF_TAIL,
 121         FLDT_DIR2_SF_ENTRY,
 122         FLDT_DIR2_SF_HDR,
 123         FLDT_DIR2_SF_OFF,
 124         FLDT_DIR2SF,
 125
 126         /* dir v3 fields */
 127         FLDT_DIR3,
 128         FLDT_DIR3_BLKHDR,
 129         FLDT_DIR3_DATA_HDR,
 130         FLDT_DIR3_FREE_HDR,
 131         FLDT_DIR3_LEAF_HDR,
 132         FLDT_DIR3_DATA_UNION,
 133         FLDT_DIR3_SF_ENTRY,
 134         FLDT_DIR3SF,
 135
 136         /* dir v2/3 node fields */
 137         FLDT_DA_BLKINFO,
 138         FLDT_DA_NODE_ENTRY,
 139         FLDT_DA_NODE_HDR,
 140         FLDT_DA3_BLKINFO,
 141         FLDT_DA3_NODE_HDR,
 142
 143         FLDT_DIRBLOCK,
 144         FLDT_DISK_DQUOT,
 145         FLDT_DQBLK,
 146         FLDT_DQID,
 147         FLDT_DRFSBNO,
 148         FLDT_DRTBNO,
 149         FLDT_EXTLEN,
 150         FLDT_EXTNUM,
 151         FLDT_FSIZE,
 152         FLDT_INO,
 153         FLDT_INOBT,
 154         FLDT_INOBT_CRC,
 155         FLDT_INOBT_SPCRC,
 156         FLDT_INOBTKEY,
 157         FLDT_INOBTPTR,
 158         FLDT_INOBTREC,
 159         FLDT_INOBTSPREC,
 160         FLDT_INODE,
 161         FLDT_INODE_CRC,
 162         FLDT_INOFREE,
 163         FLDT_INT16D,
 164         FLDT_INT32D,
 165         FLDT_INT64D,
 166         FLDT_INT8D,
 167         FLDT_NSEC,
 168         FLDT_QCNT,
 169         FLDT_QWARNCNT,
 170         FLDT_SB,
 171
 172         /* CRC enabled symlink */
 173         FLDT_SYMLINK_CRC,
 174
 175         FLDT_TIME,
 176         FLDT_TIMESTAMP,
 177         FLDT_UINT1,
 178         FLDT_UINT16D,
 179         FLDT_UINT16O,
 180         FLDT_UINT16X,
 181         FLDT_UINT32D,
 182         FLDT_UINT32O,
 183         FLDT_UINT32X,
 184         FLDT_UINT64D,
 185         FLDT_UINT64O,
 186         FLDT_UINT64X,
 187         FLDT_UINT8D,
 188         FLDT_UINT8O,
 189         FLDT_UINT8X,
 190         FLDT_UUID,
 191         FLDT_ZZZ                        /* mark last entry */
 192 } fldt_t;
 193
 194 typedef int (*offset_fnc_t)(void *obj, int startoff, int idx);
 195 #define OI(o)   ((offset_fnc_t)(intptr_t)(o))
 196
 197 typedef int (*count_fnc_t)(void *obj, int startoff);
 198 #define CI(c)   ((count_fnc_t)(intptr_t)(c))
 199 #define C1      CI(1)
 200
 201 typedef struct field
 202 {
 203         char            *name;
 204         fldt_t          ftyp;
 205         offset_fnc_t    offset;
 206         count_fnc_t     count;
 207         int             flags;
 208         typnm_t         next;
 209 } field_t;
 210
 211 /*
 212  * flag values
 213  */
 214 #define FLD_ABASE1      1       /* field array base is 1 not 0 */
 215 #define FLD_SKIPALL     2       /* skip this field in an all-fields print */
 216 #define FLD_ARRAY       4       /* this field is an array */
 217 #define FLD_OFFSET      8       /* offset value is a function pointer */
 218 #define FLD_COUNT       16      /* count value is a function pointer */
 219
 220 typedef int (*size_fnc_t)(void *obj, int startoff, int idx);
 221 #define SI(s)   ((size_fnc_t)(intptr_t)(s))
 222
 223 typedef struct ftattr
 224 {
 225         fldt_t          ftyp;
 226         char            *name;
 227         prfnc_t         prfunc;
 228         char            *fmtstr;
 229         size_fnc_t      size;
 230         int             arg;
 231         adfnc_t         adfunc;
 232         const field_t   *subfld;
 233 } ftattr_t;
 234 extern const ftattr_t   ftattrtab[];
 235
 236 /*
 237  * arg values
 238  */
 239 #define FTARG_SKIPZERO  1       /* skip 0 words */
 240 #define FTARG_DONULL    2       /* make -1 words be "null" */
 241 #define FTARG_SKIPNULL  4       /* skip -1 words */
 242 #define FTARG_SIGNED    8       /* field value is signed */
 243 #define FTARG_SIZE      16      /* size field is a function */
 244 #define FTARG_SKIPNMS   32      /* skip printing names this time */
 245 #define FTARG_OKEMPTY   64      /* ok if this (union type) is empty */
 246
 247 extern int              bitoffset(const field_t *f, void *obj, int startoff,
 248                                   int idx);
 249 extern int              fcount(const field_t *f, void *obj, int startoff);
 250 extern const field_t    *findfield(char *name, const field_t *fields,
 251                                   void *obj, int startoff);
 252 extern int              fsize(const field_t *f, void *obj, int startoff,
 253                                   int idx);