Subo cosas de external sort con las que estoy trabajando. Todavia no hay nada utiliza...

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

diff --git a/emufs/emufs.h b/emufs/emufs.h
index 81d62b311d5766d88af36dfdbbfce373fb5df85c..f9f7b85a9aa61351f6473114de8582423af3728a 100644 (file)
--- a/emufs/emufs.h
+++ b/emufs/emufs.h
@@ -1,15 +1,94 @@
+/* vim: set noexpandtab tabstop=4 shiftwidth=4 wrap:
+ *----------------------------------------------------------------------------
+ *                                  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>
+ *          Ricardo Markiewicz <rmarkie@fi.uba.ar>
+ *          Leandro Lucarella <llucare@fi.uba.ar>
+ *----------------------------------------------------------------------------
+ *
+ * $Id$
+ *
+ */
+
+/** \file
+ *
+ * Estructura general de un archivo <em>abstracto</em> de emufs.
+ * 
+ * Interfaz de la estructura abstracta que representa cualquiera de los tipos
+ * de archivo implementados.
+ *
+ */
+

 #ifndef _EMUFS_H_
 #define _EMUFS_H_
 
 #include <stdlib.h>
 #include <stdio.h>
 #ifndef _EMUFS_H_
 #define _EMUFS_H_
 
 #include <stdlib.h>
 #include <stdio.h>

+#include <limits.h>
+
+#include "indices.h"

 
 /** Tipo de archivo. */
 typedef enum {
        T1, /**< Archivo de bloque parametrizado y registro variable. */
        T2, /**< Archivo sin bloques y registros variables. */
        T3  /**< Archivo de bloque parametrizado y registro fijo. */
 
 /** Tipo de archivo. */
 typedef enum {
        T1, /**< Archivo de bloque parametrizado y registro variable. */
        T2, /**< Archivo sin bloques y registros variables. */
        T3  /**< Archivo de bloque parametrizado y registro fijo. */

-} EMUFS_TYPE;
+} EMUFS_Tipo;
+
+/** Tipo de identificador de registro. */
+typedef unsigned long EMUFS_REG_ID;
+
+/** Tipo de tamaño de registro. */
+typedef unsigned long EMUFS_REG_SIZE;
+
+/** Tipo de identificador de bloque. */
+typedef unsigned long EMUFS_BLOCK_ID;
+
+/** Tipo de tamaño de bloque. */
+typedef unsigned long EMUFS_BLOCK_SIZE;
+
+/** Tipo de espacio libre. */
+typedef unsigned long EMUFS_FREE;
+
+/** Tipo de offset. */
+typedef unsigned long EMUFS_OFFSET;
+
+/** Constante para indicar el valor especial de un ID inválido.
+ *
+ *  El uso típico es para indicar que no se encontró el ID en una búsqueda.
+ */
+#define EMUFS_NOT_FOUND -1ul
+
+/** Estadisticas de archivo. */
+typedef struct _emufs_est_t {
+       unsigned long tam_archivo;/**< Tamaño en bytes del archivo .dat */
+       unsigned long tam_archivos_aux;/**< Tamaño en bytes de los archivos auxiliares sumados */
+       unsigned long tam_info_control_dat;/**< Cantidad de bytes en info de control del .dat */
+       unsigned long media_fs;/**< Media del espacio libre en el archivo de datos */
+       unsigned long total_fs;/**< Cantidad total de espacio libre en el archivo de datos */
+       unsigned long max_fs;/**< Cantidad de maxima libre (gap o fs en bloque) en el archivo de datos */
+       unsigned long min_fs;/**< Cantidad de minima libre (gap o fs en bloque) en el archivo de datos */
+       unsigned long cant_bloques; /**< Cantidad de bloques en el archivo de datos */
+       unsigned long cant_registros; /**< Cantidad de Registros en el archivo */
+} EMUFS_Estadisticas;

 
 /** Tipo Abstracto para menajo de archivos.
  *
 
 /** Tipo Abstracto para menajo de archivos.
  *


@@ -29,39 +108,53 @@ typedef enum {
  *  la necesidad de que el usuario tenga que hacer una selección previa del tipo
  *  para llamar al método correspondiente a cada tipo de archivo.
  */
  *  la necesidad de que el usuario tenga que hacer una selección previa del tipo
  *  para llamar al método correspondiente a cada tipo de archivo.
  */

