fs/jfs/jfs_btree.h

   1 /*
   2  *   Copyright (c) International Business Machines Corp., 2000-2001
   3  *
   4  *   This program is free software;  you can redistribute it and/or modify
   5  *   it under the terms of the GNU General Public License as published by
   6  *   the Free Software Foundation; either version 2 of the License, or
   7  *   (at your option) any later version.
   8  *
   9  *   This program is distributed in the hope that it will be useful,
  10  *   but WITHOUT ANY WARRANTY;  without even the implied warranty of
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
  12  *   the 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 to the Free Software
  16  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  17  */
  18 #ifndef _H_JFS_BTREE
  19 #define _H_JFS_BTREE
  20
  21 /*
  22  *      jfs_btree.h: B+-tree
  23  *
  24  * JFS B+-tree (dtree and xtree) common definitions
  25  */
  26
  27 /*
  28  *      basic btree page - btpage
  29  *
  30 struct btpage {
  31         s64 next;               right sibling bn
  32         s64 prev;               left sibling bn
  33
  34         u8 flag;
  35         u8 rsrvd[7];            type specific
  36         s64 self;               self address
  37
  38         u8 entry[4064];
  39 };                                              */
  40
  41 /* btpaget_t flag */
  42 #define BT_TYPE         0x07    /* B+-tree index */
  43 #define BT_ROOT         0x01    /* root page */
  44 #define BT_LEAF         0x02    /* leaf page */
  45 #define BT_INTERNAL     0x04    /* internal page */
  46 #define BT_RIGHTMOST    0x10    /* rightmost page */
  47 #define BT_LEFTMOST     0x20    /* leftmost page */
  48 #define BT_SWAPPED      0x80    /* used by fsck for endian swapping */
  49
  50 /* btorder (in inode) */
  51 #define BT_RANDOM               0x0000
  52 #define BT_SEQUENTIAL           0x0001
  53 #define BT_LOOKUP               0x0010
  54 #define BT_INSERT               0x0020
  55 #define BT_DELETE               0x0040
  56
  57 /*
  58  *      btree page buffer cache access
  59  */
  60 #define BT_IS_ROOT(MP) (((MP)->xflag & COMMIT_PAGE) == 0)
  61
  62 /* get page from buffer page */
  63 #define BT_PAGE(IP, MP, TYPE, ROOT)\
  64         (BT_IS_ROOT(MP) ? (TYPE *)&JFS_IP(IP)->ROOT : (TYPE *)(MP)->data)
  65
  66 /* get the page buffer and the page for specified block address */
  67 #define BT_GETPAGE(IP, BN, MP, TYPE, SIZE, P, RC, ROOT)\
  68 {\
  69         if ((BN) == 0)\
  70         {\
  71                 MP = (struct metapage *)&JFS_IP(IP)->bxflag;\
  72                 P = (TYPE *)&JFS_IP(IP)->ROOT;\
  73                 RC = 0;\
  74                 jEVENT(0,("%d BT_GETPAGE returning root\n", __LINE__));\
  75         }\
  76         else\
  77         {\
  78                 jEVENT(0,("%d BT_GETPAGE reading block %d\n", __LINE__,\
  79                          (int)BN));\
  80                 MP = read_metapage((IP), BN, SIZE, 1);\
  81                 if (MP) {\
  82                         RC = 0;\
  83                         P = (MP)->data;\
  84                 } else {\
  85                         P = NULL;\
  86                         jERROR(1,("bread failed!\n"));\
  87                         RC = EIO;\
  88                 }\
  89         }\
  90 }
  91
  92 #define BT_MARK_DIRTY(MP, IP)\
  93 {\
  94         if (BT_IS_ROOT(MP))\
  95                 mark_inode_dirty(IP);\
  96         else\
  97                 mark_metapage_dirty(MP);\
  98 }
  99
 100 /* put the page buffer */
 101 #define BT_PUTPAGE(MP)\
 102 {\
 103         if (! BT_IS_ROOT(MP)) \
 104                 release_metapage(MP); \
 105 }
 106
 107
 108 /*
 109  *      btree traversal stack
 110  *
 111  * record the path traversed during the search;
 112  * top frame record the leaf page/entry selected.
 113  */
 114 #define MAXTREEHEIGHT           8
 115 struct btframe {        /* stack frame */
 116         s64 bn;                 /* 8: */
 117         s16 index;              /* 2: */
 118         s16 lastindex;          /* 2: */
 119         struct metapage *mp;    /* 4: */
 120 };                              /* (16) */
 121
 122 struct btstack {
 123         struct btframe *top;
 124         int nsplit;
 125         struct btframe stack[MAXTREEHEIGHT];
 126 };
 127
 128 #define BT_CLR(btstack)\
 129         (btstack)->top = (btstack)->stack
 130
 131 #define BT_PUSH(BTSTACK, BN, INDEX)\
 132 {\
 133         (BTSTACK)->top->bn = BN;\
 134         (BTSTACK)->top->index = INDEX;\
 135         ++(BTSTACK)->top;\
 136         assert((BTSTACK)->top != &((BTSTACK)->stack[MAXTREEHEIGHT]));\
 137 }
 138
 139 #define BT_POP(btstack)\
 140         ( (btstack)->top == (btstack)->stack ? NULL : --(btstack)->top )
 141
 142 #define BT_STACK(btstack)\
 143         ( (btstack)->top == (btstack)->stack ? NULL : (btstack)->top )
 144
 145 /* retrieve search results */
 146 #define BT_GETSEARCH(IP, LEAF, BN, MP, TYPE, P, INDEX, ROOT)\
 147 {\
 148         BN = (LEAF)->bn;\
 149         MP = (LEAF)->mp;\
 150         if (BN)\
 151                 P = (TYPE *)MP->data;\
 152         else\
 153                 P = (TYPE *)&JFS_IP(IP)->ROOT;\
 154         INDEX = (LEAF)->index;\
 155 }
 156
 157 /* put the page buffer of search */
 158 #define BT_PUTSEARCH(BTSTACK)\
 159 {\
 160         if (! BT_IS_ROOT((BTSTACK)->top->mp))\
 161                 release_metapage((BTSTACK)->top->mp);\
 162 }
 163 #endif                          /* _H_JFS_BTREE */