/* vim:set shiftwidth=4 ts=8: */

/*

 * QEMU Block driver for virtual VFAT (shadows a local directory)

 *

 * Copyright (c) 2004,2005 Johannes E. Schindelin

 *

 * Permission is hereby granted, free of charge, to any person obtaining a copy

 * of this software and associated documentation files (the "Software"), to deal

 * in the Software without restriction, including without limitation the rights

 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

 * copies of the Software, and to permit persons to whom the Software is

 * furnished to do so, subject to the following conditions:

 *

 * The above copyright notice and this permission notice shall be included in

 * all copies or substantial portions of the Software.

 *

 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL

 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

 * THE SOFTWARE.

 */

#include <sys/stat.h>

#include <dirent.h>

#include <assert.h>

#include "qemu-common.h"

#include "block_int.h"

#ifndef S_IWGRP

#define S_IWGRP 0

#endif

#ifndef S_IWOTH

#define S_IWOTH 0

#endif

/* TODO: add ":bootsector=blabla.img:" */

/* LATER TODO: add automatic boot sector generation from

    BOOTEASY.ASM and Ranish Partition Manager

    Note that DOS assumes the system files to be the first files in the

    file system (test if the boot sector still relies on that fact)! */

/* MAYBE TODO: write block-visofs.c */

/* TODO: call try_commit() only after a timeout */

/* #define DEBUG */

#ifdef DEBUG

#define DLOG(a) a

#undef stderr

#define stderr STDERR

FILE* stderr = NULL;

static void checkpoint(void);

#ifdef __MINGW32__

void nonono(const char* file, int line, const char* msg) {

    fprintf(stderr, "Nonono! %s:%d %s\n", file, line, msg);

    exit(-5);

}

#undef assert

#define assert(a) do {if (!(a)) nonono(__FILE__, __LINE__, #a);}while(0)

#endif

#else

#define DLOG(a)

#endif

/* dynamic array functions */

typedef struct array_t {

    char* pointer;

    unsigned int size,next,item_size;

} array_t;

static inline void array_init(array_t* array,unsigned int item_size)

{

    array->pointer=0;

    array->size=0;

    array->next=0;

    array->item_size=item_size;

}

static inline void array_free(array_t* array)

{

    if(array->pointer)

        free(array->pointer);

    array->size=array->next=0;

}

/* does not automatically grow */

static inline void* array_get(array_t* array,unsigned int index) {

    assert(index < array->next);

    return array->pointer + index * array->item_size;

}

static inline int array_ensure_allocated(array_t* array, int index)

{

    if((index + 1) * array->item_size > array->size) {

	int new_size = (index + 32) * array->item_size;

	array->pointer = qemu_realloc(array->pointer, new_size);

	if (!array->pointer)

	    return -1;

	array->size = new_size;

	array->next = index + 1;

    }

    return 0;

}

static inline void* array_get_next(array_t* array) {

    unsigned int next = array->next;

    void* result;

    if (array_ensure_allocated(array, next) < 0)

	return NULL;

    array->next = next + 1;

    result = array_get(array, next);

    return result;

}

static inline void* array_insert(array_t* array,unsigned int index,unsigned int count) {

    if((array->next+count)*array->item_size>array->size) {

	int increment=count*array->item_size;

	array->pointer=qemu_realloc(array->pointer,array->size+increment);

	if(!array->pointer)

	    return 0;

	array->size+=increment;

    }

    memmove(array->pointer+(index+count)*array->item_size,

		array->pointer+index*array->item_size,

		(array->next-index)*array->item_size);

    array->next+=count;

    return array->pointer+index*array->item_size;

}

/* this performs a "roll", so that the element which was at index_from becomes

 * index_to, but the order of all other elements is preserved. */

static inline int array_roll(array_t* array,int index_to,int index_from,int count)

