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