emufs/emufs.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  *          Ricardo Markiewicz <rmarkie@fi.uba.ar>
  24  *          Leandro Lucarella <llucare@fi.uba.ar>
  25  *----------------------------------------------------------------------------
  26  *
  27  * $Id$
  28  *
  29  */
  30
  31 /** \file
  32  *
  33  * Estructura general de un archivo <em>abstracto</em> de emufs.
  34  *
  35  * Interfaz de la estructura abstracta que representa cualquiera de los tipos
  36  * de archivo implementados.
  37  *
  38  */
  39
  40 #ifndef _EMUFS_H_
  41 #define _EMUFS_H_
  42
  43 #include <stdlib.h>
  44 #include <stdio.h>
  45
  46 /** Tipo de archivo. */
  47 typedef enum {
  48         T1, /**< Archivo de bloque parametrizado y registro variable. */
  49         T2, /**< Archivo sin bloques y registros variables. */
  50         T3  /**< Archivo de bloque parametrizado y registro fijo. */
  51 } EMUFS_TYPE;
  52
  53 /** Tipo de identificador de registro. */
  54 typedef unsigned long EMUFS_REG_ID;
  55
  56 /** Tipo de tamaño de registro. */
  57 typedef unsigned long EMUFS_REG_SIZE;
  58
  59 /** Tipo de identificador de bloque. */
  60 typedef unsigned long EMUFS_BLOCK_ID;
  61
  62 /** Tipo de tamaño de bloque. */
  63 typedef unsigned long EMUFS_BLOCK_SIZE;
  64
  65 /** Tipo de espacio libre. */
  66 typedef unsigned long EMUFS_FREE;
  67
  68 /** Tipo de offset. */
  69 typedef unsigned long EMUFS_OFFSET;
  70
  71 /** Constante para indicar el valor especial de un ID inválido.
  72  *
  73  *  El uso típico es para indicar que no se encontró el ID en una búsqueda.
  74  */
  75 #define EMUFS_NOT_FOUND -1ul
  76
  77 /** Tipo Abstracto para menajo de archivos.
  78  *
  79  *  Esta estructura es utilizada para acceder a cualquier tipo de archivo.
  80  *
  81  *  Cuando se requiere abrir o crear un nuevo archivo, esta estrucura contendrá los
  82  *  punteros a los métodos de dicho archivo, por lo que desde el código que utilice
  83  *  esta estructura no deberá ser modificado por cada tipo de archivo.
  84  *
  85  *  Por ejemplo:
  86  *  \code
  87  *    EMUFS *fs = emufs_abrir("archivo");
  88  *    fs->leer_registro(id, ptr, size);
  89  *  \endcode
  90  *
  91  *  Este ejemplo funcionará sin importar de que tipo de archivo se trate, sin
  92  *  la necesidad de que el usuario tenga que hacer una selección previa del tipo
  93  *  para llamar al método correspondiente a cada tipo de archivo.
  94  */
  95 typedef struct _emu_fs_t {
  96         EMUFS_TYPE tipo;
  97         EMUFS_BLOCK_SIZE tam_bloque; /**< Tamaño de bloque. 0 Si no tiene bloques */
  98         EMUFS_REG_SIZE tam_reg; /**< Tamaño de registro. 0 Si son registros variables */
  99         void* (*leer_bloque)(struct _emu_fs_t*, EMUFS_BLOCK_ID, int*); /**< Método para leer un bloque */
 100         void* (*leer_registro)(struct _emu_fs_t*, EMUFS_REG_ID, EMUFS_REG_SIZE*, int*); /**< Método para leer un registro */
 101         EMUFS_REG_ID (*grabar_registro)(struct _emu_fs_t*, void*, EMUFS_REG_SIZE, int*); /**< Método para grabar un registro */
 102         int (*borrar_registro)(struct _emu_fs_t*, EMUFS_REG_ID); /**< Método para borrar un registro */
 103         char *nombre; /**< Nombre del archivo */
 104 } EMUFS;
 105
 106 /** Crea un archivo auxiliar. */
 107 int emufs_crear_archivo_auxiliar(const char*, const char*);
 108
 109 /** Crea un nuevo archivo EMUFS.
 110  *
 111  *  Un archivo EMUFS está compuesto por 4 archivos a nivel del SO.
 112  *  Un archivo principal con extensión .dat y 3 archivos auxiliares para
 113  *  manejo interno.
 114  *
 115  *  El parámetro filename que recive esta función en el nombre virtual que se
 116  *  utilizará, ya que las extensiones serán puestas automáticamente for EMUFS.
 117  *
 118  *  Un ejemplo:
 119  *  \code
 120  *  EMUFS *fp  emufs_crear("archivo", T3, 100, 100);
 121  *  \endcode
 122  *
 123  *  En el ejemplo anterior se tiene que nuestro filesystem virtual se llamará
 124  *  archivo.
 125  *
 126  *  Los últimos 2 parámetros serán ignorados si el tipo de archivo no utiliza
 127  *  dicho parámetro.
 128  *
 129  *  \param filename Nombre del archivo virtual.
 130  *  \param tipo Tipo de archivo.
 131  *  \param tam_bloque Tamaño del bloque.
 132  *  \param tam_reg Tamaño del registro.
 133  */
 134 EMUFS *emufs_crear(const char *filename, EMUFS_TYPE tipo,
 135                 EMUFS_BLOCK_SIZE tam_bloque, EMUFS_REG_SIZE tam_reg);
 136
 137 /** Abre un archivo EMUFS.
 138  *
 139  *  Abre un archivo, determinando de que tipo se trata.
 140  *
 141  *  \param filename Nombre del archivo virtual.
 142  */
 143 EMUFS *emufs_abrir(const char *filename);
 144
 145 /** Libera un archivo virtual */
 146 int emufs_destruir(EMUFS *e);
 147
 148 int ver_archivo_FS(EMUFS *emu);
 149
 150 #endif /* _EMUFS_H_ */