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