include/xfs_attr_sf.h

   1 /*
   2  * Copyright (c) 2000 Silicon Graphics, Inc.  All Rights Reserved.
   3  *
   4  * This program is free software; you can redistribute it and/or modify it
   5  * under the terms of version 2 of the GNU General Public License as
   6  * published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it would be useful, but
   9  * WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  11  *
  12  * Further, this software is distributed without any warranty that it is
  13  * free of the rightful claim of any third person regarding infringement
  14  * or the like.  Any license provided herein, whether implied or
  15  * otherwise, applies only to this software file.  Patent licenses, if
  16  * any, provided herein do not apply to combinations of this program with
  17  * other software, or any other product whatsoever.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write the Free Software Foundation, Inc., 59
  21  * Temple Place - Suite 330, Boston MA 02111-1307, USA.
  22  *
  23  * Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
  24  * Mountain View, CA  94043, or:
  25  *
  26  * http://www.sgi.com
  27  *
  28  * For further information regarding this notice, see:
  29  *
  30  * http://oss.sgi.com/projects/GenInfo/SGIGPLNoticeExplan/
  31  */
  32 #ifndef __XFS_ATTR_SF_H__
  33 #define __XFS_ATTR_SF_H__
  34
  35 /*
  36  * Attribute storage when stored inside the inode.
  37  *
  38  * Small attribute lists are packed as tightly as possible so as
  39  * to fit into the literal area of the inode.
  40  */
  41
  42 struct xfs_inode;
  43
  44 /*
  45  * Entries are packed toward the top as tight as possible.
  46  */
  47 typedef struct xfs_attr_shortform {
  48         struct xfs_attr_sf_hdr {        /* constant-structure header block */
  49                 __uint16_t totsize;     /* total bytes in shortform list */
  50                 __uint8_t count;        /* count of active entries */
  51         } hdr;
  52         struct xfs_attr_sf_entry {
  53                 __uint8_t namelen;      /* actual length of name (no NULL) */
  54                 __uint8_t valuelen;     /* actual length of value (no NULL) */
  55                 __uint8_t flags;        /* flags bits (see xfs_attr_leaf.h) */
  56                 __uint8_t nameval[1];   /* name & value bytes concatenated */
  57         } list[1];                      /* variable sized array */
  58 } xfs_attr_shortform_t;
  59 typedef struct xfs_attr_sf_hdr xfs_attr_sf_hdr_t;
  60 typedef struct xfs_attr_sf_entry xfs_attr_sf_entry_t;
  61
  62 /*
  63  * We generate this then sort it, attr_list() must return things in hash-order.
  64  */
  65 typedef struct xfs_attr_sf_sort {
  66         __uint8_t       entno;          /* entry number in original list */
  67         __uint8_t       namelen;        /* length of name value (no null) */
  68         __uint8_t       valuelen;       /* length of value */
  69         xfs_dahash_t    hash;           /* this entry's hash value */
  70         char            *name;          /* name value, pointer into buffer */
  71 } xfs_attr_sf_sort_t;
  72
  73 #if XFS_WANT_FUNCS || (XFS_WANT_SPACE && XFSSO_XFS_ATTR_SF_ENTSIZE_BYNAME)
  74 int xfs_attr_sf_entsize_byname(int nlen, int vlen);
  75 #define XFS_ATTR_SF_ENTSIZE_BYNAME(nlen,vlen)   \
  76         xfs_attr_sf_entsize_byname(nlen,vlen)
  77 #else
  78 #define XFS_ATTR_SF_ENTSIZE_BYNAME(nlen,vlen)   /* space name/value uses */ \
  79         ((int)sizeof(xfs_attr_sf_entry_t)-1 + (nlen)+(vlen))
  80 #endif
  81 #define XFS_ATTR_SF_ENTSIZE_MAX                 /* max space for name&value */ \
  82         ((1 << (NBBY*(int)sizeof(__uint8_t))) - 1)
  83 #if XFS_WANT_FUNCS || (XFS_WANT_SPACE && XFSSO_XFS_ATTR_SF_ENTSIZE)
  84 int xfs_attr_sf_entsize(xfs_attr_sf_entry_t *sfep);
  85 #define XFS_ATTR_SF_ENTSIZE(sfep)       xfs_attr_sf_entsize(sfep)
  86 #else
  87 #define XFS_ATTR_SF_ENTSIZE(sfep)               /* space an entry uses */ \
  88         ((int)sizeof(xfs_attr_sf_entry_t)-1 + (sfep)->namelen+(sfep)->valuelen)
  89 #endif
  90 #if XFS_WANT_FUNCS || (XFS_WANT_SPACE && XFSSO_XFS_ATTR_SF_NEXTENTRY)
  91 xfs_attr_sf_entry_t *xfs_attr_sf_nextentry(xfs_attr_sf_entry_t *sfep);
  92 #define XFS_ATTR_SF_NEXTENTRY(sfep)     xfs_attr_sf_nextentry(sfep)
  93 #else
  94 #define XFS_ATTR_SF_NEXTENTRY(sfep)             /* next entry in struct */ \
  95         ((xfs_attr_sf_entry_t *) \
  96                 ((char *)(sfep) + XFS_ATTR_SF_ENTSIZE(sfep)))
  97 #endif
  98 #if XFS_WANT_FUNCS || (XFS_WANT_SPACE && XFSSO_XFS_ATTR_SF_TOTSIZE)
  99 int xfs_attr_sf_totsize(struct xfs_inode *dp);
 100 #define XFS_ATTR_SF_TOTSIZE(dp)         xfs_attr_sf_totsize(dp)
 101 #else
 102 #define XFS_ATTR_SF_TOTSIZE(dp)                 /* total space in use */ \
 103         (INT_GET(((xfs_attr_shortform_t *)((dp)->i_afp->if_u1.if_data))->hdr.totsize, ARCH_CONVERT))
 104 #endif
 105
 106 #ifdef XFS_ALL_TRACE
 107 #define XFS_ATTR_TRACE
 108 #endif
 109
 110 #if !defined(DEBUG)
 111 #undef  XFS_ATTR_TRACE
 112 #endif
 113
 114 /*
 115  * Kernel tracing support for attribute lists
 116  */
 117 struct xfs_attr_list_context;
 118 struct xfs_da_intnode;
 119 struct xfs_da_node_entry;
 120 struct xfs_attr_leafblock;
 121
 122 #define XFS_ATTR_TRACE_SIZE     4096    /* size of global trace buffer */
 123
 124 /*
 125  * Trace record types.
 126  */
 127 #define XFS_ATTR_KTRACE_L_C     1       /* context */
 128 #define XFS_ATTR_KTRACE_L_CN    2       /* context, node */
 129 #define XFS_ATTR_KTRACE_L_CB    3       /* context, btree */
 130 #define XFS_ATTR_KTRACE_L_CL    4       /* context, leaf */
 131
 132 #if defined(XFS_ATTR_TRACE)
 133
 134 void xfs_attr_trace_l_c(char *where, struct xfs_attr_list_context *context);
 135 void xfs_attr_trace_l_cn(char *where, struct xfs_attr_list_context *context,
 136                               struct xfs_da_intnode *node);
 137 void xfs_attr_trace_l_cb(char *where, struct xfs_attr_list_context *context,
 138                               struct xfs_da_node_entry *btree);
 139 void xfs_attr_trace_l_cl(char *where, struct xfs_attr_list_context *context,
 140                               struct xfs_attr_leafblock *leaf);
 141 void xfs_attr_trace_enter(int type, char *where,
 142                              __psunsigned_t a2, __psunsigned_t a3,
 143                              __psunsigned_t a4, __psunsigned_t a5,
 144                              __psunsigned_t a6, __psunsigned_t a7,
 145                              __psunsigned_t a8, __psunsigned_t a9,
 146                              __psunsigned_t a10, __psunsigned_t a11,
 147                              __psunsigned_t a12, __psunsigned_t a13,
 148                              __psunsigned_t a14, __psunsigned_t a15);
 149 #else
 150 #define xfs_attr_trace_l_c(w,c)
 151 #define xfs_attr_trace_l_cn(w,c,n)
 152 #define xfs_attr_trace_l_cb(w,c,b)
 153 #define xfs_attr_trace_l_cl(w,c,l)
 154 #endif /* XFS_ATTR_TRACE */
 155
 156 #endif  /* __XFS_ATTR_SF_H__ */