emufs/tipo2.c

   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:  Fri Apr 10 17:10:00 ART 2004
  22  * Autores: Alan Kennedy <kennedya@3dgames.com.ar>
  23  *----------------------------------------------------------------------------
  24  *
  25  * $Id: tipo3.c 85 2004-04-08 23:39:28Z sagar $
  26  *
  27  */
  28
  29 /** \file
  30  * Archivo con registros de longitud variable, sin bloques.
  31  *
  32  * <b>Implementacion del Archivo Tipo 2</b>
  33  *
  34  * La organizacion interna de un archivo de tipo 2, presenta registros de longitud variable,
  35  * los cuales son grabados secuencialmente, o bien en gaps (espacios libres) que se presenten en
  36  * el archivo de datos, pero no se encuentran contenidos por bloques.
  37  *
  38  */
  39
  40 #include "tipo2.h"
  41 #include "idx.h"
  42 #include "fsc.h"
  43 #include "did.h"
  44 #include "error.h"
  45 #include <unistd.h>
  46 #include <sys/types.h>
  47 #include <stdio.h>
  48 #include <string.h>
  49
  50 /* Asigna los punteros a las funciones apropiadas para el Tipo2 */
  51 int emufs_tipo2_inicializar(EMUFS* efs)
  52 {
  53         efs->grabar_registro = emufs_tipo2_grabar_registro;
  54     efs->borrar_registro = emufs_tipo2_borrar_registro;
  55         efs->leer_registro = emufs_tipo2_leer_registro;
  56         efs->modificar_registro = emufs_tipo2_modificar_registro;
  57         efs->leer_estadisticas = emufs_tipo2_leer_estadisticas;
  58         efs->compactar = emufs_tipo2_compactar;
  59
  60         return 0;
  61 }
  62
  63 /* Lee y devuelve un registro de un archivo del Tipo 2. */
  64 void *emufs_tipo2_leer_registro(EMUFS* efs, EMUFS_REG_ID id_reg, EMUFS_REG_SIZE* reg_size, int *err)
  65 {
  66         FILE* f_data;
  67         char *registro; /* registro a leer */
  68         char  name_f[255];
  69         EMUFS_OFFSET reg_offset; /* offset donde se encuentra el registro */
  70
  71         strcpy(name_f,efs->nombre);
  72         strcat(name_f,".dat");
  73
  74         /* Obtenemos la posicion del registro en el .dat */
  75         reg_offset = emufs_idx_buscar_registro(efs, id_reg);
  76         if (reg_offset == EMUFS_NOT_FOUND) {
  77                 PERR("Registro no encontrado");
  78                 *err = EMUFS_NOT_FOUND;
  79                 return NULL;
  80         }
  81
  82         /* Levantamos el registro */
  83         if ((f_data = fopen(name_f, "rb")) == NULL) {
  84                 PERR("No se puede abrir archivo");
  85                 *err = EMUFS_ERROR_CANT_OPEN_FILE;
  86                 return NULL;
  87         }
  88         fseek(f_data,reg_offset+sizeof(EMUFS_REG_ID),0);
  89         fread(reg_size,sizeof(EMUFS_REG_SIZE),1,f_data);
  90         registro = (char*)malloc(*reg_size);
  91         fread(registro,*reg_size,1,f_data);
  92         fclose(f_data);
  93
  94         return registro;
  95 }
  96
  97 /* Grabar un registro en un archivo del Tipo 2. */
  98 EMUFS_REG_ID emufs_tipo2_grabar_registro(EMUFS *efs, void *ptr, EMUFS_REG_SIZE reg_size, int* err)
  99 {
 100         EMUFS_REG_ID id_reg;
 101         EMUFS_FREE freespace;
 102         EMUFS_OFFSET wrt_offset,reg_offset;
 103         unsigned long int fisic_size;
 104         FILE *f_data;
 105         char name_f[255];
 106
 107         /* Armamos el filename del archivo de datos */
 108         strcpy(name_f,efs->nombre);
 109         strcat(name_f,".dat");
 110
 111         if ( (f_data = fopen(name_f,"r+"))==NULL ) return -1; /*ERROR*/
 112
 113         /* Obtengo un offset en donde iniciar la escritura de mi registro */
 114         /* de manera segura (habra espacio suficiente) */
 115         fisic_size = sizeof(EMUFS_REG_ID)+sizeof(EMUFS_REG_SIZE)+reg_size;
 116         wrt_offset = emufs_fsc_buscar_lugar(efs,fisic_size,&freespace);
 117         /*printf("tipo2.c >> Recording Reg > Searching FSC: Offset = %lu FSpace: %lu\n", n_WrtOffset, n_FreeSpace);*/
 118
 119         /* Si no encontre un gap, entonces escribo el registro al final */
 120         if (wrt_offset == -1) {
 121
 122                 /* Obtengo un ID libre para el registro y luego grabo a disco */
 123                 id_reg = emufs_idx_get_new_id(efs, err);
 124                 fseek(f_data, 0, SEEK_END);
 125                 reg_offset = ftell(f_data);
 126
 127                 /* Escribo [RegId]|[RegSize]|[RegData] */
 128                 fwrite(&id_reg,sizeof(EMUFS_REG_ID),1,f_data);
 129                 fwrite(&reg_size,sizeof(EMUFS_REG_SIZE),1,f_data);
 130                 fwrite(ptr,reg_size,1,f_data);
 131
 132                 /* Bye */
 133                 /*printf("Tipo2.c >> RegNr: %lu with FisicSize: %lu inserted at Offset: %lu\n",n_IdReg,n_FisicSize,n_RegOffset);*/
 134                 fclose(f_data);
 135
 136         } else {
 137
 138                 /* Obtengo un ID libre para el registro y luego grabo en disco */
 139                 id_reg = emufs_idx_get_new_id(efs, err);
 140                 reg_offset = wrt_offset;
 141                 fseek(f_data,reg_offset,0);
 142
 143     /* Escribo [RegId]|[RegSize]|[RegData] */
 144                 fwrite(&id_reg,sizeof(EMUFS_REG_ID),1,f_data);
 145                 fwrite(&reg_size,sizeof(EMUFS_REG_SIZE),1,f_data);
 146                 fwrite(ptr,reg_size,1,f_data);
 147
 148                 /* Bye */
 149                 /*printf("Tipo2.c >> RegNr: %lu with FisicSize: %lu inserted at Offset: %lu\n",n_IdReg,n_FisicSize,n_RegOffset);*/
 150                 fclose(f_data);
 151
 152                 /* Actualizo el espacio libre en el GAP donde puse el registro */
 153                 if ((freespace-fisic_size) == 0) emufs_fsc_remove_gap(efs,reg_offset);
 154                 else emufs_fsc_actualizar_gap(efs,reg_offset,freespace-fisic_size);
 155         }
 156
 157         /* Finalmente, actualizamos el indice de registros (offsets) */
 158         emufs_idx_agregar(efs,id_reg,reg_offset);
 159
 160         return id_reg;
 161 }
 162
 163 /* Borra un registro determinado y actualiza los archivos de Posicion Relativa (Indice-Offset) y el de Gaps */
 164 int emufs_tipo2_borrar_registro(EMUFS *efs, EMUFS_REG_ID id_reg)
 165 {
 166         EMUFS_OFFSET reg_offset,reg_size;
 167
 168         /* Obtenemos el offset donde arranca el registro */
 169         if ((reg_offset = emufs_idx_buscar_registro(efs,id_reg)) == EMUFS_NOT_FOUND) {
 170                 /* TODO Manejo de errores */
 171                 PERR("Registro no encontrado");
 172                 return EMUFS_NOT_FOUND;
 173         }
 174
 175         /* Obtenemos el Size del Registro en cuestion y hacemos un dummyfill*/
 176         emufs_tipo2_get_regsize(efs,reg_offset,&reg_size);
 177         emufs_tipo2_dummyfill(efs,reg_offset,reg_size);
 178
 179         /* Agregamos el GAP en el archivo de FSC, el cual hara un merge con */
 180         /* otro GAP por delante y/o por detras en caso de hallarlo. */
 181         emufs_fsc_agregar_gap(efs,reg_offset,reg_size+sizeof(EMUFS_REG_ID)+sizeof(EMUFS_REG_SIZE));
 182
 183         /* Agrego el ID que se ha liberado al archivo de ID's Libres */
 184         emufs_did_agregar(efs,id_reg);
 185
 186         /* Borramos el registro del indice de posiciones relativas */
 187         emufs_idx_borrar(efs,id_reg);
 188
 189         return(0);
 190 }
 191
 192 /* Devuelve el tamanio de un registro, dado su init offset */
 193 int emufs_tipo2_get_regsize(EMUFS *efs, EMUFS_OFFSET reg_pos, EMUFS_REG_SIZE *reg_size)
 194 {
 195     FILE *f_data;
 196         char name_f[255];
 197
 198     /* Armamos el filename del archivo de datos */
 199         strcpy(name_f,efs->nombre);
 200         strcat(name_f,".dat");
 201
 202     if ((f_data = fopen(name_f,"r+")) == NULL) return -1; /* ERROR */
 203         fseek(f_data,reg_pos+sizeof(EMUFS_REG_ID),SEEK_SET);
 204         fread(reg_size,sizeof(EMUFS_REG_SIZE),1,f_data);
 205         fclose(f_data);
 206
 207         return (0);
 208 }
 209
 210
 211 /* Pisa con basura lo que es hasta el momento un reg en el disco para indicar su borrado (Debug Purposes Only) */
 212 int emufs_tipo2_dummyfill(EMUFS *efs, EMUFS_OFFSET reg_pos, EMUFS_REG_SIZE amount)
 213 {
 214         FILE *f_data;
 215         char name_f[255];
 216         char *dummyfill;
 217         unsigned long fill_size;
 218
 219         /* Armamos el filename del archivo de datos */
 220         strcpy(name_f,efs->nombre);
 221         strcat(name_f,".dat");
 222
 223         if ((f_data = fopen(name_f,"rb+")) == NULL) return -1; /* ERROR */
 224
 225         /* Preparo el garbage y se lo tiro encima */
 226         fill_size = amount+sizeof(EMUFS_REG_ID)+sizeof(EMUFS_REG_SIZE);
 227         dummyfill = (char*)malloc(fill_size);
 228         memset(dummyfill, 0, fill_size);
 229         fseek(f_data,reg_pos,SEEK_SET);
 230         fwrite(dummyfill,fill_size,1,f_data);
 231         fclose(f_data);
 232
 233         free(dummyfill);
 234         return (0);
 235 }
 236
 237 /* Realiza la actualizacin de un registro ya existente */
 238 EMUFS_REG_ID emufs_tipo2_modificar_registro(EMUFS *efs, EMUFS_REG_ID id, void *data, EMUFS_REG_SIZE size, int *error)
 239 {
 240         emufs_tipo2_borrar_registro(efs, id);
 241         return emufs_tipo2_grabar_registro(efs, data, size, error);
 242 }
 243
 244 /* Recompila y devuelve ciertas estadisticas del archivo indicado */
 245 EMUFS_Estadisticas emufs_tipo2_leer_estadisticas(EMUFS *efs)
 246 {
 247     EMUFS_Estadisticas stats;
 248         EMUFS_REG_ID *tmp;
 249         unsigned long fsc_size = 0,idx_size = 0;
 250         char name_f[255];
 251         FILE *file;
 252
 253         strcpy(name_f,efs->nombre);
 254         strcat(name_f,".dat");
 255
 256         /* Inicializo las stats por si hay error somewhere */
 257         stats.tam_archivo = 0;
 258         stats.tam_archivo_bytes = 0;
 259         stats.info_control = 0;
 260         stats.media_fs = 0;
 261         stats.total_fs = 0;
 262         stats.max_fs = 0;
 263         stats.min_fs = 0;
 264         stats.cant_bloques = 0;
 265
 266         /* Obtengo las stats de FSC */
 267         stats.total_fs = emufs_fsc_get_total_fs(efs);
 268         stats.media_fs = emufs_fsc_get_media_fs(efs);
 269         emufs_fsc_get_max_min_fs(efs,&stats.min_fs,&stats.max_fs);
 270
 271         /* Cant registros */
 272         tmp = emufs_idx_get(efs,&stats.tam_archivo);
 273         free(tmp);
 274
 275         /* Size del archivo de datos */
 276         if ( (file = fopen(name_f,"ab")) == NULL){
 277                         PERR("No se pudo abrir el archivo");
 278                         return stats;
 279         }
 280         stats.tam_archivo_bytes = ftell(file);
 281         fclose(file);
 282
 283         /* Size del archivo de Espacio Libre */
 284         strcpy(name_f,efs->nombre);
 285         strcat(name_f,EMUFS_FSC_EXT);
 286         if ( (file = fopen(name_f,"ab")) == NULL){
 287             PERR("No se pudo abrir el archivo");
 288                 return stats;
 289         }
 290         fsc_size = ftell(file);
 291         fclose(file);
 292
 293         /* Size del archivo Indice */
 294         strcpy(name_f,efs->nombre);
 295         strcat(name_f,EMUFS_IDX_EXT);
 296         if ( (file = fopen(name_f,"ab")) == NULL){
 297             PERR("No se pudo abrir el archivo");
 298                 return stats;
 299         }
 300         idx_size = ftell(file);
 301         fclose(file);
 302
 303         /* Cantidad de Bytes en info de control */
 304         stats.info_control = idx_size + fsc_size + sizeof(EMUFS_REG_ID)*stats.tam_archivo + sizeof(EMUFS_REG_SIZE)*stats.tam_archivo + sizeof(EMUFS_Tipo);
 305
 306         return(stats);
 307 }
 308
 309 /* Compacta el archivo eliminando espacios libres, alineando a izquierda */
 310 void emufs_tipo2_compactar(EMUFS *efs)
 311 {
 312         char name_fdat[255],name_ffsc[255];
 313         FILE *datfile;
 314         FILE *fscfile;
 315         EMUFS_FSC reg1,reg2;
 316         unsigned long cant_gaps = 0,mustmove_bytes = 0,source = 0,
 317                                   destination = 0,datsize = 0,totalfsc = 0;
 318
 319         strcpy(name_fdat,efs->nombre);
 320         strcpy(name_ffsc,efs->nombre);
 321         strcat(name_fdat,".dat");
 322         strcat(name_ffsc,EMUFS_FSC_EXT);
 323
 324         /* Obtengo el tamanio del .dat */
 325         if ( (datfile = fopen(name_fdat,"rb+")) == NULL){
 326                         PERR("No se pudo abrir el archivo");
 327                         return;
 328         }
 329         fseek(datfile,0,SEEK_END);
 330         datsize = ftell(datfile);
 331
 332         /* Obtengo la cantidad de gaps */
 333         if ( (fscfile = fopen(name_ffsc,"rb")) == NULL){
 334                         PERR("No se pudo abrir el archivo");
 335                         return;
 336         }
 337         fseek(fscfile,0,SEEK_END);
 338         cant_gaps = ftell(fscfile)/sizeof(EMUFS_FSC);
 339
 340         if (cant_gaps == 0) {
 341                 fclose(datfile);
 342                 fclose(fscfile);
 343                 return;
 344         }
 345         if (cant_gaps == 1) {
 346                 /* Un solo gap, muevo toda la data luego del gap y trunco */
 347                 fseek(fscfile,0,SEEK_SET);
 348                 fread(&reg1,sizeof(EMUFS_FSC),1,fscfile);
 349                 source = reg1.marker + reg1.freespace;
 350                 destination = reg1.marker;
 351                 mustmove_bytes = datsize - source;
 352                 /*printf("Para recompactar, must move: %lu bytes\n",mustmove_bytes);
 353                 printf("Will move from: %lu  to  %lu\n",source,destination);*/
 354                 emufs_tipo2_movedata(datfile,&source,&destination,mustmove_bytes);
 355         }
 356         if (cant_gaps > 1)
 357         {
 358                 /* Comienzo leyendo un gap */
 359                 fseek(fscfile,0,SEEK_SET);
 360                 fread(&reg1,sizeof(EMUFS_FSC),1,fscfile);
 361                 destination = reg1.marker;
 362                 --cant_gaps;
 363
 364                 while (cant_gaps > 0)
 365                 {
 366                         /* El source siempre sera el fin del anteultimo gap leido */
 367                         source = reg1.marker + reg1.freespace;
 368                         /* Leemos otro gap para calcular cuanto debemos mover */
 369                         fread(&reg2,sizeof(EMUFS_FSC),1,fscfile);
 370                         mustmove_bytes = reg2.marker - source;
 371                         /*printf("Para recompactar, must move: %lu bytes\n",mustmove_bytes);
 372                         printf("Will move from: %lu  to  %lu\n",source,destination);*/
 373                         emufs_tipo2_movedata(datfile,&source,&destination,mustmove_bytes);
 374                         /* Guardo el nuevo destino que es donde termino de mover */
 375                         destination = ftell(datfile);
 376                         /* El ultimo gap leido, pasa a ser el de referencia ahora */
 377                         reg1.marker = reg2.marker;
 378                         reg1.freespace = reg2.freespace;
 379                         --cant_gaps;
 380                 }
 381
 382                 /* Realizo el movimiento del ultimo chunk de datos */
 383                 source = reg1.marker + reg1.freespace;
 384                 mustmove_bytes = datsize - source;
 385                 emufs_tipo2_movedata(datfile,&source,&destination,mustmove_bytes);
 386         }
 387
 388         fclose(datfile);
 389         fclose(fscfile);
 390
 391         /* Trunco el dat para que no quede el espacio vacio al final */
 392         totalfsc = emufs_fsc_get_total_fs(efs);
 393         truncate(name_fdat,datsize - totalfsc);
 394         truncate(name_ffsc,0);
 395
 396         /* Recreo el Indice con los nuevos offsets */
 397         emufs_tipo2_updateidx(efs);
 398 }
 399
 400 /* Mueve data desde un source a un destination, de a chunks */
 401 void emufs_tipo2_movedata(FILE *datfile,EMUFS_OFFSET *source, EMUFS_OFFSET *destination, EMUFS_BLOCK_SIZE mustmove_bytes)
 402 {
 403     int chunksize = 25;
 404         char *chunk = malloc(chunksize*sizeof(char));
 405         unsigned long cant_chunks = 0,left_chunk = 0;
 406
 407         /* Obtengo cuantos bloques de a CHUNKSIZE bytes debo mover. Si la cantidad es no entera */
 408         cant_chunks = floor(mustmove_bytes/chunksize);
 409         left_chunk = fmod(mustmove_bytes,chunksize);
 410
 411         /*printf ("Cantidad de chunk de %i bytes movidos: %lu\n",chunksize,cant_chunks);
 412         printf ("Left chunk movido fue de: %lu bytes\n",left_chunk);*/
 413
 414         while(cant_chunks > 0)
 415         {
 416                 fseek(datfile,*source,SEEK_SET);
 417                 fread(chunk,chunksize,1,datfile);
 418                 fseek(datfile,*destination,SEEK_SET);
 419                 fwrite(chunk,chunksize,1,datfile);
 420                 *source += chunksize;
 421                 *destination += chunksize;
 422                 --cant_chunks;
 423         }
 424
 425         if (left_chunk > 0)
 426         {
 427                 fseek(datfile,*source,SEEK_SET);
 428                 fread(chunk,left_chunk,1,datfile);
 429                 fseek(datfile,*destination,SEEK_SET);
 430                 fwrite(chunk,left_chunk,1,datfile);
 431         }
 432
 433         free(chunk);
 434 }
 435
 436 /* Sincroniza el Index con las posiciones de los datos, luego de un recompactar */
 437 int emufs_tipo2_updateidx(EMUFS *efs)
 438 {
 439         char name_fdat[255];
 440         FILE *datfile;
 441         EMUFS_REG_ID reg_id = -1;
 442         EMUFS_OFFSET reg_offset = -1;
 443         EMUFS_REG_SIZE reg_size = -1;
 444
 445         strcpy(name_fdat,efs->nombre);
 446         strcat(name_fdat,".dat");
 447
 448         /* Obtengo el tamanio del .dat */
 449         if ( (datfile = fopen(name_fdat,"rb+")) == NULL){
 450                         PERR("No se pudo abrir el archivo");
 451                         return -1;
 452         }
 453
 454         /* Recorremos el archivo y actualizamos el .idx */
 455         fseek(datfile,sizeof(EMUFS_Tipo),SEEK_SET);
 456         while (!feof(datfile))
 457         {
 458                 /* Leo un ID y actualizo el offset en el .idx */
 459                 reg_offset = ftell(datfile);
 460                 if (fread(&reg_id,sizeof(EMUFS_REG_ID),1,datfile) != 1) continue;
 461                 emufs_idx_actualizar(efs,reg_id,reg_offset);
 462                 /* Salteo la data del registro, para leer el proximo header */
 463                 fread(&reg_size,sizeof(EMUFS_REG_SIZE),1,datfile);
 464                 fseek(datfile,reg_size,SEEK_CUR);
 465         }
 466
 467         return 0;
 468 }