emufs/tipo3.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:  mié mar 31 17:26:46 ART 2004
  22  * Autores: Nicolás Dimov <sagardua@uolsinectis.com.ar>
  23  *----------------------------------------------------------------------------
  24  *
  25  * $Id$
  26  *
  27  */
  28
  29 /** \file
  30  *
  31  * Archivo con bloques y registros de longitud parametrizada.
  32  *
  33  * Implementación del archivo con bloques y registros de longitud
  34  * parametrizada.
  35  *
  36  */
  37
  38 #ifndef _EMUFS_TIPO3_H_
  39 #define _EMUFS_TIPO3_H_
  40
  41 #include <stdio.h>
  42 #include <stdlib.h>
  43 #include <string.h>
  44 #include <unistd.h>
  45 #include "emufs.h"
  46 #include "did.h"
  47 #include "idx.h"
  48 #include "fsc.h"
  49
  50 /** Devuelve un puntero con la memoria reservada que contiene al registro solicitado
  51   * por el segundo parámetro \c ID, y almacena en \c reg_size el tamaño del
  52   * registro leido, que en este caso no es necesario pues es constante y es conocicdo de antemano.
  53   * Para realizar esta acción, busca en el archivo .idx el bloque al cual pertenece el registro.
  54   * \param emu Esructura para manejar los archivos.
  55   * \param ID Id del registro a leer.
  56   * \param reg_size tamaño del registro.
  57   * \param err Codigo de error devuelto en caso de falla.
  58   */
  59 void* emufs_tipo3_leer_registro(EMUFS *emu, EMUFS_REG_ID ID, EMUFS_REG_SIZE* reg_size, int* err);
  60
  61 /** Devuelve un puntero con la memoria reservada que contiene el bloque solicitado por
  62   * el segundo parámetro \c num_bloque. Como la numeración de los bloques es virtual,
  63   * el acceso al archivo para levantar un bloque es directo, es decir, se posiciona directamente
  64   * en en número de bloque multiplicado por el tamaño del mismo, salteando antes el encabezado del archivo.
  65   * \param emu Esructura para manejar los archivos.
  66   * \param block_id Numero del bloque a leer.
  67   * \param err Codigo de error devuelto en caso de falla.
  68   */
  69 void* emufs_tipo3_leer_bloque(EMUFS *emu, EMUFS_BLOCK_ID block_id, int *err);
  70
  71 /** Graba un registro en un bloque donde haya espacio suficiente, y si no
  72   * crea un nuevo bloque y lo agrega al final del archivo.
  73   * El registro a grabar es apuntado por el segundo parámetro \param ptr
  74   * y el tamaño viene indicado en \c tam.
  75   * Luego de realizar la grabación, actualiza los archivos índice con los
  76   * valores correspondientes.
  77   * \param emu Esructura para manejar los archivos.
  78   * \param ptr Cadena de datos que contiene el registro a grabar.
  79   * \param err Codigo de error devuelto en caso de falla.
  80   */
  81 EMUFS_REG_ID emufs_tipo3_grabar_registro(EMUFS *emu, void *ptr, EMUFS_REG_SIZE, int *err);
  82
  83 /** Graba el bloque apuntado por \c ptr en el archivo
  84   * \param emu Esructura para manejar los archivos.
  85   * \param ptr Cadena de datos que contiene el bloque a grabar.
  86   * \param block_id Numero del bloque a leer.
  87   */
  88 int emufs_tipo3_grabar_bloque(EMUFS *emu, void *ptr, EMUFS_BLOCK_ID num_bloque);
  89
  90 /** Borra el registro \c id_reg del archivo de datos, y actualiza los archivos
  91   *     de índice para mantener la coherencia en las próximas modificaciones.
  92   * \param emu Esructura para manejar los archivos.
  93   * \param id_reg Id del registro a borrar.
  94   */
  95 int emufs_tipo3_borrar_registro(EMUFS *emu, EMUFS_REG_ID id_reg);
  96
  97 /** Método para modificar un registro
  98   * \param emu Esructura para manejar los archivos.
  99   * \param reg_id Id del registro que se quiere modificar.
 100   * \param ptr Cadena de datos que contiene el nuevo registro.
 101   * \param err Codigo de error devuelto en caso de falla.
 102   */
 103 EMUFS_REG_ID emufs_tipo3_modificar_registro(EMUFS *emu, EMUFS_REG_ID reg_id, void *ptr, EMUFS_REG_SIZE, int*err);
 104
 105 /** Completa una estructura del tipo EMUFS_Estadisticas con las estadísticas del
 106   * archivo de datos, espacio libre total, cantidad de registros, cantidad de bloques,
 107   * tamaño del archivo en bytes, relaciones entre tamaños y espacios libres, etc.
 108   * \param emu Esructura para manejar los archivos.
 109   */
 110 EMUFS_Estadisticas emufs_tipo3_leer_estadisticas(EMUFS *emu);
 111
 112 /** Lee un registro con su informacion de control
 113   * \param emu Esructura para manejar los archivos.
 114   * \param ID Id del registro a leer.
 115   * \param reg_size Tamaño del registro.
 116   * \param err Codigo de error devuelto en caso de falla.
 117   */
 118 void* emufs_tipo3_leer_registro_raw(EMUFS *emu, EMUFS_REG_ID reg_id, EMUFS_REG_SIZE *reg_size, int *err);
 119
 120 /** Elimina los espacios libres que hay en el archivo
 121   * \param emu Esructura para manejar los archivos.
 122   */
 123 void emufs_tipo3_compactar(EMUFS *emu);
 124
 125 /** Lee un bloque, el anterior y el siguiente
 126   * \param emu Esructura para manejar los archivos.
 127   * \param block_id Id del bloque a leer.
 128   * \param actual Cadena de datos que almacena el bloque indicado por \c block_id.
 129   * \param anterior Cadena de datos que almacena el bloque anterior al \c actual.
 130   * \param siguiente Cadena de datos que almacena el bloque siguiente al \c actual.
 131   * \param size1 Tamaño del bloque actual.
 132   * \param size2 Tamaño del bloque anterior.
 133   * \param size3 Tamaño del bloque siguiente.
 134   */
 135 void emufs_tipo3_leer_bloque_raw(EMUFS *emu, EMUFS_BLOCK_ID block_id, char **actual, char **anterior, char **siguiente, EMUFS_BLOCK_SIZE *size1, EMUFS_BLOCK_SIZE *size2, EMUFS_BLOCK_SIZE *size3);
 136
 137 #endif /* _EMUFS_TIPO3_H_ */