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