tree view

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

diff --git a/emufs/fsc.h b/emufs/fsc.h
index 354273a69fd32bf4a0bee85672bee83f808973f6..08cf1e6bc70ae1b112756ac4aae5174d37266a13 100644 (file)
--- a/emufs/fsc.h
+++ b/emufs/fsc.h
@@ -1,15 +1,111 @@
-#ifndef _FSC_H
-#define _FSC_H
-#include <string.h>
-#include <unistd.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:  vie abr  9 16:17:50 ART 2004
+ * Autores: Nicolás Dimov <sagardua@uolsinectis.com.ar>
+ *          Leandro Lucarella <llucare@fi.uba.ar>
+ *----------------------------------------------------------------------------
+ *
+ * $Id$
+ *
+ */
+
+/** \file
+ *
+ * Archivo para administrar el espacio libre disponible.
+ * 
+ * Interfaz del archivo para administrar el espacio libre disponible.
+ *
+ */
+
+#ifndef _EMUFS_FSC_H
+#define _EMUFS_FSC_H
+

 #include "emufs.h"
 
 #include "emufs.h"
 

-int emufs_fsc_agregar(EMUFS *, int, int);
+#define EMUFS_FSC_EXT ".fsc"
+
+typedef struct emufs_fsc_t {
+       EMUFS_BLOCK_ID marker;
+       EMUFS_FREE freespace;
+} EMUFS_FSC;
+
+/** Crea un archivo de Gaps o Espacio Libre en Bloque */
+int emufs_fsc_crear(EMUFS *emu);
+
+/** Agrega un registro al archivo de espacio libre en bloque. */
+int emufs_fsc_agregar(EMUFS *emu, EMUFS_BLOCK_ID block, EMUFS_FREE fs);
+
+/** Agrega un GAP en el archivo de Gaps para Filetype 2 */
+int emufs_fsc_agregar_gap(EMUFS *emu, EMUFS_OFFSET off, EMUFS_FREE fs);
+
+/** Elimina un registro GAP del archivo de espacios libres (gaps) */
+int emufs_fsc_remove_gap(EMUFS *emu, EMUFS_OFFSET off);
+
+/** Actualiza un registro de gap, en el archivo de Gaps en Disco */
+int emufs_fsc_actualizar_gap(EMUFS *emu, EMUFS_OFFSET off, EMUFS_FREE fs);
+
+/** Actualiza un registro de espacio libre de acorde al FType */
+int emufs_fsc_actualizar(EMUFS *emu, EMUFS_BLOCK_ID block, EMUFS_FREE fs);
+
+/** Busca un bloque o gap en donde quepa un registro.
+ *
+ * Si encuentra el lugar buscado, devuelve en \c freespace el espacio libre en
+ * ese bloque o gap.
+ */
+EMUFS_BLOCK_ID emufs_fsc_buscar_lugar(EMUFS *emu, EMUFS_FREE reg_size, EMUFS_FREE *n_freespace);
+
+/** Busca una una serie de bloques consecutivos con espacio libre.
+ *
+ * De encontrarlo devuelve el identificador del primer bloque de la serie y el
+ * espacio libre en él.
+ *
+ * \note Considera el fin de archivo como espacio libre. Es decir, si buscamos 3
+ *       bloques libres y encuentra uno al final del archivo, lo devuelve porque
+ *       asume que podemos seguir agregando bloques al final.
+ */
+EMUFS_BLOCK_ID emufs_fsc_buscar_n_lugares(EMUFS*, size_t, EMUFS_FREE,
+               EMUFS_FREE*, int*);
+
+/** Devuelve el espacio libre de un Bloque o Gap dado */
+EMUFS_FREE emufs_fsc_get_fs(EMUFS *emu, EMUFS_BLOCK_ID block);
+
+/** Devuelve el espacio libre total en el archivo*/
+EMUFS_FREE emufs_fsc_get_total_fs(EMUFS *emu);
+
+/** Devuelve el promedio del espacio libre en el archivo */
+EMUFS_FREE emufs_fsc_get_media_fs(EMUFS *emu);
+
+/** Almacena en \param min el minimo espacio libre y en \param max el maximo espacio libre */
+int emufs_fsc_get_max_min_fs(EMUFS *emu, EMUFS_FREE *min, EMUFS_FREE *max);
+
+/** Trunca el archivo hasta el bloque \param block*/
+int emufs_fsc_truncate(EMUFS*, EMUFS_BLOCK_ID);

 
 

-int emufs_fsc_actualizar(EMUFS *, int, int);
+/** Devuelve la cantidad de bloques vacios en el archivo*/
+EMUFS_BLOCK_ID emufs_fsc_get_cant_bloques_vacios(EMUFS*);

 
 

-int emufs_fsc_buscar_lugar(EMUFS *, unsigned long, int *);
+/** Devuelve la cantidad de bloques (o gaps) que tiene un archivo. */
+EMUFS_BLOCK_ID emufs_fsc_get_num_blocks(EMUFS*);

 
 

-int emufs_fsc_get_fs(EMUFS *, int);
+/** Obtiene el tamaño del archivo de espacios libres. */
+long emufs_fsc_get_file_size(EMUFS*, int*);

 
 

-#endif /* _FSC_H */
+#endif /* _EMUFS_FSC_H */