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 \param ID, y almacena en \param 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   */
  55 void* emufs_tipo3_leer_registro(EMUFS *emu, EMUFS_REG_ID ID, EMUFS_REG_SIZE* reg_size, int* err);
  56
  57 /** Devuelve un puntero con la memoria reservada que contiene el bloque solicitado por
  58   * el segundo parámetro \param num_bloque. Como la numeración de los bloques es virtual,
  59   * el acceso al archivo para levantar un bloque es directo, es decir, se posiciona directamente
  60   * en en número de bloque multiplicado por el tamaño del mismo, salteando antes el encabezado del archivo.
  61   */
  62 void* emufs_tipo3_leer_bloque(EMUFS*, EMUFS_BLOCK_ID, int*);
  63
  64 /** Graba un registro en un bloque donde haya espacio suficiente, y si no
  65   * crea un nuevo bloque y lo agrega al final del archivo.
  66   * El registro a grabar es apuntado por el segundo parámetro \param ptr
  67   * y el tamaño viene indicado en \param tam.
  68   * Luego de realizar la grabación, actualiza los archivos índice con los
  69   * valores correspondientes.
  70   */
  71 EMUFS_REG_ID emufs_tipo3_grabar_registro(EMUFS *emu, void *ptr, EMUFS_REG_SIZE, int*);
  72
  73 /** Graba el bloque apuntado por \param ptr en el archivo */
  74 int emufs_tipo3_grabar_bloque(EMUFS *emu, void *ptr, EMUFS_BLOCK_ID num_bloque);
  75
  76 /** Borra el registro \param id_reg del archivo de datos, y actualiza los archivos
  77   *     de índice para mantener la coherencia en las próximas modificaciones.
  78   */
  79 int emufs_tipo3_borrar_registro(EMUFS *emu, EMUFS_REG_ID id_reg);
  80
  81 /** Método para modificar un registro */
  82 EMUFS_REG_ID emufs_tipo3_modificar_registro(EMUFS *emu, EMUFS_REG_ID, void*, EMUFS_REG_SIZE, int*);
  83
  84 /** Completa una estructura del tipo EMUFS_Estadisticas con las estadísticas del
  85   * archivo de datos, espacio libre total, cantidad de registros, cantidad de bloques,
  86   * tamaño del archivo en bytes, relaciones entre tamaños y espacios libres, etc.
  87   */
  88 EMUFS_Estadisticas emufs_tipo3_leer_estadisticas(EMUFS *);
  89
  90 /** Lee un registro con su informacion de control */
  91 void* emufs_tipo3_leer_registro_raw(struct _emu_fs_t*, EMUFS_REG_ID, EMUFS_REG_SIZE*, int *);
  92
  93 /** Elimina los espacios libres que hay en el archivo */
  94 void emufs_tipo3_compactar(EMUFS *emu);
  95
  96 void emufs_tipo3_leer_bloque_raw(EMUFS *efs, EMUFS_BLOCK_ID id, char **actual, char **anterior, char **siguiente, EMUFS_BLOCK_SIZE *size1, EMUFS_BLOCK_SIZE *size2, EMUFS_BLOCK_SIZE *size3);
  97
  98 #endif /* _EMUFS_TIPO3_H_ */