Compiling version para Nico aunque la anterior deberia haber estado functional

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

diff --git a/emufs/fsc.h b/emufs/fsc.h
index 408bcb55fb3b25bd05715d3c8f04c1df24310342..08cf1e6bc70ae1b112756ac4aae5174d37266a13 100644 (file)
--- a/emufs/fsc.h
+++ b/emufs/fsc.h
@@ -43,20 +43,69 @@
 #define EMUFS_FSC_EXT ".fsc"
 
 typedef struct emufs_fsc_t {
-       unsigned long int marker;
-       unsigned long int freespace;
+       EMUFS_BLOCK_ID marker;
+       EMUFS_FREE freespace;
 } EMUFS_FSC;
 
-int emufs_fsc_crear(EMUFS*);
-int emufs_fsc_agregar(EMUFS *, EMUFS_BLOCK_ID, EMUFS_FREE);
-int emufs_fsc_agregar_gap(EMUFS *, EMUFS_OFFSET, EMUFS_FREE);
-int emufs_fsc_remove_gap(EMUFS *emu, EMUFS_OFFSET);
-int emufs_fsc_actualizar_gap(EMUFS *, EMUFS_OFFSET, EMUFS_FREE);
-int emufs_fsc_actualizar(EMUFS *, EMUFS_BLOCK_ID, EMUFS_FREE);
-EMUFS_BLOCK_ID emufs_fsc_buscar_lugar(EMUFS *, EMUFS_FREE, EMUFS_FREE *);
-EMUFS_FREE emufs_fsc_get_fs(EMUFS *, EMUFS_BLOCK_ID);
-EMUFS_FREE emufs_fsc_get_total_fs(EMUFS *);
-EMUFS_FREE emufs_fsc_get_media_fs(EMUFS *);
-int emufs_fsc_get_max_min_fs(EMUFS *, EMUFS_FREE *, EMUFS_FREE *);
-int emufs_fsc_get_cant_bloques_vacios(EMUFS *emu);
+/** 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);
+
+/** Devuelve la cantidad de bloques vacios en el archivo*/
+EMUFS_BLOCK_ID emufs_fsc_get_cant_bloques_vacios(EMUFS*);
+
+/** Devuelve la cantidad de bloques (o gaps) que tiene un archivo. */
+EMUFS_BLOCK_ID emufs_fsc_get_num_blocks(EMUFS*);
+
+/** Obtiene el tamaño del archivo de espacios libres. */
+long emufs_fsc_get_file_size(EMUFS*, int*);
+
 #endif /* _EMUFS_FSC_H */