{

    char* buf;

    char* from;

    char* to;

    int is;

    if(!array ||

	    index_to<0 || index_to>=array->next ||

	    index_from<0 || index_from>=array->next)

	return -1;

    if(index_to==index_from)

	return 0;

    is=array->item_size;

    from=array->pointer+index_from*is;

    to=array->pointer+index_to*is;

    buf=malloc(is*count);

    memcpy(buf,from,is*count);

    if(index_to<index_from)

	memmove(to+is*count,to,from-to);

    else

	memmove(from,from+is*count,to-from);

    memcpy(to,buf,is*count);

    free(buf);

    return 0;

}

static inline int array_remove_slice(array_t* array,int index, int count)

{

    assert(index >=0);

    assert(count > 0);

    assert(index + count <= array->next);

    if(array_roll(array,array->next-1,index,count))

	return -1;

    array->next -= count;

    return 0;

}

static int array_remove(array_t* array,int index)

{

    return array_remove_slice(array, index, 1);

}

/* return the index for a given member */

static int array_index(array_t* array, void* pointer)

{

    size_t offset = (char*)pointer - array->pointer;

    assert((offset % array->item_size) == 0);

    assert(offset/array->item_size < array->next);

    return offset/array->item_size;

}

/* These structures are used to fake a disk and the VFAT filesystem.

 * For this reason we need to use __attribute__((packed)). */

typedef struct bootsector_t {

    uint8_t jump[3];

    uint8_t name[8];

    uint16_t sector_size;

    uint8_t sectors_per_cluster;

    uint16_t reserved_sectors;

    uint8_t number_of_fats;

    uint16_t root_entries;

    uint16_t total_sectors16;

    uint8_t media_type;

    uint16_t sectors_per_fat;

    uint16_t sectors_per_track;

    uint16_t number_of_heads;

    uint32_t hidden_sectors;

    uint32_t total_sectors;

    union {

        struct {

	    uint8_t drive_number;

	    uint8_t current_head;

	    uint8_t signature;

	    uint32_t id;

	    uint8_t volume_label[11];

	} __attribute__((packed)) fat16;

	struct {

	    uint32_t sectors_per_fat;

	    uint16_t flags;

	    uint8_t major,minor;

	    uint32_t first_cluster_of_root_directory;

	    uint16_t info_sector;

	    uint16_t backup_boot_sector;

	    uint16_t ignored;

	} __attribute__((packed)) fat32;

    } u;

    uint8_t fat_type[8];

    uint8_t ignored[0x1c0];

    uint8_t magic[2];

} __attribute__((packed)) bootsector_t;

typedef struct {

    uint8_t head;

    uint8_t sector;

    uint8_t cylinder;

} mbr_chs_t;

typedef struct partition_t {

    uint8_t attributes; /* 0x80 = bootable */

    mbr_chs_t start_CHS;

    uint8_t   fs_type; /* 0x1 = FAT12, 0x6 = FAT16, 0xe = FAT16_LBA, 0xb = FAT32, 0xc = FAT32_LBA */

    mbr_chs_t end_CHS;

    uint32_t start_sector_long;

    uint32_t length_sector_long;

} __attribute__((packed)) partition_t;

typedef struct mbr_t {

    uint8_t ignored[0x1b8];

    uint32_t nt_id;

    uint8_t ignored2[2];

    partition_t partition[4];

    uint8_t magic[2];

} __attribute__((packed)) mbr_t;

typedef struct direntry_t {

    uint8_t name[8];

    uint8_t extension[3];

    uint8_t attributes;

    uint8_t reserved[2];

    uint16_t ctime;

    uint16_t cdate;

    uint16_t adate;

    uint16_t begin_hi;

    uint16_t mtime;

    uint16_t mdate;

    uint16_t begin;

    uint32_t size;

} __attribute__((packed)) direntry_t;

/* this structure are used to transparently access the files */

