emufs/tipo2.h

   1 /* vim: set noexpandtab tabstop=4 shiftwidth=4:
   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:  Fri Apr 10 17:10:00 ART 2004
  22  * Autores: Alan Kennedy <kennedya@3dgames.com.ar>
  23  *----------------------------------------------------------------------------
  24  */
  25
  26 /** \file
  27  * Archivo con registros de longitud variable, sin bloques.
  28  *
  29  * <b>Interfaz del Archivo Tipo 2</b>
  30  *
  31  * La organizacion interna de un archivo de tipo 2, presenta registros de longitud variable,
  32  * los cuales son grabados secuencialmente, o bien en gaps (espacios libres) que se presenten en
  33  * el archivo de datos, pero no se encuentran contenidos por bloques.
  34  *
  35  * <b>Estructura Interna</b>: Un registro de este tipo, en disco, sera grabado de la siguiente forma:
  36  *
  37  * [ id_reg ][ reg_size ][ ///// reg_data ///// ]
  38  *
  39  *
  40  * \li EMUFS_REG_ID \c id_reg Id del registro
  41  * \li EMUFS_REG_SIZE \c reg_size Size del registro
  42  * \li char* \c reg_data Datos concretos del registro
  43  *
  44  * <b>Archivos Auxiliares:</b>
  45   * Tendra tres archivos auxiliares que actuaran de Indice para localizar los registros,
  46  * Indice de GAPS o FreeSpace y por ultimo Indice de ID's Libres (al borrarse regs se liberan ids).
  47  *
  48  * \li \c .FSC -- Indice de Gaps o Espacios Libres en el .DAT
  49  * \li \c .IDX -- Indice de Posiciones Relativas u Offsets de los registros en el .DAT
  50  * \li \c .DID -- Indice de Id's Libres para reutilizacion
  51  *
  52  */
  53
  54 #ifndef _EMUFS_TIPO2_H_
  55 #define _EMUFS_TIPO2_H_
  56
  57 #include <stdio.h>
  58 #include <stdlib.h>
  59 #include <string.h>
  60 #include <unistd.h>
  61 #include <math.h>
  62 #include "emufs.h"
  63
  64 /** Inicializa la estructura <em>EMUFS* efs</em> que recibe, asignando las funciones que permiten
  65  * el uso del archivo tipo 2.
  66  *
  67  * \param efs Estructura que realiza el handling de archivos de cualquier tipo.
  68  * \return \b int Indicador de exito de la operacion.
  69  */
  70 int emufs_tipo2_inicializar(EMUFS* efs);
  71
  72 /** Realiza la lectura de un registro en archivos del tipo 2 en base a su \em ID, devolviendo ademas el \em Size del
  73  * registro leido.
  74  *
  75  * \param efs Estructura que realiza el handling de archivos de cualquier tipo.
  76  * \param id_reg Id del registro a leer del archivo de datos.
  77  * \param reg_size Size del registro leido que es devuelto a la funcion invocante.
  78  * \param err Indicador de error en la operacion.
  79  * \return \b void* Buffer con el registro leido.
  80  */
  81 void *emufs_tipo2_leer_registro(EMUFS* efs, EMUFS_REG_ID id_reg, EMUFS_REG_SIZE* reg_size, int *err);
  82
  83 /** Realiza la escritura de un registro en archivos del tipo 2 en base a su \em ID, devolviendo ademas el \em Size del
  84  * registro leido.
  85  *
  86  * \param efs Estructura que realiza el handling de archivos de cualquier tipo.
  87  * \param ptr Puntero a la region de memoria que contiene el registro a grabar.
  88  * \param reg_size Size del registro a grabar en disco.
  89   * \param err Indicador de error en la operacion.
  90  * \return \b EMUFS_REG_ID Id del registro que fue grabado.
  91  */
  92 EMUFS_REG_ID emufs_tipo2_grabar_registro(EMUFS *efs, void *ptr, EMUFS_REG_SIZE reg_size, int* err);
  93
  94 /** Realiza el borrado de un registro en archivos del tipo 2 en base a su \em ID.
  95  *
  96  * \param efs Estructura que realiza el handling de archivos de cualquier tipo.
  97  * \param id_reg Id del registro que se quiere eliminar.
  98  * \return \b int Indicador de exito de la operacion.
  99  */
 100 int emufs_tipo2_borrar_registro(EMUFS *efs, EMUFS_REG_ID id_reg);
 101
 102 /** Devuelve el \em Size de un registro dado, en base a su \em ID.
 103  *
 104  * \param efs Estructura que realiza el handling de archivos de cualquier tipo.
 105  * \param reg_pos Id del registro.
 106  * \param reg_size Size del registro que se devuelve a la funcion invocante.
 107  * \return \b int Indicador de exito de la operacion.
 108  */
 109 int emufs_tipo2_get_regsize(EMUFS *efs, EMUFS_OFFSET reg_pos, EMUFS_REG_SIZE *reg_size);
 110
 111 /** Realiza un fill con basura de una region dada dentro de un .dat del tipo2.
 112  *
 113  * \param efs Estructura que realiza el handling de archivos de cualquier tipo.
 114  * \param reg_pos Offset donde comenzar el fill con basura.
 115  * \param amount Cantidad de bytes a escribir en la region indicada.
 116  * \return \b int Indicador de exito de la operacion.
 117  */
 118 int emufs_tipo2_dummyfill(EMUFS *efs, EMUFS_OFFSET reg_pos, EMUFS_REG_SIZE amount);
 119
 120 /** Método para modificar un registro */
 121 EMUFS_REG_ID emufs_tipo2_modificar_registro(EMUFS *efs, EMUFS_REG_ID id, void *data, EMUFS_REG_SIZE size, int *error);
 122
 123 /** Método para recolectar/obtener la estadisticas del archivo tipo 2
 124  *
 125  * \param efs Estructura que realiza el handling de archivos de cualquier tipo.
 126  * \return \b EMUFS_Estadisticas Estructura que alberga las stats recolectadas.
 127  */
 128 EMUFS_Estadisticas emufs_tipo2_leer_estadisticas(EMUFS *efs);
 129
 130 /** Método para compactar un archivo tipo 2
 131  *
 132  * \param efs Estructura que realiza el handling de archivos de cualquier tipo.
 133  */
 134 void emufs_tipo2_compactar(EMUFS *efs);
 135
 136 /** Método para mover datos de un source a un dest, de a chunks
 137  *
 138  * \param datfile Stream en el cual se esta haciendo el movimiento.
 139  * \param source Source desde donde mover los datos.
 140  * \param destination Destino hacia donde mover los datos.
 141  * \param mustmove_bytes Cantidad de bytes a mover.
 142  */
 143 void emufs_tipo2_movedata(FILE * datfile,EMUFS_OFFSET *source, EMUFS_OFFSET *destination, EMUFS_BLOCK_SIZE mustmove_bytes);
 144
 145 /** Método para sincronizar / actualiza un indice luego de una recompactacion
 146  *
 147  * \param efs Estructura que realiza el handling de archivos de cualquier tipo.
 148  * \return \b int Indicador de exito de la opracion.
 149  */
 150 int emufs_tipo2_updateidx(EMUFS *efs);
 151
 152 #endif /* _EMUFS_TIPO2_H_ */