-typedef struct _emu_fs_t {
-       EMUFS_TYPE tipo;
-       unsigned long tam_bloque; /**< Tamaño de bloque. 0 Si no tiene bloques */
-       int (*leer_bloque)(struct _emu_fs_t *, int, void *); /**< Método para leer un bloque */
-       int (*leer_registro)(struct _emu_fs_t *, int, void *, unsigned long); /**< Método para leer un registro */
-       int (*grabar_registro)(struct _emu_fs_t *, void *, unsigned long ); /**< Método para grabar un registro */
-       int (*borrar_registro)(struct _emu_fs_t *, int, int); /**< Método para borrar un registro */
+struct _emu_fs_t {
+       EMUFS_Tipo tipo;
+       EMUFS_BLOCK_SIZE tam_bloque; /**< Tamaño de bloque. 0 Si no tiene bloques */
+       EMUFS_REG_SIZE tam_reg; /**< Tamaño de registro. 0 Si son registros variables */        
+       void* (*leer_bloque)(struct _emu_fs_t*, EMUFS_BLOCK_ID, int*); /**< Método para leer un bloque */
+       void (*leer_bloque_raw)(struct _emu_fs_t*, EMUFS_BLOCK_ID, char **, char **, char **, EMUFS_BLOCK_SIZE *, EMUFS_BLOCK_SIZE *, EMUFS_BLOCK_SIZE *); /**< Método para leer un bloque, el anterior y el siguiente */
+       void* (*leer_registro)(struct _emu_fs_t*, CLAVE, EMUFS_REG_SIZE*, int*); /**< Método para leer un registro */
+       void* (*leer_registro_raw)(struct _emu_fs_t*, EMUFS_REG_ID, EMUFS_REG_SIZE*, int *); /**< Método para leer un registro con todo su bloque asociado */
+       EMUFS_REG_ID (*grabar_registro)(struct _emu_fs_t*, void*, EMUFS_REG_SIZE, int*); /**< Método para grabar un registro */
+       EMUFS_REG_ID (*modificar_registro)(struct _emu_fs_t*, CLAVE k, void*, EMUFS_REG_SIZE, int*, INDICE_DATO); /**< Método para modificar un registro */
+       int (*borrar_registro)(struct _emu_fs_t*, CLAVE, INDICE_DATO); /**< Método para borrar un registro */
+       EMUFS_Estadisticas (*leer_estadisticas)(struct _emu_fs_t *); /**< Método para obtener estádisticas sobre el archivo */
+       void (*compactar)(struct _emu_fs_t *); /**< Método para compactar el archivo reorganizándolo físicamente */

        char *nombre; /**< Nombre del archivo */
        char *nombre; /**< Nombre del archivo */

-} EMUFS;
+
+       INDICE *indices;
+};
+
+/** Crea un archivo auxiliar. */
+int emufs_crear_archivo_auxiliar(const char*, const char*);

 
 /** Crea un nuevo archivo EMUFS.
  *
 
 /** Crea un nuevo archivo EMUFS.
  *

- *  Un archivo EMUFS está compuesto por 4 archivos a nivel del sistema operativo.
- *  Un archivo principal con extensión .dat y 3 archivos auxiliares para manejo interno.
+ *  Un archivo EMUFS está compuesto por 4 archivos a nivel del SO.
+ *  Un archivo principal con extensión .dat y 3 archivos auxiliares para
+ *  manejo interno.

  *
  *

- *  El parámetro filename que recive esta función en el nombre virtual que se utilizará, ya
- *  que las extensiones serán puestas automáticamente for EMUFS.
+ *  El parámetro filename que recive esta función en el nombre virtual que se
+ *  utilizará, ya que las extensiones serán puestas automáticamente for EMUFS.

  *
  *  Un ejemplo:
  *  \code
  *  EMUFS *fp  emufs_crear("archivo", T3, 100, 100);
  *  \endcode
  *
  *
  *  Un ejemplo:
  *  \code
  *  EMUFS *fp  emufs_crear("archivo", T3, 100, 100);
  *  \endcode
  *

- *  En el ejemplo anterior se tiene que nuestro filesystem virtual se llamará archivo.
+ *  En el ejemplo anterior se tiene que nuestro filesystem virtual se llamará
+ *  archivo.

  *
  *

- *  Los últimos 2 parámetros serán ignorados si el tipo de archivo no utiliza dicho parámetro.
+ *  Los últimos 2 parámetros serán ignorados si el tipo de archivo no utiliza
+ *  dicho parámetro.

  *
  *  \param filename Nombre del archivo virtual.
  *  \param tipo Tipo de archivo.
  *  \param tam_bloque Tamaño del bloque.
  *  \param tam_reg Tamaño del registro.
  */
  *
  *  \param filename Nombre del archivo virtual.
  *  \param tipo Tipo de archivo.
  *  \param tam_bloque Tamaño del bloque.
  *  \param tam_reg Tamaño del registro.
  */

-EMUFS *emufs_crear(const char *filename, char tipo, unsigned int tam_bloque, unsigned int tam_reg);
+EMUFS *emufs_crear(const char *filename, EMUFS_Tipo tipo,EMUFS_BLOCK_SIZE tam_bloque, EMUFS_REG_SIZE tam_reg);

 
 /** Abre un archivo EMUFS.
  *
 
 /** Abre un archivo EMUFS.
  *


@@ -74,6 +167,19 @@ EMUFS *emufs_abrir(const char *filename);
 /** Libera un archivo virtual */
 int emufs_destruir(EMUFS *e);
 
 /** Libera un archivo virtual */
 int emufs_destruir(EMUFS *e);
 

+/** mustra archivos auxiliares, para debug. */

 int ver_archivo_FS(EMUFS *emu);
 
 int ver_archivo_FS(EMUFS *emu);
 

-#endif
+/** muestra estadisticas, para debug. */
+int debug_ver_estadisticas(EMUFS *emu);
+
+int emufs_agregar_indice(EMUFS *emu, char *nombre, INDICE_FUNCION funcion, INDICE_TIPO tipo, INDICE_TIPO_DATO tipo_dato,  unsigned int offset, unsigned int tam_bloque); 
+
+INDICE_DATO *emufs_buscar_registros(EMUFS *emu, char *indice, char *data, int *cant);
+
+INDICE *emufs_buscar_indice_por_nombre(EMUFS *emu, const char *nombre);
+
+EMUFS_BLOCK_ID emufs_create_new_block(EMUFS *emu);
+
+EMUFS_BLOCK_ID emufs_get_new_block_number(EMUFS *emu);
+#endif /* _EMUFS_H_ */