]> git.llucax.com Git - z.facultad/75.06/emufs.git/blob - emufs/fsc.h
More renames..
[z.facultad/75.06/emufs.git] / emufs / fsc.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:  vie abr  9 16:17:50 ART 2004
22  * Autores: Nicolás Dimov <sagardua@uolsinectis.com.ar>
23  *          Leandro Lucarella <llucare@fi.uba.ar>
24  *----------------------------------------------------------------------------
25  *
26  * $Id$
27  *
28  */
29
30 /** \file
31  *
32  * Archivo para administrar el espacio libre disponible.
33  * 
34  * Interfaz del archivo para administrar el espacio libre disponible.
35  *
36  */
37
38 #ifndef _EMUFS_FSC_H
39 #define _EMUFS_FSC_H
40
41 #include "emufs.h"
42
43 #define EMUFS_FSC_EXT ".fsc"
44
45 typedef struct emufs_fsc_t {
46         EMUFS_BLOCK_ID marker;
47         EMUFS_FREE freespace;
48 } EMUFS_FSC;
49
50 /** Crea un archivo de Gaps o Espacio Libre en Bloque */
51 int emufs_fsc_crear(EMUFS *emu);
52
53 /** Agrega un registro al archivo de espacio libre en bloque. */
54 int emufs_fsc_agregar(EMUFS *emu, EMUFS_BLOCK_ID block, EMUFS_FREE fs);
55
56 /** Agrega un GAP en el archivo de Gaps para Filetype 2 */
57 int emufs_fsc_agregar_gap(EMUFS *emu, EMUFS_OFFSET off, EMUFS_FREE fs);
58
59 /** Elimina un registro GAP del archivo de espacios libres (gaps) */
60 int emufs_fsc_remove_gap(EMUFS *emu, EMUFS_OFFSET off);
61
62 /** Actualiza un registro de gap, en el archivo de Gaps en Disco */
63 int emufs_fsc_actualizar_gap(EMUFS *emu, EMUFS_OFFSET off, EMUFS_FREE fs);
64
65 /** Actualiza un registro de espacio libre de acorde al FType */
66 int emufs_fsc_actualizar(EMUFS *emu, EMUFS_BLOCK_ID block, EMUFS_FREE fs);
67
68 /** Busca un bloque o gap en donde quepa un registro.
69  *
70  * Si encuentra el lugar buscado, devuelve en \c freespace el espacio libre en
71  * ese bloque o gap.
72  */
73 EMUFS_BLOCK_ID emufs_fsc_buscar_lugar(EMUFS *emu, EMUFS_FREE reg_size, EMUFS_FREE *n_freespace);
74
75 /** Busca una una serie de bloques consecutivos con espacio libre.
76  *
77  * De encontrarlo devuelve el identificador del primer bloque de la serie y el
78  * espacio libre en él.
79  *
80  * \note Considera el fin de archivo como espacio libre. Es decir, si buscamos 3
81  *       bloques libres y encuentra uno al final del archivo, lo devuelve porque
82  *       asume que podemos seguir agregando bloques al final.
83  */
84 EMUFS_BLOCK_ID emufs_fsc_buscar_n_lugares(EMUFS*, size_t, EMUFS_FREE,
85                 EMUFS_FREE*, int*);
86
87 /** Devuelve el espacio libre de un Bloque o Gap dado */
88 EMUFS_FREE emufs_fsc_get_fs(EMUFS *emu, EMUFS_BLOCK_ID block);
89
90 /** Devuelve el espacio libre total en el archivo*/
91 EMUFS_FREE emufs_fsc_get_total_fs(EMUFS *emu);
92
93 /** Devuelve el promedio del espacio libre en el archivo */
94 EMUFS_FREE emufs_fsc_get_media_fs(EMUFS *emu);
95
96 /** Almacena en \param min el minimo espacio libre y en \param max el maximo espacio libre */
97 int emufs_fsc_get_max_min_fs(EMUFS *emu, EMUFS_FREE *min, EMUFS_FREE *max);
98
99 /** Trunca el archivo hasta el bloque \param block*/
100 int emufs_fsc_truncate(EMUFS*, EMUFS_BLOCK_ID);
101
102 /** Devuelve la cantidad de bloques vacios en el archivo*/
103 EMUFS_BLOCK_ID emufs_fsc_get_cant_bloques_vacios(EMUFS*);
104
105 /** Devuelve la cantidad de bloques (o gaps) que tiene un archivo. */
106 EMUFS_BLOCK_ID emufs_fsc_get_num_blocks(EMUFS*);
107
108 /** Obtiene el tamaño del archivo de espacios libres. */
109 long emufs_fsc_get_file_size(EMUFS*, int*);
110
111 #endif /* _EMUFS_FSC_H */