emufs/indices.h

   1
   2 #ifndef _INDICES_H_
   3 #define _INDICES_H_
   4
   5 #include <stdlib.h>
   6 #include <string.h>
   7
   8 #include "common.h"
   9
  10 #define STRUCT_OFFSET(x, y) ((int)(&(x->y))-(int)(x))
  11
  12 typedef struct _emu_fs_t EMUFS;
  13
  14 /** Dato guardado junto con la clave */
  15 typedef struct _reg_def_ {
  16         long id;
  17         long bloque;
  18 } INDICE_DATO;
  19
  20 /** Tipos de Indices conocidos */
  21 typedef enum {
  22         IND_B, /**< Utilizacion de Arboles B */
  23         IND_B_ASC, /**< Utilizacion de Arboles B* */
  24         IND_B_PLUS
  25 } INDICE_TIPO;
  26
  27 typedef enum {
  28         IND_PRIMARIO,
  29         IND_SELECCION,
  30         IND_EXAHUSTIVO
  31 } INDICE_FUNCION;
  32
  33 /** Tipos de datos soportados para las claves */
  34 typedef enum {
  35         IDX_FLOAT,
  36         IDX_INT,
  37         IDX_STRING
  38 } INDICE_TIPO_DATO;
  39
  40 /** Clave de indice
  41  *
  42  *  Si el tipo de clave es IDX_STRING se utiliza
  43  *  i_clave y representa el ID en un EMUFS Tipo2
  44  *  sin indices donde esta el texto de la clave
  45  */
  46 typedef union _data_ {
  47         float f_clave;
  48         int i_clave;
  49 } CLAVE;
  50
  51 /** Bucket de keys en bloque para B+ */
  52 typedef struct _keybucket_ {
  53         int cant_keys;
  54         int current_key;
  55         CLAVE *claves;
  56 } B_PLUS_KEYBUCKET;
  57
  58 /** Manejo de Indices independiente */
  59 typedef struct _indices_h_ {
  60         INDICE_TIPO tipo;             /**< Tipo de indice */
  61         INDICE_TIPO_DATO tipo_dato;   /**< Tipo de dato a manejar */
  62         INDICE_FUNCION funcion;       /**< Funcion del indice */
  63         int offset;                   /**< Offset desde el inicio del dato hasta el lugar donde esta la clave */
  64         int str_offset;               /**< Si el campo es de string, aca va el numero de \0 que me tengo que saltar */
  65         unsigned int tam_bloque;      /**< Tamaño del bloque (nodo). Deber set multiplo de 512! */
  66
  67         /******NICO********/
  68         unsigned int size_claves;
  69         unsigned int size_hijos;
  70         B_PLUS_KEYBUCKET *keybucket; /**< Usado por B+ para implementar el obtener_sig_clave. Posee keys de un bloque */
  71         /******NICO********/
  72         /** Agrega la clave k de posicion location en el
  73          * indice de forma ordenada
  74          */
  75         int (*agregar_entrada)(struct _indices_h_ *idx, CLAVE k, INDICE_DATO dato);
  76         /** Borra del indice la clave k . Si el indice en multiple en dato
  77          * se le debe pasar cual de los datos borrar. */
  78         int (*borrar_entrada)(struct _indices_h_ *idx, CLAVE k, INDICE_DATO dato);
  79         /** Determina si existe la clave k retornando su posicion o -1
  80          * en caso fallido
  81          */
  82         INDICE_DATO (*existe_entrada)(struct _indices_h_ *idx, CLAVE k);
  83
  84         INDICE_DATO *(*buscar_entradas)(struct _indices_h_ *idx, CLAVE k, int *cant);
  85
  86         CLAVE (*obtener_menor_clave)(struct _indices_h_ *idx);
  87         CLAVE (*obtener_mayor_clave)(struct _indices_h_ *idx);
  88
  89         CLAVE (*obtener_sig_clave)(struct _indices_h_ *idx, CLAVE k);
  90
  91         char *nombre;   /**< Nombre único de busqueda del indice */
  92         char *filename; /**< nombre del archivo de indice */
  93
  94         EMUFS *emu_string; /**< EMUFS Tipo2 donde se guardan las claves de tipo string */
  95
  96         /** EMUFS Donde se guardan INDICE_DATO de multiples claves con repeticion
  97          *
  98          *  La forma de guardar es la siguiente :
  99          *  \code
 100          *  +------+---------//---------+
 101          *  | CANT |    DATA \\         |
 102          *  +------+---------//---------+
 103          *  \endcode
 104          *
 105          *  Donde CANT es un entero (int) y DATA es un array
 106          *  de INDICE_DATO que apunta al archivo de datos
 107          *  pripiamente dicho
 108          */
 109         EMUFS *emu_mult;
 110         struct _indices_h_ *sig; /**< Siguiente indice */
 111 } INDICE;
 112
 113 /** Crea un nuevo indice
 114  *
 115  *  \param emu EMUFS a quien pertenece
 116  *  \param nombre Nombre del indice
 117  *  \param tipo Tipo de indice
 118  *  \param tipo_dato Tipo de dato de la clave
 119  *  \param offset Desplazamiento de la clave dentro del dato
 120  *  \param tam_bloque Tamaño del bloque (nodo) del arbol
 121  */
 122 INDICE *emufs_indice_crear(EMUFS *emu, char *nombre, INDICE_FUNCION funcion, INDICE_TIPO tipo, INDICE_TIPO_DATO tipo_dato, unsigned int offset, unsigned tam_bloque, int str_offset);
 123 INDICE *emufs_indice_abrir(EMUFS *emu, char *nombre, INDICE_FUNCION funcion, INDICE_TIPO tipo, INDICE_TIPO_DATO tipo_dato, unsigned int offset, unsigned int tam_bloque, int str_offset);
 124
 125 /** Destruye un indice
 126  *
 127  *  \todo hacer/revisar
 128  */
 129 void emufs_indice_destruir(EMUFS *emu, INDICE *i);
 130
 131 /** Agrega una clave en los indices
 132  *
 133  *  Agrega la clave en todos los indice, dependiendo de su tipo
 134  *  de dato, tipo de arboo, offset, etc
 135  *
 136  *  \param primer Primer indice a agregar
 137  *  \param data Array de datos desde donde tomar las claves
 138  *  \param ubicacion Dato a guardar asociado a la clave
 139  */
 140 void emufs_indice_agregar(INDICE *primero, char *data, INDICE_DATO dato);
 141
 142 void emufs_indice_borrar(INDICE *primero, CLAVE k, INDICE_DATO dato);
 143
 144 INDICE_DATO emufs_indice_buscar(INDICE *primero, char *data);
 145
 146 CLAVE emufs_indice_generar_clave(INDICE *idx, char *data);
 147 CLAVE emufs_indice_generar_clave_desde_valor(INDICE *idx, char *data);
 148 void emufs_indice_obtener_valor_desde_clave(INDICE *idx, CLAVE k, void *dst);
 149
 150 /** Compara 2 claves de la forma c1 < c2 */
 151 int emufs_indice_es_menor(INDICE *idx, CLAVE c1, CLAVE c2);
 152
 153 /** Compara 2 claves de la forma c1 == c2 */
 154 int emufs_indice_es_igual(INDICE *idx, CLAVE c1, CLAVE c2);
 155 int emufs_indice_es_clave_nula(INDICE *idx, CLAVE k);
 156 #endif