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_CNTBT,
  79         FLDT_CNTBT_CRC,
  80         FLDT_CNTBTKEY,
  81         FLDT_CNTBTPTR,
  82         FLDT_CNTBTREC,
  83         FLDT_DEV,
  84         FLDT_DFILOFFA,
  85         FLDT_DFILOFFD,
  86         FLDT_DFSBNO,
  87         FLDT_DINODE_A,
  88         FLDT_DINODE_CORE,
  89         FLDT_DINODE_FMT,
  90         FLDT_DINODE_U,
  91         FLDT_DINODE_V3,
  92
  93         /* dir v2 fields */
  94         FLDT_DIR2,
  95         FLDT_DIR2_BLOCK_TAIL,
  96         FLDT_DIR2_DATA_FREE,
  97         FLDT_DIR2_DATA_HDR,
  98         FLDT_DIR2_DATA_OFF,
  99         FLDT_DIR2_DATA_OFFNZ,
 100         FLDT_DIR2_DATA_UNION,
 101         FLDT_DIR2_FREE_HDR,
 102         FLDT_DIR2_INO4,
 103         FLDT_DIR2_INO8,
 104         FLDT_DIR2_INOU,
 105         FLDT_DIR2_LEAF_ENTRY,
 106         FLDT_DIR2_LEAF_HDR,
 107         FLDT_DIR2_LEAF_TAIL,
 108         FLDT_DIR2_SF_ENTRY,
 109         FLDT_DIR2_SF_HDR,
 110         FLDT_DIR2_SF_OFF,
 111         FLDT_DIR2SF,
 112
 113         /* dir v3 fields */
 114         FLDT_DIR3,
 115         FLDT_DIR3_BLKHDR,
 116         FLDT_DIR3_DATA_HDR,
 117         FLDT_DIR3_FREE_HDR,
 118         FLDT_DIR3_LEAF_HDR,
 119         FLDT_DIR3_DATA_UNION,
 120         FLDT_DIR3_SF_ENTRY,
 121         FLDT_DIR3SF,
 122
 123         /* dir v2/3 node fields */
 124         FLDT_DA_BLKINFO,
 125         FLDT_DA_NODE_ENTRY,
 126         FLDT_DA_NODE_HDR,
 127         FLDT_DA3_BLKINFO,
 128         FLDT_DA3_NODE_HDR,
 129
 130         FLDT_DIRBLOCK,
 131         FLDT_DISK_DQUOT,
 132         FLDT_DQBLK,
 133         FLDT_DQID,
 134         FLDT_DRFSBNO,
 135         FLDT_DRTBNO,
 136         FLDT_EXTLEN,
 137         FLDT_EXTNUM,
 138         FLDT_FSIZE,
 139         FLDT_INO,
 140         FLDT_INOBT,
 141         FLDT_INOBT_CRC,
 142         FLDT_INOBTKEY,
 143         FLDT_INOBTPTR,
 144         FLDT_INOBTREC,
 145         FLDT_INODE,
 146         FLDT_INODE_CRC,
 147         FLDT_INOFREE,
 148         FLDT_INT16D,
 149         FLDT_INT32D,
 150         FLDT_INT64D,
 151         FLDT_INT8D,
 152         FLDT_NSEC,
 153         FLDT_QCNT,
 154         FLDT_QWARNCNT,
 155         FLDT_SB,
 156
 157         /* CRC enabled symlink */
 158         FLDT_SYMLINK_CRC,
 159
 160         FLDT_TIME,
 161         FLDT_TIMESTAMP,
 162         FLDT_UINT1,
 163         FLDT_UINT16D,
 164         FLDT_UINT16O,
 165         FLDT_UINT16X,
 166         FLDT_UINT32D,
 167         FLDT_UINT32O,
 168         FLDT_UINT32X,
 169         FLDT_UINT64D,
 170         FLDT_UINT64O,
 171         FLDT_UINT64X,
 172         FLDT_UINT8D,
 173         FLDT_UINT8O,
 174         FLDT_UINT8X,
 175         FLDT_UUID,
 176         FLDT_ZZZ                        /* mark last entry */
 177 } fldt_t;
 178
 179 typedef int (*offset_fnc_t)(void *obj, int startoff, int idx);
 180 #define OI(o)   ((offset_fnc_t)(__psint_t)(o))
 181
 182 typedef int (*count_fnc_t)(void *obj, int startoff);
 183 #define CI(c)   ((count_fnc_t)(__psint_t)(c))
 184 #define C1      CI(1)
 185
 186 typedef struct field
 187 {
 188         char            *name;
 189         fldt_t          ftyp;
 190         offset_fnc_t    offset;
 191         count_fnc_t     count;
 192         int             flags;
 193         typnm_t         next;
 194 } field_t;
 195
 196 /*
 197  * flag values
 198  */
 199 #define FLD_ABASE1      1       /* field array base is 1 not 0 */
 200 #define FLD_SKIPALL     2       /* skip this field in an all-fields print */
 201 #define FLD_ARRAY       4       /* this field is an array */
 202 #define FLD_OFFSET      8       /* offset value is a function pointer */
 203 #define FLD_COUNT       16      /* count value is a function pointer */
 204
 205 typedef int (*size_fnc_t)(void *obj, int startoff, int idx);
 206 #define SI(s)   ((size_fnc_t)(__psint_t)(s))
 207
 208 typedef struct ftattr
 209 {
 210         fldt_t          ftyp;
 211         char            *name;
 212         prfnc_t         prfunc;
 213         char            *fmtstr;
 214         size_fnc_t      size;
 215         int             arg;
 216         adfnc_t         adfunc;
 217         const field_t   *subfld;
 218 } ftattr_t;
 219 extern const ftattr_t   ftattrtab[];
 220
 221 /*
 222  * arg values
 223  */
 224 #define FTARG_SKIPZERO  1       /* skip 0 words */
 225 #define FTARG_DONULL    2       /* make -1 words be "null" */
 226 #define FTARG_SKIPNULL  4       /* skip -1 words */
 227 #define FTARG_SIGNED    8       /* field value is signed */
 228 #define FTARG_SIZE      16      /* size field is a function */
 229 #define FTARG_SKIPNMS   32      /* skip printing names this time */
 230 #define FTARG_OKEMPTY   64      /* ok if this (union type) is empty */
 231
 232 extern int              bitoffset(const field_t *f, void *obj, int startoff,
 233                                   int idx);
 234 extern int              fcount(const field_t *f, void *obj, int startoff);
 235 extern const field_t    *findfield(char *name, const field_t *fields,
 236                                   void *obj, int startoff);
 237 extern int              fsize(const field_t *f, void *obj, int startoff,
 238                                   int idx);