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