src/btree.h

   1
   2 #ifndef _B_TREE_H
   3 #define _B_TREE_H
   4
   5 /**
   6  *  La estructura general del archivo seria :
   7  *   +----------+----------+----------+-----+----------+
   8  *   |FileHeader| Bloque 0 | Bloque 1 | ... | Bloque N |
   9  *   +----------+----------+----------+-----+----------+
  10  *
  11  * Cada bloque tiene su propio encabezado siguiendo la siguiente
  12  * estructura :
  13  *   +--------------+-----------------------------------+
  14  *   | BloqueHeader | Area de Claves                    |
  15  *   +--------------+-----------------------------------+
  16  *
  17  * El area de claves depende del tipo de arbol (INDICE o EXAHUSTIVO)
  18  * y del tipo de clave (Longitud fija o variable).
  19  *
  20  * Los nodos que "hojas" (es decir, aquellos que no tienen hijos) no
  21  * tienen "punteros", por lo que el area de datos seria algo como :
  22  *  +--------------+--------------+--------------+--------------+
  23  *  | clave1,dato1 | clave2,dato2 | ............ | claveN,datoN |
  24  *  +--------------+--------------+--------------+--------------+
  25  *
  26  * Ahora, los bloques intermedios tienen punteros a los hijos, y
  27  * quedaria algo como :
  28  *  +---------+----------------------+-------+----------------------+
  29  *  | HijoIzq | clave1,dato1,HijoDer | ..... | claveN,datoN,HijoDer |
  30  *  +---------+----------------------+-------+----------------------+
  31  *
  32  * El tamaño de la clave es variable, por lo que la cantidad de claves
  33  * que puede almacenar se basa en la cantidad de espacio libre.
  34  *
  35  * Para saber si hay que romper en dos un nodo, se debe ver si la clave
  36  * a agregar entra en el espacio libre del nodo encontrado como "lugar
  37  * de insercion". Ahora, un problema a resolver es cuando se debe
  38  * juntar nodos, ya que el arbol B este es particular (Preguntar a Cerveto?).
  39  *
  40  *
  41  * TODO :
  42  *  * Ver como manejar las claves de manera transparente a las APIs de
  43  *    agregar y de borrar (EMUFS lo solucionaba bastante bien, se puede
  44  *    tomar una idea simimar)
  45  */
  46
  47 #include <string>
  48 #include "common.h"
  49
  50 /* alias para codear menos :) */
  51
  52 /** Encabezado del archivo BTree */
  53 typedef struct _btree_file_ {
  54         uint block_size;
  55 } BTreeFileHeader;
  56
  57 /** Encabezado de un bloque */
  58 typedef struct _btree_header_ {
  59         /** Indica a que nivel corresponde un bloque
  60          *
  61          *  nivel == 0 : una hoja
  62          *  nivel != 0 : nodo intermedio
  63          */
  64         unsigned short level;
  65
  66         /** Espacio libre en el bloque
  67          *
  68          *  El nodo empieza con free_space = block_size - sizeof (BTreeHeader)
  69          */
  70         unsigned int free_space;
  71
  72         /** Cantidad de elementos en el nodo */
  73         unsigned int item_count;
  74 } BTreeNodeHeader;
  75
  76 /** Crea un nuevo arbol B
  77  *
  78  *  \param filename Nombre del archivo a crear
  79  *  \param block_size Tamaño de bloque a utilizar
  80  *  \return Un nuevo arbol B creado o NULL en caso de error
  81  */
  82 class BTree {
  83         public:
  84                 BTree (const char *filename, unsigned int block_size, bool create_new_file = false);
  85                 ~BTree ();
  86
  87                 void AddKey ();
  88                 void DelKey ();
  89
  90         private:
  91                 void write_tree_header ();
  92                 void write_block (uchar *block, uint num);
  93                 void ReadNodoHeader (uchar *node, BTreeNodeHeader *header);
  94                 void WriteNodoHeader (uchar *node, BTreeNodeHeader *header);
  95
  96                 std::string filename;
  97                 BTreeFileHeader header;
  98
  99                 /** Apunta al archivo de datos, asi se abre solo 1 vez
 100                  *
 101                  *  \TODO Ver si vale la pena
 102                  */
 103                 FILE *fp;
 104 };
 105
 106 #endif // _B_TREE_H
 107