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