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         unsigned long fsc_size = 0,idx_size = 0;
 251         char name_f[255];
 252         FILE *file;
 253
 254         strcpy(name_f,efs->nombre);
 255         strcat(name_f,".dat");
 256
 257         /* Inicializo las stats por si hay error somewhere */
 258         stats.tam_archivo = 0;
 259         stats.tam_archivo_bytes = 0;
 260         stats.tam_datos_bytes = 0;
 261         stats.info_control = 0;
 262         stats.media_fs = 0;
 263         stats.total_fs = 0;
 264         stats.max_fs = 0;
 265         stats.min_fs = 0;
 266         stats.cant_bloques = 0;
 267
 268         /* Obtengo las stats de FSC */
 269         stats.total_fs = emufs_fsc_get_total_fs(efs);
 270         stats.media_fs = emufs_fsc_get_media_fs(efs);
 271         emufs_fsc_get_max_min_fs(efs,&stats.min_fs,&stats.max_fs);
 272
 273         /* Cant registros */
 274         tmp = emufs_idx_get(efs,&stats.tam_archivo);
 275         free(tmp);
 276
 277         /* Size del archivo de datos */
 278         if ( (file = fopen(name_f,"ab")) == NULL){
 279                         PERR("No se pudo abrir el archivo");
 280                         return stats;
 281         }
 282         stats.tam_archivo_bytes = ftell(file);
 283         fclose(file);
 284
 285         /* Size del archivo de Espacio Libre */
 286         strcpy(name_f,efs->nombre);
 287         strcat(name_f,EMUFS_FSC_EXT);
 288         if ( (file = fopen(name_f,"ab")) == NULL){
 289             PERR("No se pudo abrir el archivo");
 290                 return stats;
 291         }
 292         fsc_size = ftell(file);
 293         fclose(file);
 294
 295         /* Size del archivo Indice */
 296         strcpy(name_f,efs->nombre);
 297         strcat(name_f,EMUFS_IDX_EXT);
 298         if ( (file = fopen(name_f,"ab")) == NULL){
 299             PERR("No se pudo abrir el archivo");
 300                 return stats;
 301         }
 302         idx_size = ftell(file);
 303         fclose(file);
 304
 305         /* Cantidad de Bytes en info de control */
 306         stats.info_control = idx_size + fsc_size + sizeof(EMUFS_REG_ID)*stats.tam_archivo + sizeof(EMUFS_REG_SIZE)*stats.tam_archivo + sizeof(EMUFS_Tipo);
 307
 308         /* Cantida de Bytes en Datos */
 309         stats.tam_datos_bytes = stats.tam_archivo_bytes - sizeof(EMUFS_Tipo) - (sizeof(EMUFS_REG_ID) + sizeof(EMUFS_REG_SIZE)) * stats.tam_archivo;
 310
 311         return(stats);
 312 }
 313
 314 /* Compacta el archivo eliminando espacios libres, alineando a izquierda */
 315 void emufs_tipo2_compactar(EMUFS *efs)
 316 {
 317         char name_fdat[255],name_ffsc[255];
 318         FILE *datfile;
 319         FILE *fscfile;
 320         EMUFS_FSC reg1,reg2;
 321         unsigned long cant_gaps = 0,mustmove_bytes = 0,source = 0,
 322                                   destination = 0,datsize = 0,totalfsc = 0;
 323
 324         strcpy(name_fdat,efs->nombre);
 325         strcpy(name_ffsc,efs->nombre);
 326         strcat(name_fdat,".dat");
 327         strcat(name_ffsc,EMUFS_FSC_EXT);
 328
 329         /* Obtengo el tamanio del .dat */
 330         if ( (datfile = fopen(name_fdat,"rb+")) == NULL){
 331                         PERR("No se pudo abrir el archivo");
 332                         return;
 333         }
 334         fseek(datfile,0,SEEK_END);
 335         datsize = ftell(datfile);
 336
 337         /* Obtengo la cantidad de gaps */
 338         if ( (fscfile = fopen(name_ffsc,"rb")) == NULL){
 339                         PERR("No se pudo abrir el archivo");
 340                         return;
 341         }
 342         fseek(fscfile,0,SEEK_END);
 343         cant_gaps = ftell(fscfile)/sizeof(EMUFS_FSC);
 344
 345         if (cant_gaps == 0) {
 346                 fclose(datfile);
 347                 fclose(fscfile);
 348                 return;
 349         }
 350         if (cant_gaps == 1) {
 351                 /* Un solo gap, muevo toda la data luego del gap y trunco */
 352                 fseek(fscfile,0,SEEK_SET);
 353                 fread(&reg1,sizeof(EMUFS_FSC),1,fscfile);
 354                 source = reg1.marker + reg1.freespace;
 355                 destination = reg1.marker;
 356                 mustmove_bytes = datsize - 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         }
 361         if (cant_gaps > 1)
 362         {
 363                 /* Comienzo leyendo un gap */
 364                 fseek(fscfile,0,SEEK_SET);
 365                 fread(&reg1,sizeof(EMUFS_FSC),1,fscfile);
 366                 destination = reg1.marker;
 367                 --cant_gaps;
 368
 369                 while (cant_gaps > 0)
 370                 {
 371                         /* El source siempre sera el fin del anteultimo gap leido */
 372                         source = reg1.marker + reg1.freespace;
 373                         /* Leemos otro gap para calcular cuanto debemos mover */
 374                         fread(&reg2,sizeof(EMUFS_FSC),1,fscfile);
 375                         mustmove_bytes = reg2.marker - source;
 376                         /*printf("Para recompactar, must move: %lu bytes\n",mustmove_bytes);
 377                         printf("Will move from: %lu  to  %lu\n",source,destination);*/
 378                         emufs_tipo2_movedata(datfile,&source,&destination,mustmove_bytes);
 379                         /* Guardo el nuevo destino que es donde termino de mover */
 380                         destination = ftell(datfile);
 381                         /* El ultimo gap leido, pasa a ser el de referencia ahora */
 382                         reg1.marker = reg2.marker;
 383                         reg1.freespace = reg2.freespace;
 384                         --cant_gaps;
 385                 }
 386
 387                 /* Realizo el movimiento del ultimo chunk de datos */
 388                 source = reg1.marker + reg1.freespace;
 389                 mustmove_bytes = datsize - source;
 390                 emufs_tipo2_movedata(datfile,&source,&destination,mustmove_bytes);
 391         }
 392
 393         fclose(datfile);
 394         fclose(fscfile);
 395
 396         /* Trunco el dat para que no quede el espacio vacio al final */
 397         totalfsc = emufs_fsc_get_total_fs(efs);
 398         truncate(name_fdat,datsize - totalfsc);
 399         truncate(name_ffsc,0);
 400
 401         /* Recreo el Indice con los nuevos offsets */
 402         emufs_tipo2_updateidx(efs);
 403 }
 404
 405 /* Mueve data desde un source a un destination, de a chunks */
 406 void emufs_tipo2_movedata(FILE *datfile,EMUFS_OFFSET *source, EMUFS_OFFSET *destination, EMUFS_BLOCK_SIZE mustmove_bytes)
 407 {
 408     int chunksize = 25;
 409         char *chunk = malloc(chunksize*sizeof(char));
 410         unsigned long cant_chunks = 0,left_chunk = 0;
 411
 412         /* Obtengo cuantos bloques de a CHUNKSIZE bytes debo mover. Si la cantidad es no entera */
 413         cant_chunks = floor(mustmove_bytes/chunksize);
 414         left_chunk = fmod(mustmove_bytes,chunksize);
 415
 416         /*printf ("Cantidad de chunk de %i bytes movidos: %lu\n",chunksize,cant_chunks);
 417         printf ("Left chunk movido fue de: %lu bytes\n",left_chunk);*/
 418
 419         while(cant_chunks > 0)
 420         {
 421                 fseek(datfile,*source,SEEK_SET);
 422                 fread(chunk,chunksize,1,datfile);
 423                 fseek(datfile,*destination,SEEK_SET);
 424                 fwrite(chunk,chunksize,1,datfile);
 425                 *source += chunksize;
 426                 *destination += chunksize;
 427                 --cant_chunks;
 428         }
 429
 430         if (left_chunk > 0)
 431         {
 432                 fseek(datfile,*source,SEEK_SET);
 433                 fread(chunk,left_chunk,1,datfile);
 434                 fseek(datfile,*destination,SEEK_SET);
 435                 fwrite(chunk,left_chunk,1,datfile);
 436         }
 437
 438         free(chunk);
 439 }
 440
 441 /* Sincroniza el Index con las posiciones de los datos, luego de un recompactar */
 442 int emufs_tipo2_updateidx(EMUFS *efs)
 443 {
 444         char name_fdat[255];
 445         FILE *datfile;
 446         EMUFS_REG_ID reg_id = -1;
 447         EMUFS_OFFSET reg_offset = -1;
 448         EMUFS_REG_SIZE reg_size = -1;
 449
 450         strcpy(name_fdat,efs->nombre);
 451         strcat(name_fdat,".dat");
 452
 453         /* Obtengo el tamanio del .dat */
 454         if ( (datfile = fopen(name_fdat,"rb+")) == NULL){
 455                         PERR("No se pudo abrir el archivo");
 456                         return -1;
 457         }
 458
 459         /* Recorremos el archivo y actualizamos el .idx */
 460         fseek(datfile,sizeof(EMUFS_Tipo),SEEK_SET);
 461         while (!feof(datfile))
 462         {
 463                 /* Leo un ID y actualizo el offset en el .idx */
 464                 reg_offset = ftell(datfile);
 465                 if (fread(&reg_id,sizeof(EMUFS_REG_ID),1,datfile) != 1) continue;
 466                 emufs_idx_actualizar(efs,reg_id,reg_offset);
 467                 /* Salteo la data del registro, para leer el proximo header */
 468                 fread(&reg_size,sizeof(EMUFS_REG_SIZE),1,datfile);
 469                 fseek(datfile,reg_size,SEEK_CUR);
 470         }
 471
 472         return 0;
 473 }
 474
 475 void* emufs_tipo2_leer_registro_raw(EMUFS *emu, EMUFS_REG_ID id, EMUFS_REG_SIZE *size, int *pos)
 476 {
 477         (*size) = 0;
 478         (*pos) = 0;
 479         PERR("IMPLEMENTAME CABRON");
 480         return NULL;
 481 }