typedef struct mapping_t {

    /* begin is the first cluster, end is the last+1 */

    uint32_t begin,end;

    /* as s->directory is growable, no pointer may be used here */

    unsigned int dir_index;

    /* the clusters of a file may be in any order; this points to the first */

    int first_mapping_index;

    union {

	/* offset is

	 * - the offset in the file (in clusters) for a file, or

	 * - the next cluster of the directory for a directory, and

	 * - the address of the buffer for a faked entry

	 */

	struct {

	    uint32_t offset;

	} file;

	struct {

	    int parent_mapping_index;

	    int first_dir_index;

	} dir;

    } info;

    /* path contains the full path, i.e. it always starts with s->path */

    char* path;

    enum { MODE_UNDEFINED = 0, MODE_NORMAL = 1, MODE_MODIFIED = 2,

	MODE_DIRECTORY = 4, MODE_FAKED = 8,

	MODE_DELETED = 16, MODE_RENAMED = 32 } mode;

    int read_only;

} mapping_t;

#ifdef DEBUG

static void print_direntry(const struct direntry_t*);

static void print_mapping(const struct mapping_t* mapping);

#endif

/* here begins the real VVFAT driver */

typedef struct BDRVVVFATState {

    BlockDriverState* bs; /* pointer to parent */

    unsigned int first_sectors_number; /* 1 for a single partition, 0x40 for a disk with partition table */

    unsigned char first_sectors[0x40*0x200];

    int fat_type; /* 16 or 32 */

    array_t fat,directory,mapping;

    unsigned int cluster_size;

    unsigned int sectors_per_cluster;

    unsigned int sectors_per_fat;

    unsigned int sectors_of_root_directory;

    uint32_t last_cluster_of_root_directory;

    unsigned int faked_sectors; /* how many sectors are faked before file data */

    uint32_t sector_count; /* total number of sectors of the partition */

    uint32_t cluster_count; /* total number of clusters of this partition */

    uint32_t max_fat_value;

    int current_fd;

    mapping_t* current_mapping;

    unsigned char* cluster; /* points to current cluster */

    unsigned char* cluster_buffer; /* points to a buffer to hold temp data */

    unsigned int current_cluster;

    /* write support */

    BlockDriverState* write_target;

    char* qcow_filename;

    BlockDriverState* qcow;

    void* fat2;

    char* used_clusters;

    array_t commits;

    const char* path;

    int downcase_short_names;

} BDRVVVFATState;

/* take the sector position spos and convert it to Cylinder/Head/Sector position

 * if the position is outside the specified geometry, fill maximum value for CHS

 * and return 1 to signal overflow.

 */

static int sector2CHS(BlockDriverState* bs, mbr_chs_t * chs, int spos){

    int head,sector;

    sector   = spos % (bs->secs);  spos/= bs->secs;

    head     = spos % (bs->heads); spos/= bs->heads;

    if(spos >= bs->cyls){

        /* Overflow,

        it happens if 32bit sector positions are used, while CHS is only 24bit.

        Windows/Dos is said to take 1023/255/63 as nonrepresentable CHS */

        chs->head     = 0xFF;

        chs->sector   = 0xFF;

        chs->cylinder = 0xFF;

        return 1;

    }

    chs->head     = (uint8_t)head;

    chs->sector   = (uint8_t)( (sector+1) | ((spos>>8)<<6) );

    chs->cylinder = (uint8_t)spos;

    return 0;

}

static void init_mbr(BDRVVVFATState* s)

{

    /* TODO: if the files mbr.img and bootsect.img exist, use them */

    mbr_t* real_mbr=(mbr_t*)s->first_sectors;

    partition_t* partition=&(real_mbr->partition[0]);

    int lba;

    memset(s->first_sectors,0,512);

    /* Win NT Disk Signature */

    real_mbr->nt_id= cpu_to_le32(0xbe1afdfa);

    partition->attributes=0x80; /* bootable */

    /* LBA is used when partition is outside the CHS geometry */

    lba = sector2CHS(s->bs, &partition->start_CHS, s->first_sectors_number-1);

    lba|= sector2CHS(s->bs, &partition->end_CHS,   s->sector_count);

    /*LBA partitions are identified only by start/length_sector_long not by CHS*/

    partition->start_sector_long =cpu_to_le32(s->first_sectors_number-1);

    partition->length_sector_long=cpu_to_le32(s->sector_count - s->first_sectors_number+1);

    /* FAT12/FAT16/FAT32 */

    /* DOS uses different types when partition is LBA,

       probably to prevent older versions from using CHS on them */

    partition->fs_type= s->fat_type==12 ? 0x1:

                        s->fat_type==16 ? (lba?0xe:0x06):

                         /*fat_tyoe==32*/ (lba?0xc:0x0b);

    real_mbr->magic[0]=0x55; real_mbr->magic[1]=0xaa;

}

