Bugfix.

[z.facultad/75.06/emufs.git] / emufs / tipo3.h

diff --git a/emufs/tipo3.h b/emufs/tipo3.h
index 47b25687b17f43ad4471734efe137b2d20213310..df448c1b8d2fa7b9d3455ebaad7eb21d7ef62732 100644 (file)
--- a/emufs/tipo3.h
+++ b/emufs/tipo3.h
@@ -1,36 +1,146 @@
-#ifndef _PARAM_CTE_H_
-#define _PARAM_CTE_H_
+/* vim: set noexpandtab tabstop=4 shiftwidth=4:
+ *----------------------------------------------------------------------------
+ *                                  emufs
+ *----------------------------------------------------------------------------
+ * This file is part of emufs.
+ *
+ * emufs is free software; you can redistribute it and/or modify it under the
+ * terms of the GNU General Public License as published by the Free Software
+ * Foundation; either version 2 of the License, or (at your option) any later
+ * version.
+ *
+ * emufs is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with emufs; if not, write to the Free Software Foundation, Inc., 59 Temple
+ * Place, Suite 330, Boston, MA  02111-1307  USA
+ *----------------------------------------------------------------------------
+ * Creado:  mié mar 31 17:26:46 ART 2004
+ * Autores: Nicolás Dimov <sagardua@uolsinectis.com.ar>
+ *----------------------------------------------------------------------------
+ *
+ * $Id$
+ *
+ */
+
+/** \file
+ *
+ * Archivo con bloques y registros de longitud parametrizada.
+ * 
+ * Implementación del archivo con bloques y registros de longitud
+ * parametrizada.
+ *
+ */
+
+#ifndef _EMUFS_TIPO3_H_
+#define _EMUFS_TIPO3_H_
+

 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 #include <unistd.h>
 #include "emufs.h"
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 #include <unistd.h>
 #include "emufs.h"

+#include "did.h"
+#include "idx.h"
+#include "fsc.h"
+#include "indice_bplus.h"
+
+/** Devuelve un puntero con la memoria reservada que contiene al registro solicitado
+  * por el segundo parámetro \c ID, y almacena en \c reg_size el tamaño del
+  * registro leido, que en este caso no es necesario pues es constante y es conocicdo de antemano.
+  * Para realizar esta acción, busca en el archivo .idx el bloque al cual pertenece el registro.
+  * \param emu Esructura para manejar los archivos.
+  * \param ID Id del registro a leer.
+  * \param reg_size tamaño del registro.
+  * \param err Codigo de error devuelto en caso de falla.
+  */
+void* emufs_tipo3_leer_registro(EMUFS *emu, CLAVE clave, EMUFS_REG_SIZE* reg_size, int* err);

 
 

-typedef struct block_free_t{
-       int block;
-       int free_space;
-}BLOCK_FREE_T;
+/** Devuelve un puntero con la memoria reservada que contiene el bloque solicitado por
+  * el segundo parámetro \c num_bloque. Como la numeración de los bloques es virtual,
+  * el acceso al archivo para levantar un bloque es directo, es decir, se posiciona directamente
+  * en en número de bloque multiplicado por el tamaño del mismo, salteando antes el encabezado del archivo.
+  * \param emu Esructura para manejar los archivos.
+  * \param block_id Numero del bloque a leer.
+  * \param err Codigo de error devuelto en caso de falla.
+  */
+void* emufs_tipo3_leer_bloque(EMUFS *emu, EMUFS_BLOCK_ID block_id, int *err);

 
 

-typedef struct block_reg_t{
-       int block;
-       long int id_reg;
-}BLOCK_REG_T;
+/** Graba un registro en un bloque donde haya espacio suficiente, y si no 
+  * crea un nuevo bloque y lo agrega al final del archivo. 
+  * El registro a grabar es apuntado por el segundo parámetro \param ptr 
+  * y el tamaño viene indicado en \c tam.
+  * Luego de realizar la grabación, actualiza los archivos índice con los
+  * valores correspondientes.
+  * \param emu Esructura para manejar los archivos.
+  * \param ptr Cadena de datos que contiene el registro a grabar.
+  * \param err Codigo de error devuelto en caso de falla.
+  */
+EMUFS_REG_ID emufs_tipo3_grabar_registro(EMUFS *emu, void *ptr, EMUFS_REG_SIZE reg_size, int *err);

 
 

