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