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 "emufs.h"
  62
  63 /** Inicializa la estructura <em>EMUFS* efs</em> que recibe, asignando las funciones que permiten
  64  * el uso del archivo tipo 2.
  65  *
  66  * \param efs Estructura que realiza el handling de archivos de cualquier tipo.
  67  * \return \b int Indicador de exito de la operacion.
  68  */
  69 int emufs_tipo2_inicializar(EMUFS* efs);
  70
  71 /** Realiza la lectura de un registro en archivos del tipo 2 en base a su \em ID, devolviendo ademas el \em Size del
  72  * registro leido.
  73  *
  74  * \param efs Estructura que realiza el handling de archivos de cualquier tipo.
  75  * \param id_reg Id del registro a leer del archivo de datos.
  76  * \param reg_size Size del registro leido que es devuelto a la funcion invocante.
  77  * \param err Indicador de error en la operacion.
  78  * \return \b void* Buffer con el registro leido.
  79  */
  80 void *emufs_tipo2_leer_registro(EMUFS* efs, EMUFS_REG_ID id_reg, EMUFS_REG_SIZE* reg_size, int *err);
  81
  82 /** Realiza la escritura de un registro en archivos del tipo 2 en base a su \em ID, devolviendo ademas el \em Size del
  83  * registro leido.
  84  *
  85  * \param efs Estructura que realiza el handling de archivos de cualquier tipo.
  86  * \param ptr Puntero a la region de memoria que contiene el registro a grabar.
  87  * \param reg_size Size del registro a grabar en disco.
  88   * \param err Indicador de error en la operacion.
  89  * \return \b EMUFS_REG_ID Id del registro que fue grabado.
  90  */
  91 EMUFS_REG_ID emufs_tipo2_grabar_registro(EMUFS *efs, void *ptr, EMUFS_REG_SIZE reg_size, int* err);
  92
  93 /** Realiza el borrado de un registro en archivos del tipo 2 en base a su \em ID.
  94  *
  95  * \param efs Estructura que realiza el handling de archivos de cualquier tipo.
  96  * \param id_reg Id del registro que se quiere eliminar.
  97  * \return \b int Indicador de exito de la operacion.
  98  */
  99 int emufs_tipo2_borrar_registro(EMUFS *efs, EMUFS_REG_ID id_reg);
 100
 101 /** Devuelve el \em Size de un registro dado, en base a su \em ID.
 102  *
 103  * \param efs Estructura que realiza el handling de archivos de cualquier tipo.
 104  * \param reg_pos Id del registro.
 105  * \param reg_size Size del registro que se devuelve a la funcion invocante.
 106  * \return \b int Indicador de exito de la operacion.
 107  */
 108 int emufs_tipo2_get_regsize(EMUFS *efs, EMUFS_OFFSET reg_pos, EMUFS_REG_SIZE *reg_size);
 109
 110 /** Realiza un fill con basura de una region dada dentro de un .dat del tipo2.
 111  *
 112  * \param efs Estructura que realiza el handling de archivos de cualquier tipo.
 113  * \param reg_pos Offset donde comenzar el fill con basura.
 114  * \param amount Cantidad de bytes a escribir en la region indicada.
 115  * \return \b int Indicador de exito de la operacion.
 116  */
 117 int emufs_tipo2_dummyfill(EMUFS *efs, EMUFS_OFFSET reg_pos, EMUFS_REG_SIZE amount);
 118
 119 /** Método para modificar un registro */
 120 EMUFS_REG_ID emufs_tipo2_modificar_registro(EMUFS *efs, EMUFS_REG_ID id, void *data, EMUFS_REG_SIZE size, int *error);
 121
 122 /** Método para recolectar/obtener la estadisticas del archivo tipo 2
 123  *
 124  * \param efs Estructura que realiza el handling de archivos de cualquier tipo.
 125  * \return \b EMUFS_Estadisticas Estructura que alberga las stats recolectadas.
 126  */
 127 EMUFS_Estadisticas emufs_tipo2_leer_estadisticas(EMUFS *efs);
 128
 129 #endif /* _EMUFS_TIPO2_H_ */