emufs/emufs.h

   1 /* vim: set noexpandtab tabstop=4 shiftwidth=4 wrap:
   2  *----------------------------------------------------------------------------
   3  *                                  emufs
   4  *----------------------------------------------------------------------------
   5  * This file is part of emufs.
   6  *
   7  * emufs is free software; you can redistribute it and/or modify it under the
   8  * terms of the GNU General Public License as published by the Free Software
   9  * Foundation; either version 2 of the License, or (at your option) any later
  10  * version.
  11  *
  12  * emufs is distributed in the hope that it will be useful, but WITHOUT ANY
  13  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  14  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
  15  * details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with emufs; if not, write to the Free Software Foundation, Inc., 59 Temple
  19  * Place, Suite 330, Boston, MA  02111-1307  USA
  20  *----------------------------------------------------------------------------
  21  * Creado:  mié mar 31 17:26:46 ART 2004
  22  * Autores: Nicolás Dimov <sagardua@uolsinectis.com.ar>
  23  *          Ricardo Markiewicz <rmarkie@fi.uba.ar>
  24  *          Leandro Lucarella <llucare@fi.uba.ar>
  25  *----------------------------------------------------------------------------
  26  *
  27  * $Id$
  28  *
  29  */
  30
  31 /** \file
  32  *
  33  * Estructura general de un archivo <em>abstracto</em> de emufs.
  34  *
  35  * Interfaz de la estructura abstracta que representa cualquiera de los tipos
  36  * de archivo implementados.
  37  *
  38  */
  39
  40 #ifndef _EMUFS_H_
  41 #define _EMUFS_H_
  42
  43 #include <stdlib.h>
  44 #include <stdio.h>
  45 #include <limits.h>
  46
  47 #include "indices.h"
  48
  49 /** Tipo de archivo. */
  50 typedef enum {
  51         T1, /**< Archivo de bloque parametrizado y registro variable. */
  52         T2, /**< Archivo sin bloques y registros variables. */
  53         T3,     /**< Archivo de bloque parametrizado y registro fijo. */
  54         T4, /**< Archivo de bloque parametrizado y registro variables secuencial indexado. */
  55         T5  /**< Archivo de bloque parametrizado y registro fijo secuencial indexado. */
  56 } EMUFS_Tipo;
  57
  58 /** Tipo de identificador de registro. */
  59 typedef unsigned long EMUFS_REG_ID;
  60
  61 /** Tipo de tamaño de registro. */
  62 typedef unsigned long EMUFS_REG_SIZE;
  63
  64 /** Tipo de identificador de bloque. */
  65 typedef unsigned long EMUFS_BLOCK_ID;
  66
  67 /** Tipo de tamaño de bloque. */
  68 typedef unsigned long EMUFS_BLOCK_SIZE;
  69
  70 /** Tipo de espacio libre. */
  71 typedef unsigned long EMUFS_FREE;
  72
  73 /** Tipo de offset. */
  74 typedef unsigned long EMUFS_OFFSET;
  75
  76 /** Constante para indicar el valor especial de un ID inválido.
  77  *
  78  *  El uso típico es para indicar que no se encontró el ID en una búsqueda.
  79  */
  80 #define EMUFS_NOT_FOUND -1ul
  81
  82 /** Estadisticas de archivo. */
  83 typedef struct _emufs_est_t {
  84         unsigned long tam_archivo;/**< Tamaño en bytes del archivo .dat */
  85         unsigned long tam_archivos_aux;/**< Tamaño en bytes de los archivos auxiliares sumados */
  86         unsigned long tam_info_control_dat;/**< Cantidad de bytes en info de control del .dat */
  87         unsigned long media_fs;/**< Media del espacio libre en el archivo de datos */
  88         unsigned long total_fs;/**< Cantidad total de espacio libre en el archivo de datos */
  89         unsigned long max_fs;/**< Cantidad de maxima libre (gap o fs en bloque) en el archivo de datos */
  90         unsigned long min_fs;/**< Cantidad de minima libre (gap o fs en bloque) en el archivo de datos */
  91         unsigned long cant_bloques; /**< Cantidad de bloques en el archivo de datos */
  92         unsigned long cant_registros; /**< Cantidad de Registros en el archivo */
  93 } EMUFS_Estadisticas;
  94
  95 /** Tipo Abstracto para menajo de archivos.
  96  *
  97  *  Esta estructura es utilizada para acceder a cualquier tipo de archivo.
  98  *
  99  *  Cuando se requiere abrir o crear un nuevo archivo, esta estrucura contendrá los
 100  *  punteros a los métodos de dicho archivo, por lo que desde el código que utilice
 101  *  esta estructura no deberá ser modificado por cada tipo de archivo.
 102  *
 103  *  Por ejemplo:
 104  *  \code
 105  *    EMUFS *fs = emufs_abrir("archivo");
 106  *    fs->leer_registro(id, ptr, size);
 107  *  \endcode
 108  *
 109  *  Este ejemplo funcionará sin importar de que tipo de archivo se trate, sin
 110  *  la necesidad de que el usuario tenga que hacer una selección previa del tipo
 111  *  para llamar al método correspondiente a cada tipo de archivo.
 112  */
 113 struct _emu_fs_t {
 114         EMUFS_Tipo tipo;
 115         EMUFS_BLOCK_SIZE tam_bloque; /**< Tamaño de bloque. 0 Si no tiene bloques */
 116         EMUFS_REG_SIZE tam_reg; /**< Tamaño de registro. 0 Si son registros variables */
 117         void* (*leer_bloque)(struct _emu_fs_t*, EMUFS_BLOCK_ID, int*); /**< Método para leer un bloque */
 118         void (*leer_bloque_raw)(struct _emu_fs_t*, EMUFS_BLOCK_ID, char **, char **, char **, EMUFS_BLOCK_SIZE *, EMUFS_BLOCK_SIZE *, EMUFS_BLOCK_SIZE *); /**< Método para leer un bloque, el anterior y el siguiente */
 119         void* (*leer_registro)(struct _emu_fs_t*, CLAVE, EMUFS_REG_SIZE*, int*); /**< Método para leer un registro */
 120         void* (*leer_registro_raw)(struct _emu_fs_t*, EMUFS_REG_ID, EMUFS_REG_SIZE*, int *); /**< Método para leer un registro con todo su bloque asociado */
 121         EMUFS_REG_ID (*grabar_registro)(struct _emu_fs_t*, void*, EMUFS_REG_SIZE, int*); /**< Método para grabar un registro */
 122         EMUFS_REG_ID (*modificar_registro)(struct _emu_fs_t*, CLAVE k, void*, EMUFS_REG_SIZE, int*, INDICE_DATO); /**< Método para modificar un registro */
 123         int (*borrar_registro)(struct _emu_fs_t*, CLAVE, INDICE_DATO); /**< Método para borrar un registro */
 124         EMUFS_Estadisticas (*leer_estadisticas)(struct _emu_fs_t *); /**< Método para obtener estádisticas sobre el archivo */
 125         void (*compactar)(struct _emu_fs_t *); /**< Método para compactar el archivo reorganizándolo físicamente */
 126         char *nombre; /**< Nombre del archivo */
 127
 128         /* Lista de Indices */
 129         INDICE *indices;
 130         /* Indice externo para utilizar con Facturas
 131          * e indexar por NroArticulo
 132          */
 133         INDICE *externo;
 134 };
 135
 136 /** Crea un archivo auxiliar. */
 137 int emufs_crear_archivo_auxiliar(const char*, const char*);
 138
 139 /** Crea un nuevo archivo EMUFS.
 140  *
 141  *  Un archivo EMUFS está compuesto por 4 archivos a nivel del SO.
 142  *  Un archivo principal con extensión .dat y 3 archivos auxiliares para
 143  *  manejo interno.
 144  *
 145  *  El parámetro filename que recive esta función en el nombre virtual que se
 146  *  utilizará, ya que las extensiones serán puestas automáticamente for EMUFS.
 147  *
 148  *  Un ejemplo:
 149  *  \code
 150  *  EMUFS *fp  emufs_crear("archivo", T3, 100, 100);
 151  *  \endcode
 152  *
 153  *  En el ejemplo anterior se tiene que nuestro filesystem virtual se llamará
 154  *  archivo.
 155  *
 156  *  Los últimos 2 parámetros serán ignorados si el tipo de archivo no utiliza
 157  *  dicho parámetro.
 158  *
 159  *  \param filename Nombre del archivo virtual.
 160  *  \param tipo Tipo de archivo.
 161  *  \param tam_bloque Tamaño del bloque.
 162  *  \param tam_reg Tamaño del registro.
 163  */
 164 EMUFS *emufs_crear(const char *filename, EMUFS_Tipo tipo,EMUFS_BLOCK_SIZE tam_bloque, EMUFS_REG_SIZE tam_reg);
 165
 166 /** Abre un archivo EMUFS.
 167  *
 168  *  Abre un archivo, determinando de que tipo se trata.
 169  *
 170  *  \param filename Nombre del archivo virtual.
 171  */
 172 EMUFS *emufs_abrir(const char *filename);
 173
 174 /** Libera un archivo virtual */
 175 int emufs_destruir(EMUFS *e);
 176
 177 /** mustra archivos auxiliares, para debug. */
 178 int ver_archivo_FS(EMUFS *emu);
 179
 180 /** muestra estadisticas, para debug. */
 181 int debug_ver_estadisticas(EMUFS *emu);
 182
 183 int emufs_agregar_indice(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);
 184
 185 INDICE_DATO *emufs_buscar_registros(EMUFS *emu, char *indice, char *data, int *cant);
 186
 187 INDICE *emufs_buscar_indice_por_nombre(EMUFS *emu, const char *nombre);
 188
 189 EMUFS_BLOCK_ID emufs_create_new_block(EMUFS *emu);
 190
 191 EMUFS_BLOCK_ID emufs_get_new_block_number(EMUFS *emu);
 192 #endif /* _EMUFS_H_ */