/* direntry functions */

/* dest is assumed to hold 258 bytes, and pads with 0xffff up to next multiple of 26 */

static inline int short2long_name(char* dest,const char* src)

{

    int i;

    int len;

    for(i=0;i<129 && src[i];i++) {

        dest[2*i]=src[i];

	dest[2*i+1]=0;

    }

    len=2*i;

    dest[2*i]=dest[2*i+1]=0;

    for(i=2*i+2;(i%26);i++)

	dest[i]=0xff;

    return len;

}

static inline direntry_t* create_long_filename(BDRVVVFATState* s,const char* filename)

{

    char buffer[258];

    int length=short2long_name(buffer,filename),

        number_of_entries=(length+25)/26,i;

    direntry_t* entry;

    for(i=0;i<number_of_entries;i++) {

	entry=array_get_next(&(s->directory));

	entry->attributes=0xf;

	entry->reserved[0]=0;

	entry->begin=0;

	entry->name[0]=(number_of_entries-i)|(i==0?0x40:0);

    }

    for(i=0;i<26*number_of_entries;i++) {

	int offset=(i%26);

	if(offset<10) offset=1+offset;

	else if(offset<22) offset=14+offset-10;

	else offset=28+offset-22;

	entry=array_get(&(s->directory),s->directory.next-1-(i/26));

	entry->name[offset]=buffer[i];

    }

    return array_get(&(s->directory),s->directory.next-number_of_entries);

}

static char is_free(const direntry_t* direntry)

{

    return direntry->name[0]==0xe5 || direntry->name[0]==0x00;

}

static char is_volume_label(const direntry_t* direntry)

{

    return direntry->attributes == 0x28;

}

static char is_long_name(const direntry_t* direntry)

{

    return direntry->attributes == 0xf;

}

static char is_short_name(const direntry_t* direntry)

{

    return !is_volume_label(direntry) && !is_long_name(direntry)

	&& !is_free(direntry);

}

static char is_directory(const direntry_t* direntry)

{

    return direntry->attributes & 0x10 && direntry->name[0] != 0xe5;

}

static inline char is_dot(const direntry_t* direntry)

{

    return is_short_name(direntry) && direntry->name[0] == '.';

}

static char is_file(const direntry_t* direntry)

{

    return is_short_name(direntry) && !is_directory(direntry);

}

static inline uint32_t begin_of_direntry(const direntry_t* direntry)

{

    return le16_to_cpu(direntry->begin)|(le16_to_cpu(direntry->begin_hi)<<16);

}

static inline uint32_t filesize_of_direntry(const direntry_t* direntry)

{

    return le32_to_cpu(direntry->size);

}

static void set_begin_of_direntry(direntry_t* direntry, uint32_t begin)

{

    direntry->begin = cpu_to_le16(begin & 0xffff);

    direntry->begin_hi = cpu_to_le16((begin >> 16) & 0xffff);

}

/* fat functions */

static inline uint8_t fat_chksum(const direntry_t* entry)

{

    uint8_t chksum=0;

    int i;

    for(i=0;i<11;i++)

	chksum=(((chksum&0xfe)>>1)|((chksum&0x01)?0x80:0))

	    +(unsigned char)entry->name[i];

    return chksum;

}

/* if return_time==0, this returns the fat_date, else the fat_time */

static uint16_t fat_datetime(time_t time,int return_time) {

    struct tm* t;

#ifdef _WIN32

    t=localtime(&time); /* this is not thread safe */

#else

    struct tm t1;

    t=&t1;

    localtime_r(&time,t);

#endif