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