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 /** Tipo de archivo. */
  48 typedef enum {
  49         T1, /**< Archivo de bloque parametrizado y registro variable. */
  50         T2, /**< Archivo sin bloques y registros variables. */
  51         T3  /**< Archivo de bloque parametrizado y registro fijo. */
  52 } EMUFS_Tipo;
  53
  54 /** Tipo de identificador de registro. */
  55 typedef unsigned long EMUFS_REG_ID;
  56
  57 /** Tipo de tamaño de registro. */
  58 typedef unsigned long EMUFS_REG_SIZE;
  59
  60 /** Tipo de identificador de bloque. */
  61 typedef unsigned long EMUFS_BLOCK_ID;
  62
  63 /** Tipo de tamaño de bloque. */
  64 typedef unsigned long EMUFS_BLOCK_SIZE;
  65
  66 /** Tipo de espacio libre. */
  67 typedef unsigned long EMUFS_FREE;
  68
  69 /** Tipo de offset. */
  70 typedef unsigned long EMUFS_OFFSET;
  71
  72 /** Constante para indicar el valor especial de un ID inválido.
  73  *
  74  *  El uso típico es para indicar que no se encontró el ID en una búsqueda.
  75  */
  76 #define EMUFS_NOT_FOUND -1ul
  77
  78 /** Estadisticas de archivo. */
  79 typedef struct _emufs_est_t {
  80         unsigned long tam_archivo;/**< Tamaño en bytes del archivo .dat */
  81         unsigned long tam_archivos_aux;/**< Tamaño en bytes de los archivos auxiliares sumados */
  82         unsigned long tam_info_control_dat;/**< Cantidad de bytes en info de control del .dat */
  83         unsigned long media_fs;/**< Media del espacio libre en el archivo de datos */
  84         unsigned long total_fs;/**< Cantidad total de espacio libre en el archivo de datos */
  85         unsigned long max_fs;/**< Cantidad de maxima libre (gap o fs en bloque) en el archivo de datos */
  86         unsigned long min_fs;/**< Cantidad de minima libre (gap o fs en bloque) en el archivo de datos */
  87         unsigned long cant_bloques; /**< Cantidad de bloques en el archivo de datos */
  88         unsigned long cant_registros; /**< Cantidad de Registros en el archivo */
  89 } EMUFS_Estadisticas;
  90
  91 /** Tipo Abstracto para menajo de archivos.
  92  *
  93  *  Esta estructura es utilizada para acceder a cualquier tipo de archivo.
  94  *
  95  *  Cuando se requiere abrir o crear un nuevo archivo, esta estrucura contendrá los
  96  *  punteros a los métodos de dicho archivo, por lo que desde el código que utilice
  97  *  esta estructura no deberá ser modificado por cada tipo de archivo.
  98  *
  99  *  Por ejemplo:
 100  *  \code
 101  *    EMUFS *fs = emufs_abrir("archivo");
 102  *    fs->leer_registro(id, ptr, size);
 103  *  \endcode
 104  *
 105  *  Este ejemplo funcionará sin importar de que tipo de archivo se trate, sin
 106  *  la necesidad de que el usuario tenga que hacer una selección previa del tipo
 107  *  para llamar al método correspondiente a cada tipo de archivo.
 108  */
 109 typedef struct _emu_fs_t {
 110         EMUFS_Tipo tipo;
 111         EMUFS_BLOCK_SIZE tam_bloque; /**< Tamaño de bloque. 0 Si no tiene bloques */
 112         EMUFS_REG_SIZE tam_reg; /**< Tamaño de registro. 0 Si son registros variables */
 113         void* (*leer_bloque)(struct _emu_fs_t*, EMUFS_BLOCK_ID, int*); /**< Método para leer un bloque */
 114         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 */
 115         void* (*leer_registro)(struct _emu_fs_t*, EMUFS_REG_ID, EMUFS_REG_SIZE*, int*); /**< Método para leer un registro */
 116         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 */
 117         EMUFS_REG_ID (*grabar_registro)(struct _emu_fs_t*, void*, EMUFS_REG_SIZE, int*); /**< Método para grabar un registro */
 118         EMUFS_REG_ID (*modificar_registro)(struct _emu_fs_t*, EMUFS_REG_ID, void*, EMUFS_REG_SIZE, int*); /**< Método para modificar un registro */
 119         int (*borrar_registro)(struct _emu_fs_t*, EMUFS_REG_ID); /**< Método para borrar un registro */
 120         EMUFS_Estadisticas (*leer_estadisticas)(struct _emu_fs_t *); /**< Método para obtener estádisticas sobre el archivo */
 121         void (*compactar)(struct _emu_fs_t *); /**< Método para compactar el archivo reorganizándolo físicamente */
 122         char *nombre; /**< Nombre del archivo */
 123 } EMUFS;
 124
 125 /** Crea un archivo auxiliar. */
 126 int emufs_crear_archivo_auxiliar(const char*, const char*);
 127
 128 /** Crea un nuevo archivo EMUFS.
 129  *
 130  *  Un archivo EMUFS está compuesto por 4 archivos a nivel del SO.
 131  *  Un archivo principal con extensión .dat y 3 archivos auxiliares para
 132  *  manejo interno.
 133  *
 134  *  El parámetro filename que recive esta función en el nombre virtual que se
 135  *  utilizará, ya que las extensiones serán puestas automáticamente for EMUFS.
 136  *
 137  *  Un ejemplo:
 138  *  \code
 139  *  EMUFS *fp  emufs_crear("archivo", T3, 100, 100);
 140  *  \endcode
 141  *
 142  *  En el ejemplo anterior se tiene que nuestro filesystem virtual se llamará
 143  *  archivo.
 144  *
 145  *  Los últimos 2 parámetros serán ignorados si el tipo de archivo no utiliza
 146  *  dicho parámetro.
 147  *
 148  *  \param filename Nombre del archivo virtual.
 149  *  \param tipo Tipo de archivo.
 150  *  \param tam_bloque Tamaño del bloque.
 151  *  \param tam_reg Tamaño del registro.
 152  */
 153 EMUFS *emufs_crear(const char *filename, EMUFS_Tipo tipo,EMUFS_BLOCK_SIZE tam_bloque, EMUFS_REG_SIZE tam_reg);
 154
 155 /** Abre un archivo EMUFS.
 156  *
 157  *  Abre un archivo, determinando de que tipo se trata.
 158  *
 159  *  \param filename Nombre del archivo virtual.
 160  */
 161 EMUFS *emufs_abrir(const char *filename);
 162
 163 /** Libera un archivo virtual */
 164 int emufs_destruir(EMUFS *e);
 165
 166 /** mustra archivos auxiliares, para debug. */
 167 int ver_archivo_FS(EMUFS *emu);
 168
 169 /** muestra estadisticas, para debug. */
 170 int debug_ver_estadisticas(EMUFS *emu);
 171
 172 #endif /* _EMUFS_H_ */