-int leer_registro(EMUFS *, int , void *, unsigned long);
+/** Graba el bloque apuntado por \c ptr en el archivo 
+  * \param emu Esructura para manejar los archivos.
+  * \param ptr Cadena de datos que contiene el bloque a grabar.
+  * \param block_id Numero del bloque a leer.
+  */
+int emufs_tipo3_grabar_bloque(EMUFS *emu, void *ptr, EMUFS_BLOCK_ID num_bloque);

 
 

-int leer_bloque(EMUFS *, int , void *);
+/** Borra el registro \c id_reg del archivo de datos, y actualiza los archivos
+  *    de índice para mantener la coherencia en las próximas modificaciones.
+  * \param emu Esructura para manejar los archivos.
+  * \param id_reg Id del registro a borrar.
+  */
+int emufs_tipo3_borrar_registro(EMUFS *emu, CLAVE k, INDICE_DATO dato);

 
 

-int grabar_registro(EMUFS *, void *, unsigned long );
+/** Método para modificar un registro
+  * \param emu Esructura para manejar los archivos.
+  * \param reg_id Id del registro que se quiere modificar.
+  * \param ptr Cadena de datos que contiene el nuevo registro.
+  * \param err Codigo de error devuelto en caso de falla.
+  */
+EMUFS_REG_ID emufs_tipo3_modificar_registro(EMUFS *emu, CLAVE k, void *ptr, EMUFS_REG_SIZE, int*err, INDICE_DATO);

 
 

-int existe_registro(EMUFS *, int);
+/** Completa una estructura del tipo EMUFS_Estadisticas con las estadísticas del
+  * archivo de datos, espacio libre total, cantidad de registros, cantidad de bloques,
+  * tamaño del archivo en bytes, relaciones entre tamaños y espacios libres, etc.
+  * \param emu Esructura para manejar los archivos.
+  */
+EMUFS_Estadisticas emufs_tipo3_leer_estadisticas(EMUFS *emu);

 
 

-int buscar_registro(EMUFS *, int);
+/** Lee un registro con su informacion de control 
+  * \param emu Esructura para manejar los archivos.
+  * \param ID Id del registro a leer.
+  * \param reg_size Tamaño del registro.
+  * \param err Codigo de error devuelto en caso de falla.
+  */
+void* emufs_tipo3_leer_registro_raw(EMUFS *emu, EMUFS_REG_ID reg_id, EMUFS_REG_SIZE *reg_size, int *err);

 
 

-int buscar_lugar(EMUFS *, unsigned long , int *);
+/** Elimina los espacios libres que hay en el archivo
+  * \param emu Esructura para manejar los archivos.
+  */
+void emufs_tipo3_compactar(EMUFS *emu);

 
 

-int get_id(EMUFS *);
+/** Lee un bloque, el anterior y el siguiente 
+  * \param emu Esructura para manejar los archivos.
+  * \param block_id Id del bloque a leer.
+  * \param actual Cadena de datos que almacena el bloque indicado por \c block_id.
+  * \param anterior Cadena de datos que almacena el bloque anterior al \c actual.
+  * \param siguiente Cadena de datos que almacena el bloque siguiente al \c actual.
+  * \param size1 Tamaño del bloque actual.
+  * \param size2 Tamaño del bloque anterior.
+  * \param size3 Tamaño del bloque siguiente.
+  */
+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);

 
 

-int grabar_bloque(EMUFS *, void *, int);
+/** Inserta un registro ordenado segun el Arbol B+ lo indique
+  * \param emu Esructura para manejar los archivos.
+  * \param ptr Cadena de datos contenedora del registro.
+  * \param err Codigo de error devuelto en caso de falla.
+  */
+int emufs_tipo3_insertar_ordenado(EMUFS *emu, void *ptr, EMUFS_REG_SIZE size, int *err);

 
 

-int borrar_registro(EMUFS*, int, int);
-#endif
+int emufs_tipo3_eliminar_ordenado(EMUFS *emu, CLAVE clave, int *err);
+#endif /* _EMUFS_TIPO3_H_ */