meson: move option validation together
[qemu/ar7.git] / block / vvfat.c
blob9d050ba3aea08eeac3d284e7d1e41545ff5b9f9f
1 /* vim:set shiftwidth=4 ts=4: */
2 /*
3 * QEMU Block driver for virtual VFAT (shadows a local directory)
5 * Copyright (c) 2004,2005 Johannes E. Schindelin
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 * THE SOFTWARE.
26 #include "qemu/osdep.h"
27 #include <dirent.h>
28 #include <glib/gstdio.h>
29 #include "qapi/error.h"
30 #include "block/block-io.h"
31 #include "block/block_int.h"
32 #include "block/qdict.h"
33 #include "qemu/module.h"
34 #include "qemu/option.h"
35 #include "qemu/bswap.h"
36 #include "migration/blocker.h"
37 #include "qapi/qmp/qdict.h"
38 #include "qapi/qmp/qstring.h"
39 #include "qemu/ctype.h"
40 #include "qemu/cutils.h"
41 #include "qemu/error-report.h"
43 #ifndef S_IWGRP
44 #define S_IWGRP 0
45 #endif
46 #ifndef S_IWOTH
47 #define S_IWOTH 0
48 #endif
50 /* TODO: add ":bootsector=blabla.img:" */
51 /* LATER TODO: add automatic boot sector generation from
52 BOOTEASY.ASM and Ranish Partition Manager
53 Note that DOS assumes the system files to be the first files in the
54 file system (test if the boot sector still relies on that fact)! */
55 /* MAYBE TODO: write block-visofs.c */
56 /* TODO: call try_commit() only after a timeout */
58 /* #define DEBUG */
60 #ifdef DEBUG
62 #define DLOG(a) a
64 static void checkpoint(void);
66 #else
68 #define DLOG(a)
70 #endif
72 /* bootsector OEM name. see related compatibility problems at:
73 * https://jdebp.eu/FGA/volume-boot-block-oem-name-field.html
74 * http://seasip.info/Misc/oemid.html
76 #define BOOTSECTOR_OEM_NAME "MSWIN4.1"
78 #define DIR_DELETED 0xe5
79 #define DIR_KANJI DIR_DELETED
80 #define DIR_KANJI_FAKE 0x05
81 #define DIR_FREE 0x00
83 /* dynamic array functions */
84 typedef struct array_t {
85 char* pointer;
86 unsigned int size,next,item_size;
87 } array_t;
89 static inline void array_init(array_t* array,unsigned int item_size)
91 array->pointer = NULL;
92 array->size=0;
93 array->next=0;
94 array->item_size=item_size;
97 static inline void array_free(array_t* array)
99 g_free(array->pointer);
100 array->size=array->next=0;
103 /* does not automatically grow */
104 static inline void* array_get(array_t* array,unsigned int index) {
105 assert(index < array->next);
106 assert(array->pointer);
107 return array->pointer + index * array->item_size;
110 static inline void array_ensure_allocated(array_t *array, int index)
112 if((index + 1) * array->item_size > array->size) {
113 int new_size = (index + 32) * array->item_size;
114 array->pointer = g_realloc(array->pointer, new_size);
115 assert(array->pointer);
116 memset(array->pointer + array->size, 0, new_size - array->size);
117 array->size = new_size;
118 array->next = index + 1;
122 static inline void* array_get_next(array_t* array) {
123 unsigned int next = array->next;
125 array_ensure_allocated(array, next);
126 array->next = next + 1;
127 return array_get(array, next);
130 static inline void* array_insert(array_t* array,unsigned int index,unsigned int count) {
131 if((array->next+count)*array->item_size>array->size) {
132 int increment=count*array->item_size;
133 array->pointer=g_realloc(array->pointer,array->size+increment);
134 if(!array->pointer)
135 return NULL;
136 array->size+=increment;
138 memmove(array->pointer+(index+count)*array->item_size,
139 array->pointer+index*array->item_size,
140 (array->next-index)*array->item_size);
141 array->next+=count;
142 return array->pointer+index*array->item_size;
145 static inline int array_remove_slice(array_t* array,int index, int count)
147 assert(index >=0);
148 assert(count > 0);
149 assert(index + count <= array->next);
151 memmove(array->pointer + index * array->item_size,
152 array->pointer + (index + count) * array->item_size,
153 (array->next - index - count) * array->item_size);
155 array->next -= count;
156 return 0;
159 static int array_remove(array_t* array,int index)
161 return array_remove_slice(array, index, 1);
164 /* return the index for a given member */
165 static int array_index(array_t* array, void* pointer)
167 size_t offset = (char*)pointer - array->pointer;
168 assert((offset % array->item_size) == 0);
169 assert(offset/array->item_size < array->next);
170 return offset/array->item_size;
173 /* These structures are used to fake a disk and the VFAT filesystem.
174 * For this reason we need to use QEMU_PACKED. */
176 typedef struct bootsector_t {
177 uint8_t jump[3];
178 uint8_t name[8];
179 uint16_t sector_size;
180 uint8_t sectors_per_cluster;
181 uint16_t reserved_sectors;
182 uint8_t number_of_fats;
183 uint16_t root_entries;
184 uint16_t total_sectors16;
185 uint8_t media_type;
186 uint16_t sectors_per_fat;
187 uint16_t sectors_per_track;
188 uint16_t number_of_heads;
189 uint32_t hidden_sectors;
190 uint32_t total_sectors;
191 union {
192 struct {
193 uint8_t drive_number;
194 uint8_t reserved1;
195 uint8_t signature;
196 uint32_t id;
197 uint8_t volume_label[11];
198 uint8_t fat_type[8];
199 uint8_t ignored[0x1c0];
200 } QEMU_PACKED fat16;
201 struct {
202 uint32_t sectors_per_fat;
203 uint16_t flags;
204 uint8_t major,minor;
205 uint32_t first_cluster_of_root_dir;
206 uint16_t info_sector;
207 uint16_t backup_boot_sector;
208 uint8_t reserved[12];
209 uint8_t drive_number;
210 uint8_t reserved1;
211 uint8_t signature;
212 uint32_t id;
213 uint8_t volume_label[11];
214 uint8_t fat_type[8];
215 uint8_t ignored[0x1a4];
216 } QEMU_PACKED fat32;
217 } u;
218 uint8_t magic[2];
219 } QEMU_PACKED bootsector_t;
221 typedef struct {
222 uint8_t head;
223 uint8_t sector;
224 uint8_t cylinder;
225 } mbr_chs_t;
227 typedef struct partition_t {
228 uint8_t attributes; /* 0x80 = bootable */
229 mbr_chs_t start_CHS;
230 uint8_t fs_type; /* 0x1 = FAT12, 0x6 = FAT16, 0xe = FAT16_LBA, 0xb = FAT32, 0xc = FAT32_LBA */
231 mbr_chs_t end_CHS;
232 uint32_t start_sector_long;
233 uint32_t length_sector_long;
234 } QEMU_PACKED partition_t;
236 typedef struct mbr_t {
237 uint8_t ignored[0x1b8];
238 uint32_t nt_id;
239 uint8_t ignored2[2];
240 partition_t partition[4];
241 uint8_t magic[2];
242 } QEMU_PACKED mbr_t;
244 typedef struct direntry_t {
245 uint8_t name[8 + 3];
246 uint8_t attributes;
247 uint8_t reserved[2];
248 uint16_t ctime;
249 uint16_t cdate;
250 uint16_t adate;
251 uint16_t begin_hi;
252 uint16_t mtime;
253 uint16_t mdate;
254 uint16_t begin;
255 uint32_t size;
256 } QEMU_PACKED direntry_t;
258 /* this structure are used to transparently access the files */
260 typedef struct mapping_t {
261 /* begin is the first cluster, end is the last+1 */
262 uint32_t begin,end;
263 /* as s->directory is growable, no pointer may be used here */
264 unsigned int dir_index;
265 /* the clusters of a file may be in any order; this points to the first */
266 int first_mapping_index;
267 union {
268 /* offset is
269 * - the offset in the file (in clusters) for a file, or
270 * - the next cluster of the directory for a directory
272 struct {
273 uint32_t offset;
274 } file;
275 struct {
276 int parent_mapping_index;
277 int first_dir_index;
278 } dir;
279 } info;
280 /* path contains the full path, i.e. it always starts with s->path */
281 char* path;
283 enum {
284 MODE_UNDEFINED = 0,
285 MODE_NORMAL = 1,
286 MODE_MODIFIED = 2,
287 MODE_DIRECTORY = 4,
288 MODE_DELETED = 8,
289 } mode;
290 int read_only;
291 } mapping_t;
293 #ifdef DEBUG
294 static void print_direntry(const struct direntry_t*);
295 static void print_mapping(const struct mapping_t* mapping);
296 #endif
298 /* here begins the real VVFAT driver */
300 typedef struct BDRVVVFATState {
301 CoMutex lock;
302 BlockDriverState* bs; /* pointer to parent */
303 unsigned char first_sectors[0x40*0x200];
305 int fat_type; /* 16 or 32 */
306 array_t fat,directory,mapping;
307 char volume_label[11];
309 uint32_t offset_to_bootsector; /* 0 for floppy, 0x3f for disk */
311 unsigned int cluster_size;
312 unsigned int sectors_per_cluster;
313 unsigned int sectors_per_fat;
314 uint32_t last_cluster_of_root_directory;
315 /* how many entries are available in root directory (0 for FAT32) */
316 uint16_t root_entries;
317 uint32_t sector_count; /* total number of sectors of the partition */
318 uint32_t cluster_count; /* total number of clusters of this partition */
319 uint32_t max_fat_value;
320 uint32_t offset_to_fat;
321 uint32_t offset_to_root_dir;
323 int current_fd;
324 mapping_t* current_mapping;
325 unsigned char* cluster; /* points to current cluster */
326 unsigned char* cluster_buffer; /* points to a buffer to hold temp data */
327 unsigned int current_cluster;
329 /* write support */
330 char* qcow_filename;
331 BdrvChild* qcow;
332 void* fat2;
333 char* used_clusters;
334 array_t commits;
335 const char* path;
336 int downcase_short_names;
338 Error *migration_blocker;
339 } BDRVVVFATState;
341 /* take the sector position spos and convert it to Cylinder/Head/Sector position
342 * if the position is outside the specified geometry, fill maximum value for CHS
343 * and return 1 to signal overflow.
345 static int sector2CHS(mbr_chs_t *chs, int spos, int cyls, int heads, int secs)
347 int head,sector;
348 sector = spos % secs; spos /= secs;
349 head = spos % heads; spos /= heads;
350 if (spos >= cyls) {
351 /* Overflow,
352 it happens if 32bit sector positions are used, while CHS is only 24bit.
353 Windows/Dos is said to take 1023/255/63 as nonrepresentable CHS */
354 chs->head = 0xFF;
355 chs->sector = 0xFF;
356 chs->cylinder = 0xFF;
357 return 1;
359 chs->head = (uint8_t)head;
360 chs->sector = (uint8_t)( (sector+1) | ((spos>>8)<<6) );
361 chs->cylinder = (uint8_t)spos;
362 return 0;
365 static void init_mbr(BDRVVVFATState *s, int cyls, int heads, int secs)
367 /* TODO: if the files mbr.img and bootsect.img exist, use them */
368 mbr_t* real_mbr=(mbr_t*)s->first_sectors;
369 partition_t* partition = &(real_mbr->partition[0]);
370 int lba;
372 memset(s->first_sectors,0,512);
374 /* Win NT Disk Signature */
375 real_mbr->nt_id= cpu_to_le32(0xbe1afdfa);
377 partition->attributes=0x80; /* bootable */
379 /* LBA is used when partition is outside the CHS geometry */
380 lba = sector2CHS(&partition->start_CHS, s->offset_to_bootsector,
381 cyls, heads, secs);
382 lba |= sector2CHS(&partition->end_CHS, s->bs->total_sectors - 1,
383 cyls, heads, secs);
385 /*LBA partitions are identified only by start/length_sector_long not by CHS*/
386 partition->start_sector_long = cpu_to_le32(s->offset_to_bootsector);
387 partition->length_sector_long = cpu_to_le32(s->bs->total_sectors
388 - s->offset_to_bootsector);
390 /* FAT12/FAT16/FAT32 */
391 /* DOS uses different types when partition is LBA,
392 probably to prevent older versions from using CHS on them */
393 partition->fs_type = s->fat_type == 12 ? 0x1 :
394 s->fat_type == 16 ? (lba ? 0xe : 0x06) :
395 /*s->fat_type == 32*/ (lba ? 0xc : 0x0b);
397 real_mbr->magic[0]=0x55; real_mbr->magic[1]=0xaa;
400 /* direntry functions */
402 static direntry_t *create_long_filename(BDRVVVFATState *s, const char *filename)
404 int number_of_entries, i;
405 glong length;
406 direntry_t *entry;
408 gunichar2 *longname = g_utf8_to_utf16(filename, -1, NULL, &length, NULL);
409 if (!longname) {
410 fprintf(stderr, "vvfat: invalid UTF-8 name: %s\n", filename);
411 return NULL;
414 number_of_entries = DIV_ROUND_UP(length * 2, 26);
416 for(i=0;i<number_of_entries;i++) {
417 entry=array_get_next(&(s->directory));
418 entry->attributes=0xf;
419 entry->reserved[0]=0;
420 entry->begin=0;
421 entry->name[0]=(number_of_entries-i)|(i==0?0x40:0);
423 for(i=0;i<26*number_of_entries;i++) {
424 int offset=(i%26);
425 if(offset<10) offset=1+offset;
426 else if(offset<22) offset=14+offset-10;
427 else offset=28+offset-22;
428 entry=array_get(&(s->directory),s->directory.next-1-(i/26));
429 if (i >= 2 * length + 2) {
430 entry->name[offset] = 0xff;
431 } else if (i % 2 == 0) {
432 entry->name[offset] = longname[i / 2] & 0xff;
433 } else {
434 entry->name[offset] = longname[i / 2] >> 8;
437 g_free(longname);
438 return array_get(&(s->directory),s->directory.next-number_of_entries);
441 static char is_free(const direntry_t* direntry)
443 return direntry->name[0] == DIR_DELETED || direntry->name[0] == DIR_FREE;
446 static char is_volume_label(const direntry_t* direntry)
448 return direntry->attributes == 0x28;
451 static char is_long_name(const direntry_t* direntry)
453 return direntry->attributes == 0xf;
456 static char is_short_name(const direntry_t* direntry)
458 return !is_volume_label(direntry) && !is_long_name(direntry)
459 && !is_free(direntry);
462 static char is_directory(const direntry_t* direntry)
464 return direntry->attributes & 0x10 && direntry->name[0] != DIR_DELETED;
467 static inline char is_dot(const direntry_t* direntry)
469 return is_short_name(direntry) && direntry->name[0] == '.';
472 static char is_file(const direntry_t* direntry)
474 return is_short_name(direntry) && !is_directory(direntry);
477 static inline uint32_t begin_of_direntry(const direntry_t* direntry)
479 return le16_to_cpu(direntry->begin)|(le16_to_cpu(direntry->begin_hi)<<16);
482 static inline uint32_t filesize_of_direntry(const direntry_t* direntry)
484 return le32_to_cpu(direntry->size);
487 static void set_begin_of_direntry(direntry_t* direntry, uint32_t begin)
489 direntry->begin = cpu_to_le16(begin & 0xffff);
490 direntry->begin_hi = cpu_to_le16((begin >> 16) & 0xffff);
493 static bool valid_filename(const unsigned char *name)
495 unsigned char c;
496 if (!strcmp((const char*)name, ".") || !strcmp((const char*)name, "..")) {
497 return false;
499 for (; (c = *name); name++) {
500 if (!((c >= '0' && c <= '9') ||
501 (c >= 'A' && c <= 'Z') ||
502 (c >= 'a' && c <= 'z') ||
503 c > 127 ||
504 strchr(" $%'-_@~`!(){}^#&.+,;=[]", c) != NULL))
506 return false;
509 return true;
512 static uint8_t to_valid_short_char(gunichar c)
514 c = g_unichar_toupper(c);
515 if ((c >= '0' && c <= '9') ||
516 (c >= 'A' && c <= 'Z') ||
517 strchr("$%'-_@~`!(){}^#&", c) != NULL) {
518 return c;
519 } else {
520 return 0;
524 static direntry_t *create_short_filename(BDRVVVFATState *s,
525 const char *filename,
526 unsigned int directory_start)
528 int i, j = 0;
529 direntry_t *entry = array_get_next(&(s->directory));
530 const gchar *p, *last_dot = NULL;
531 gunichar c;
532 bool lossy_conversion = false;
533 char tail[8];
535 if (!entry) {
536 return NULL;
538 memset(entry->name, 0x20, sizeof(entry->name));
540 /* copy filename and search last dot */
541 for (p = filename; ; p = g_utf8_next_char(p)) {
542 c = g_utf8_get_char(p);
543 if (c == '\0') {
544 break;
545 } else if (c == '.') {
546 if (j == 0) {
547 /* '.' at start of filename */
548 lossy_conversion = true;
549 } else {
550 if (last_dot) {
551 lossy_conversion = true;
553 last_dot = p;
555 } else if (!last_dot) {
556 /* first part of the name; copy it */
557 uint8_t v = to_valid_short_char(c);
558 if (j < 8 && v) {
559 entry->name[j++] = v;
560 } else {
561 lossy_conversion = true;
566 /* copy extension (if any) */
567 if (last_dot) {
568 j = 0;
569 for (p = g_utf8_next_char(last_dot); ; p = g_utf8_next_char(p)) {
570 c = g_utf8_get_char(p);
571 if (c == '\0') {
572 break;
573 } else {
574 /* extension; copy it */
575 uint8_t v = to_valid_short_char(c);
576 if (j < 3 && v) {
577 entry->name[8 + (j++)] = v;
578 } else {
579 lossy_conversion = true;
585 if (entry->name[0] == DIR_KANJI) {
586 entry->name[0] = DIR_KANJI_FAKE;
589 /* numeric-tail generation */
590 for (j = 0; j < 8; j++) {
591 if (entry->name[j] == ' ') {
592 break;
595 for (i = lossy_conversion ? 1 : 0; i < 999999; i++) {
596 direntry_t *entry1;
597 if (i > 0) {
598 int len = snprintf(tail, sizeof(tail), "~%u", (unsigned)i);
599 assert(len <= 7);
600 memcpy(entry->name + MIN(j, 8 - len), tail, len);
602 for (entry1 = array_get(&(s->directory), directory_start);
603 entry1 < entry; entry1++) {
604 if (!is_long_name(entry1) &&
605 !memcmp(entry1->name, entry->name, 11)) {
606 break; /* found dupe */
609 if (entry1 == entry) {
610 /* no dupe found */
611 return entry;
614 return NULL;
617 /* fat functions */
619 static inline uint8_t fat_chksum(const direntry_t* entry)
621 uint8_t chksum=0;
622 int i;
624 for (i = 0; i < ARRAY_SIZE(entry->name); i++) {
625 chksum = (((chksum & 0xfe) >> 1) |
626 ((chksum & 0x01) ? 0x80 : 0)) + entry->name[i];
629 return chksum;
632 /* if return_time==0, this returns the fat_date, else the fat_time */
633 static uint16_t fat_datetime(time_t time,int return_time) {
634 struct tm* t;
635 struct tm t1;
636 t = &t1;
637 localtime_r(&time,t);
638 if(return_time)
639 return cpu_to_le16((t->tm_sec/2)|(t->tm_min<<5)|(t->tm_hour<<11));
640 return cpu_to_le16((t->tm_mday)|((t->tm_mon+1)<<5)|((t->tm_year-80)<<9));
643 static inline void fat_set(BDRVVVFATState* s,unsigned int cluster,uint32_t value)
645 if(s->fat_type==32) {
646 uint32_t* entry=array_get(&(s->fat),cluster);
647 *entry=cpu_to_le32(value);
648 } else if(s->fat_type==16) {
649 uint16_t* entry=array_get(&(s->fat),cluster);
650 *entry=cpu_to_le16(value&0xffff);
651 } else {
652 int offset = (cluster*3/2);
653 unsigned char* p = array_get(&(s->fat), offset);
654 switch (cluster&1) {
655 case 0:
656 p[0] = value&0xff;
657 p[1] = (p[1]&0xf0) | ((value>>8)&0xf);
658 break;
659 case 1:
660 p[0] = (p[0]&0xf) | ((value&0xf)<<4);
661 p[1] = (value>>4);
662 break;
667 static inline uint32_t fat_get(BDRVVVFATState* s,unsigned int cluster)
669 if(s->fat_type==32) {
670 uint32_t* entry=array_get(&(s->fat),cluster);
671 return le32_to_cpu(*entry);
672 } else if(s->fat_type==16) {
673 uint16_t* entry=array_get(&(s->fat),cluster);
674 return le16_to_cpu(*entry);
675 } else {
676 const uint8_t* x=(uint8_t*)(s->fat.pointer)+cluster*3/2;
677 return ((x[0]|(x[1]<<8))>>(cluster&1?4:0))&0x0fff;
681 static inline int fat_eof(BDRVVVFATState* s,uint32_t fat_entry)
683 if(fat_entry>s->max_fat_value-8)
684 return -1;
685 return 0;
688 static inline void init_fat(BDRVVVFATState* s)
690 if (s->fat_type == 12) {
691 array_init(&(s->fat),1);
692 array_ensure_allocated(&(s->fat),
693 s->sectors_per_fat * 0x200 * 3 / 2 - 1);
694 } else {
695 array_init(&(s->fat),(s->fat_type==32?4:2));
696 array_ensure_allocated(&(s->fat),
697 s->sectors_per_fat * 0x200 / s->fat.item_size - 1);
699 memset(s->fat.pointer,0,s->fat.size);
701 switch(s->fat_type) {
702 case 12: s->max_fat_value=0xfff; break;
703 case 16: s->max_fat_value=0xffff; break;
704 case 32: s->max_fat_value=0x0fffffff; break;
705 default: s->max_fat_value=0; /* error... */
710 static inline direntry_t* create_short_and_long_name(BDRVVVFATState* s,
711 unsigned int directory_start, const char* filename, int is_dot)
713 int long_index = s->directory.next;
714 direntry_t* entry = NULL;
715 direntry_t* entry_long = NULL;
717 if(is_dot) {
718 entry=array_get_next(&(s->directory));
719 memset(entry->name, 0x20, sizeof(entry->name));
720 memcpy(entry->name,filename,strlen(filename));
721 return entry;
724 entry_long=create_long_filename(s,filename);
725 entry = create_short_filename(s, filename, directory_start);
727 /* calculate checksum; propagate to long name */
728 if(entry_long) {
729 uint8_t chksum=fat_chksum(entry);
731 /* calculate anew, because realloc could have taken place */
732 entry_long=array_get(&(s->directory),long_index);
733 while(entry_long<entry && is_long_name(entry_long)) {
734 entry_long->reserved[1]=chksum;
735 entry_long++;
739 return entry;
743 * Read a directory. (the index of the corresponding mapping must be passed).
745 static int read_directory(BDRVVVFATState* s, int mapping_index)
747 mapping_t* mapping = array_get(&(s->mapping), mapping_index);
748 direntry_t* direntry;
749 const char* dirname = mapping->path;
750 int first_cluster = mapping->begin;
751 int parent_index = mapping->info.dir.parent_mapping_index;
752 mapping_t* parent_mapping = (mapping_t*)
753 (parent_index >= 0 ? array_get(&(s->mapping), parent_index) : NULL);
754 int first_cluster_of_parent = parent_mapping ? parent_mapping->begin : -1;
756 DIR* dir=opendir(dirname);
757 struct dirent* entry;
758 int i;
760 assert(mapping->mode & MODE_DIRECTORY);
762 if(!dir) {
763 mapping->end = mapping->begin;
764 return -1;
767 i = mapping->info.dir.first_dir_index =
768 first_cluster == 0 ? 0 : s->directory.next;
770 if (first_cluster != 0) {
771 /* create the top entries of a subdirectory */
772 (void)create_short_and_long_name(s, i, ".", 1);
773 (void)create_short_and_long_name(s, i, "..", 1);
776 /* actually read the directory, and allocate the mappings */
777 while((entry=readdir(dir))) {
778 unsigned int length=strlen(dirname)+2+strlen(entry->d_name);
779 char* buffer;
780 struct stat st;
781 int is_dot=!strcmp(entry->d_name,".");
782 int is_dotdot=!strcmp(entry->d_name,"..");
784 if (first_cluster == 0 && s->directory.next >= s->root_entries - 1) {
785 fprintf(stderr, "Too many entries in root directory\n");
786 closedir(dir);
787 return -2;
790 if(first_cluster == 0 && (is_dotdot || is_dot))
791 continue;
793 buffer = g_malloc(length);
794 snprintf(buffer,length,"%s/%s",dirname,entry->d_name);
796 if(stat(buffer,&st)<0) {
797 g_free(buffer);
798 continue;
801 /* create directory entry for this file */
802 if (!is_dot && !is_dotdot) {
803 direntry = create_short_and_long_name(s, i, entry->d_name, 0);
804 } else {
805 direntry = array_get(&(s->directory), is_dot ? i : i + 1);
807 direntry->attributes=(S_ISDIR(st.st_mode)?0x10:0x20);
808 direntry->reserved[0]=direntry->reserved[1]=0;
809 direntry->ctime=fat_datetime(st.st_ctime,1);
810 direntry->cdate=fat_datetime(st.st_ctime,0);
811 direntry->adate=fat_datetime(st.st_atime,0);
812 direntry->begin_hi=0;
813 direntry->mtime=fat_datetime(st.st_mtime,1);
814 direntry->mdate=fat_datetime(st.st_mtime,0);
815 if(is_dotdot)
816 set_begin_of_direntry(direntry, first_cluster_of_parent);
817 else if(is_dot)
818 set_begin_of_direntry(direntry, first_cluster);
819 else
820 direntry->begin=0; /* do that later */
821 if (st.st_size > 0x7fffffff) {
822 fprintf(stderr, "File %s is larger than 2GB\n", buffer);
823 g_free(buffer);
824 closedir(dir);
825 return -2;
827 direntry->size=cpu_to_le32(S_ISDIR(st.st_mode)?0:st.st_size);
829 /* create mapping for this file */
830 if(!is_dot && !is_dotdot && (S_ISDIR(st.st_mode) || st.st_size)) {
831 s->current_mapping = array_get_next(&(s->mapping));
832 s->current_mapping->begin=0;
833 s->current_mapping->end=st.st_size;
835 * we get the direntry of the most recent direntry, which
836 * contains the short name and all the relevant information.
838 s->current_mapping->dir_index=s->directory.next-1;
839 s->current_mapping->first_mapping_index = -1;
840 if (S_ISDIR(st.st_mode)) {
841 s->current_mapping->mode = MODE_DIRECTORY;
842 s->current_mapping->info.dir.parent_mapping_index =
843 mapping_index;
844 } else {
845 s->current_mapping->mode = MODE_UNDEFINED;
846 s->current_mapping->info.file.offset = 0;
848 s->current_mapping->path=buffer;
849 s->current_mapping->read_only =
850 (st.st_mode & (S_IWUSR | S_IWGRP | S_IWOTH)) == 0;
851 } else {
852 g_free(buffer);
855 closedir(dir);
857 /* fill with zeroes up to the end of the cluster */
858 while(s->directory.next%(0x10*s->sectors_per_cluster)) {
859 direntry = array_get_next(&(s->directory));
860 memset(direntry,0,sizeof(direntry_t));
863 if (s->fat_type != 32 &&
864 mapping_index == 0 &&
865 s->directory.next < s->root_entries) {
866 /* root directory */
867 int cur = s->directory.next;
868 array_ensure_allocated(&(s->directory), s->root_entries - 1);
869 s->directory.next = s->root_entries;
870 memset(array_get(&(s->directory), cur), 0,
871 (s->root_entries - cur) * sizeof(direntry_t));
874 /* re-get the mapping, since s->mapping was possibly realloc()ed */
875 mapping = array_get(&(s->mapping), mapping_index);
876 first_cluster += (s->directory.next - mapping->info.dir.first_dir_index)
877 * 0x20 / s->cluster_size;
878 mapping->end = first_cluster;
880 direntry = array_get(&(s->directory), mapping->dir_index);
881 set_begin_of_direntry(direntry, mapping->begin);
883 return 0;
886 static inline int32_t sector2cluster(BDRVVVFATState* s,off_t sector_num)
888 return (sector_num - s->offset_to_root_dir) / s->sectors_per_cluster;
891 static inline off_t cluster2sector(BDRVVVFATState* s, uint32_t cluster_num)
893 return s->offset_to_root_dir + s->sectors_per_cluster * cluster_num;
896 static int init_directories(BDRVVVFATState* s,
897 const char *dirname, int heads, int secs,
898 Error **errp)
900 bootsector_t* bootsector;
901 mapping_t* mapping;
902 unsigned int i;
903 unsigned int cluster;
905 memset(&(s->first_sectors[0]),0,0x40*0x200);
907 s->cluster_size=s->sectors_per_cluster*0x200;
908 s->cluster_buffer=g_malloc(s->cluster_size);
911 * The formula: sc = spf+1+spf*spc*(512*8/fat_type),
912 * where sc is sector_count,
913 * spf is sectors_per_fat,
914 * spc is sectors_per_clusters, and
915 * fat_type = 12, 16 or 32.
917 i = 1+s->sectors_per_cluster*0x200*8/s->fat_type;
918 s->sectors_per_fat=(s->sector_count+i)/i; /* round up */
920 s->offset_to_fat = s->offset_to_bootsector + 1;
921 s->offset_to_root_dir = s->offset_to_fat + s->sectors_per_fat * 2;
923 array_init(&(s->mapping),sizeof(mapping_t));
924 array_init(&(s->directory),sizeof(direntry_t));
926 /* add volume label */
928 direntry_t* entry=array_get_next(&(s->directory));
929 entry->attributes=0x28; /* archive | volume label */
930 memcpy(entry->name, s->volume_label, sizeof(entry->name));
933 /* Now build FAT, and write back information into directory */
934 init_fat(s);
936 /* TODO: if there are more entries, bootsector has to be adjusted! */
937 s->root_entries = 0x02 * 0x10 * s->sectors_per_cluster;
938 s->cluster_count=sector2cluster(s, s->sector_count);
940 mapping = array_get_next(&(s->mapping));
941 mapping->begin = 0;
942 mapping->dir_index = 0;
943 mapping->info.dir.parent_mapping_index = -1;
944 mapping->first_mapping_index = -1;
945 mapping->path = g_strdup(dirname);
946 i = strlen(mapping->path);
947 if (i > 0 && mapping->path[i - 1] == '/')
948 mapping->path[i - 1] = '\0';
949 mapping->mode = MODE_DIRECTORY;
950 mapping->read_only = 0;
951 s->path = mapping->path;
953 for (i = 0, cluster = 0; i < s->mapping.next; i++) {
954 /* MS-DOS expects the FAT to be 0 for the root directory
955 * (except for the media byte). */
956 /* LATER TODO: still true for FAT32? */
957 int fix_fat = (i != 0);
958 mapping = array_get(&(s->mapping), i);
960 if (mapping->mode & MODE_DIRECTORY) {
961 char *path = mapping->path;
962 mapping->begin = cluster;
963 if(read_directory(s, i)) {
964 error_setg(errp, "Could not read directory %s", path);
965 return -1;
967 mapping = array_get(&(s->mapping), i);
968 } else {
969 assert(mapping->mode == MODE_UNDEFINED);
970 mapping->mode=MODE_NORMAL;
971 mapping->begin = cluster;
972 if (mapping->end > 0) {
973 direntry_t* direntry = array_get(&(s->directory),
974 mapping->dir_index);
976 mapping->end = cluster + 1 + (mapping->end-1)/s->cluster_size;
977 set_begin_of_direntry(direntry, mapping->begin);
978 } else {
979 mapping->end = cluster + 1;
980 fix_fat = 0;
984 assert(mapping->begin < mapping->end);
986 /* next free cluster */
987 cluster = mapping->end;
989 if(cluster > s->cluster_count) {
990 error_setg(errp,
991 "Directory does not fit in FAT%d (capacity %.2f MB)",
992 s->fat_type, s->sector_count / 2000.0);
993 return -1;
996 /* fix fat for entry */
997 if (fix_fat) {
998 int j;
999 for(j = mapping->begin; j < mapping->end - 1; j++)
1000 fat_set(s, j, j+1);
1001 fat_set(s, mapping->end - 1, s->max_fat_value);
1005 mapping = array_get(&(s->mapping), 0);
1006 s->last_cluster_of_root_directory = mapping->end;
1008 /* the FAT signature */
1009 fat_set(s,0,s->max_fat_value);
1010 fat_set(s,1,s->max_fat_value);
1012 s->current_mapping = NULL;
1014 bootsector = (bootsector_t *)(s->first_sectors
1015 + s->offset_to_bootsector * 0x200);
1016 bootsector->jump[0]=0xeb;
1017 bootsector->jump[1]=0x3e;
1018 bootsector->jump[2]=0x90;
1019 memcpy(bootsector->name, BOOTSECTOR_OEM_NAME, 8);
1020 bootsector->sector_size=cpu_to_le16(0x200);
1021 bootsector->sectors_per_cluster=s->sectors_per_cluster;
1022 bootsector->reserved_sectors=cpu_to_le16(1);
1023 bootsector->number_of_fats=0x2; /* number of FATs */
1024 bootsector->root_entries = cpu_to_le16(s->root_entries);
1025 bootsector->total_sectors16=s->sector_count>0xffff?0:cpu_to_le16(s->sector_count);
1026 /* media descriptor: hard disk=0xf8, floppy=0xf0 */
1027 bootsector->media_type = (s->offset_to_bootsector > 0 ? 0xf8 : 0xf0);
1028 s->fat.pointer[0] = bootsector->media_type;
1029 bootsector->sectors_per_fat=cpu_to_le16(s->sectors_per_fat);
1030 bootsector->sectors_per_track = cpu_to_le16(secs);
1031 bootsector->number_of_heads = cpu_to_le16(heads);
1032 bootsector->hidden_sectors = cpu_to_le32(s->offset_to_bootsector);
1033 bootsector->total_sectors=cpu_to_le32(s->sector_count>0xffff?s->sector_count:0);
1035 /* LATER TODO: if FAT32, this is wrong */
1036 /* drive_number: fda=0, hda=0x80 */
1037 bootsector->u.fat16.drive_number = s->offset_to_bootsector == 0 ? 0 : 0x80;
1038 bootsector->u.fat16.signature=0x29;
1039 bootsector->u.fat16.id=cpu_to_le32(0xfabe1afd);
1041 memcpy(bootsector->u.fat16.volume_label, s->volume_label,
1042 sizeof(bootsector->u.fat16.volume_label));
1043 memcpy(bootsector->u.fat16.fat_type,
1044 s->fat_type == 12 ? "FAT12 " : "FAT16 ", 8);
1045 bootsector->magic[0]=0x55; bootsector->magic[1]=0xaa;
1047 return 0;
1050 #ifdef DEBUG
1051 static BDRVVVFATState *vvv = NULL;
1052 #endif
1054 static int enable_write_target(BlockDriverState *bs, Error **errp);
1055 static int coroutine_fn is_consistent(BDRVVVFATState *s);
1057 static QemuOptsList runtime_opts = {
1058 .name = "vvfat",
1059 .head = QTAILQ_HEAD_INITIALIZER(runtime_opts.head),
1060 .desc = {
1062 .name = "dir",
1063 .type = QEMU_OPT_STRING,
1064 .help = "Host directory to map to the vvfat device",
1067 .name = "fat-type",
1068 .type = QEMU_OPT_NUMBER,
1069 .help = "FAT type (12, 16 or 32)",
1072 .name = "floppy",
1073 .type = QEMU_OPT_BOOL,
1074 .help = "Create a floppy rather than a hard disk image",
1077 .name = "label",
1078 .type = QEMU_OPT_STRING,
1079 .help = "Use a volume label other than QEMU VVFAT",
1082 .name = "rw",
1083 .type = QEMU_OPT_BOOL,
1084 .help = "Make the image writable",
1086 { /* end of list */ }
1090 static void vvfat_parse_filename(const char *filename, QDict *options,
1091 Error **errp)
1093 int fat_type = 0;
1094 bool floppy = false;
1095 bool rw = false;
1096 int i;
1098 if (!strstart(filename, "fat:", NULL)) {
1099 error_setg(errp, "File name string must start with 'fat:'");
1100 return;
1103 /* Parse options */
1104 if (strstr(filename, ":32:")) {
1105 fat_type = 32;
1106 } else if (strstr(filename, ":16:")) {
1107 fat_type = 16;
1108 } else if (strstr(filename, ":12:")) {
1109 fat_type = 12;
1112 if (strstr(filename, ":floppy:")) {
1113 floppy = true;
1116 if (strstr(filename, ":rw:")) {
1117 rw = true;
1120 /* Get the directory name without options */
1121 i = strrchr(filename, ':') - filename;
1122 assert(i >= 3);
1123 if (filename[i - 2] == ':' && qemu_isalpha(filename[i - 1])) {
1124 /* workaround for DOS drive names */
1125 filename += i - 1;
1126 } else {
1127 filename += i + 1;
1130 /* Fill in the options QDict */
1131 qdict_put_str(options, "dir", filename);
1132 qdict_put_int(options, "fat-type", fat_type);
1133 qdict_put_bool(options, "floppy", floppy);
1134 qdict_put_bool(options, "rw", rw);
1137 static int vvfat_open(BlockDriverState *bs, QDict *options, int flags,
1138 Error **errp)
1140 BDRVVVFATState *s = bs->opaque;
1141 int cyls, heads, secs;
1142 bool floppy;
1143 const char *dirname, *label;
1144 QemuOpts *opts;
1145 int ret;
1147 GRAPH_RDLOCK_GUARD_MAINLOOP();
1149 #ifdef DEBUG
1150 vvv = s;
1151 #endif
1153 opts = qemu_opts_create(&runtime_opts, NULL, 0, &error_abort);
1154 if (!qemu_opts_absorb_qdict(opts, options, errp)) {
1155 ret = -EINVAL;
1156 goto fail;
1159 dirname = qemu_opt_get(opts, "dir");
1160 if (!dirname) {
1161 error_setg(errp, "vvfat block driver requires a 'dir' option");
1162 ret = -EINVAL;
1163 goto fail;
1166 s->fat_type = qemu_opt_get_number(opts, "fat-type", 0);
1167 floppy = qemu_opt_get_bool(opts, "floppy", false);
1169 memset(s->volume_label, ' ', sizeof(s->volume_label));
1170 label = qemu_opt_get(opts, "label");
1171 if (label) {
1172 size_t label_length = strlen(label);
1173 if (label_length > 11) {
1174 error_setg(errp, "vvfat label cannot be longer than 11 bytes");
1175 ret = -EINVAL;
1176 goto fail;
1178 memcpy(s->volume_label, label, label_length);
1179 } else {
1180 memcpy(s->volume_label, "QEMU VVFAT", 10);
1183 if (floppy) {
1184 /* 1.44MB or 2.88MB floppy. 2.88MB can be FAT12 (default) or FAT16. */
1185 if (!s->fat_type) {
1186 s->fat_type = 12;
1187 secs = 36;
1188 s->sectors_per_cluster = 2;
1189 } else {
1190 secs = s->fat_type == 12 ? 18 : 36;
1191 s->sectors_per_cluster = 1;
1193 cyls = 80;
1194 heads = 2;
1195 } else {
1196 /* 32MB or 504MB disk*/
1197 if (!s->fat_type) {
1198 s->fat_type = 16;
1200 s->offset_to_bootsector = 0x3f;
1201 cyls = s->fat_type == 12 ? 64 : 1024;
1202 heads = 16;
1203 secs = 63;
1206 switch (s->fat_type) {
1207 case 32:
1208 warn_report("FAT32 has not been tested. You are welcome to do so!");
1209 break;
1210 case 16:
1211 case 12:
1212 break;
1213 default:
1214 error_setg(errp, "Valid FAT types are only 12, 16 and 32");
1215 ret = -EINVAL;
1216 goto fail;
1220 s->bs = bs;
1222 /* LATER TODO: if FAT32, adjust */
1223 s->sectors_per_cluster=0x10;
1225 s->current_cluster=0xffffffff;
1227 s->qcow = NULL;
1228 s->qcow_filename = NULL;
1229 s->fat2 = NULL;
1230 s->downcase_short_names = 1;
1232 DLOG(fprintf(stderr, "vvfat %s chs %d,%d,%d\n",
1233 dirname, cyls, heads, secs));
1235 s->sector_count = cyls * heads * secs - s->offset_to_bootsector;
1236 bs->total_sectors = cyls * heads * secs;
1238 if (qemu_opt_get_bool(opts, "rw", false)) {
1239 if (!bdrv_is_read_only(bs)) {
1240 ret = enable_write_target(bs, errp);
1241 if (ret < 0) {
1242 goto fail;
1244 } else {
1245 ret = -EPERM;
1246 error_setg(errp,
1247 "Unable to set VVFAT to 'rw' when drive is read-only");
1248 goto fail;
1250 } else {
1251 ret = bdrv_apply_auto_read_only(bs, NULL, errp);
1252 if (ret < 0) {
1253 goto fail;
1257 if (init_directories(s, dirname, heads, secs, errp)) {
1258 ret = -EIO;
1259 goto fail;
1262 s->sector_count = s->offset_to_root_dir
1263 + s->sectors_per_cluster * s->cluster_count;
1265 /* Disable migration when vvfat is used rw */
1266 if (s->qcow) {
1267 error_setg(&s->migration_blocker,
1268 "The vvfat (rw) format used by node '%s' "
1269 "does not support live migration",
1270 bdrv_get_device_or_node_name(bs));
1271 ret = migrate_add_blocker_normal(&s->migration_blocker, errp);
1272 if (ret < 0) {
1273 goto fail;
1277 if (s->offset_to_bootsector > 0) {
1278 init_mbr(s, cyls, heads, secs);
1281 qemu_co_mutex_init(&s->lock);
1283 qemu_opts_del(opts);
1285 return 0;
1287 fail:
1288 g_free(s->qcow_filename);
1289 s->qcow_filename = NULL;
1290 g_free(s->cluster_buffer);
1291 s->cluster_buffer = NULL;
1292 g_free(s->used_clusters);
1293 s->used_clusters = NULL;
1295 qemu_opts_del(opts);
1296 return ret;
1299 static void vvfat_refresh_limits(BlockDriverState *bs, Error **errp)
1301 bs->bl.request_alignment = BDRV_SECTOR_SIZE; /* No sub-sector I/O */
1304 static inline void vvfat_close_current_file(BDRVVVFATState *s)
1306 if(s->current_mapping) {
1307 s->current_mapping = NULL;
1308 if (s->current_fd) {
1309 qemu_close(s->current_fd);
1310 s->current_fd = 0;
1313 s->current_cluster = -1;
1316 /* mappings between index1 and index2-1 are supposed to be ordered
1317 * return value is the index of the last mapping for which end>cluster_num
1319 static inline int find_mapping_for_cluster_aux(BDRVVVFATState* s,int cluster_num,int index1,int index2)
1321 while(1) {
1322 int index3;
1323 mapping_t* mapping;
1324 index3=(index1+index2)/2;
1325 mapping=array_get(&(s->mapping),index3);
1326 assert(mapping->begin < mapping->end);
1327 if(mapping->begin>=cluster_num) {
1328 assert(index2!=index3 || index2==0);
1329 if(index2==index3)
1330 return index1;
1331 index2=index3;
1332 } else {
1333 if(index1==index3)
1334 return mapping->end<=cluster_num ? index2 : index1;
1335 index1=index3;
1337 assert(index1<=index2);
1338 DLOG(mapping=array_get(&(s->mapping),index1);
1339 assert(mapping->begin<=cluster_num);
1340 assert(index2 >= s->mapping.next ||
1341 ((mapping = array_get(&(s->mapping),index2)) &&
1342 mapping->end>cluster_num)));
1346 static inline mapping_t* find_mapping_for_cluster(BDRVVVFATState* s,int cluster_num)
1348 int index=find_mapping_for_cluster_aux(s,cluster_num,0,s->mapping.next);
1349 mapping_t* mapping;
1350 if(index>=s->mapping.next)
1351 return NULL;
1352 mapping=array_get(&(s->mapping),index);
1353 if(mapping->begin>cluster_num)
1354 return NULL;
1355 assert(mapping->begin<=cluster_num && mapping->end>cluster_num);
1356 return mapping;
1359 static int open_file(BDRVVVFATState* s,mapping_t* mapping)
1361 if(!mapping)
1362 return -1;
1363 if(!s->current_mapping ||
1364 strcmp(s->current_mapping->path,mapping->path)) {
1365 /* open file */
1366 int fd = qemu_open_old(mapping->path,
1367 O_RDONLY | O_BINARY | O_LARGEFILE);
1368 if(fd<0)
1369 return -1;
1370 vvfat_close_current_file(s);
1371 s->current_fd = fd;
1372 s->current_mapping = mapping;
1374 return 0;
1377 static inline int read_cluster(BDRVVVFATState *s,int cluster_num)
1379 if(s->current_cluster != cluster_num) {
1380 int result=0;
1381 off_t offset;
1382 assert(!s->current_mapping || s->current_fd || (s->current_mapping->mode & MODE_DIRECTORY));
1383 if(!s->current_mapping
1384 || s->current_mapping->begin>cluster_num
1385 || s->current_mapping->end<=cluster_num) {
1386 /* binary search of mappings for file */
1387 mapping_t* mapping=find_mapping_for_cluster(s,cluster_num);
1389 assert(!mapping || (cluster_num>=mapping->begin && cluster_num<mapping->end));
1391 if (mapping && mapping->mode & MODE_DIRECTORY) {
1392 vvfat_close_current_file(s);
1393 s->current_mapping = mapping;
1394 read_cluster_directory:
1395 offset = s->cluster_size*(cluster_num-s->current_mapping->begin);
1396 s->cluster = (unsigned char*)s->directory.pointer+offset
1397 + 0x20*s->current_mapping->info.dir.first_dir_index;
1398 assert(((s->cluster-(unsigned char*)s->directory.pointer)%s->cluster_size)==0);
1399 assert((char*)s->cluster+s->cluster_size <= s->directory.pointer+s->directory.next*s->directory.item_size);
1400 s->current_cluster = cluster_num;
1401 return 0;
1404 if(open_file(s,mapping))
1405 return -2;
1406 } else if (s->current_mapping->mode & MODE_DIRECTORY)
1407 goto read_cluster_directory;
1409 assert(s->current_fd);
1411 offset=s->cluster_size*(cluster_num-s->current_mapping->begin)+s->current_mapping->info.file.offset;
1412 if(lseek(s->current_fd, offset, SEEK_SET)!=offset)
1413 return -3;
1414 s->cluster=s->cluster_buffer;
1415 result=read(s->current_fd,s->cluster,s->cluster_size);
1416 if(result<0) {
1417 s->current_cluster = -1;
1418 return -1;
1420 s->current_cluster = cluster_num;
1422 return 0;
1425 #ifdef DEBUG
1426 static void print_direntry(const direntry_t* direntry)
1428 int j = 0;
1429 char buffer[1024];
1431 fprintf(stderr, "direntry %p: ", direntry);
1432 if(!direntry)
1433 return;
1434 if(is_long_name(direntry)) {
1435 unsigned char* c=(unsigned char*)direntry;
1436 int i;
1437 for(i=1;i<11 && c[i] && c[i]!=0xff;i+=2)
1438 #define ADD_CHAR(c) {buffer[j] = (c); if (buffer[j] < ' ') buffer[j] = 0xb0; j++;}
1439 ADD_CHAR(c[i]);
1440 for(i=14;i<26 && c[i] && c[i]!=0xff;i+=2)
1441 ADD_CHAR(c[i]);
1442 for(i=28;i<32 && c[i] && c[i]!=0xff;i+=2)
1443 ADD_CHAR(c[i]);
1444 buffer[j] = 0;
1445 fprintf(stderr, "%s\n", buffer);
1446 } else {
1447 int i;
1448 for(i=0;i<11;i++)
1449 ADD_CHAR(direntry->name[i]);
1450 buffer[j] = 0;
1451 fprintf(stderr, "%s attributes=0x%02x begin=%u size=%u\n",
1452 buffer,
1453 direntry->attributes,
1454 begin_of_direntry(direntry),le32_to_cpu(direntry->size));
1458 static void print_mapping(const mapping_t* mapping)
1460 fprintf(stderr, "mapping (%p): begin, end = %u, %u, dir_index = %u, "
1461 "first_mapping_index = %d, name = %s, mode = 0x%x, " ,
1462 mapping, mapping->begin, mapping->end, mapping->dir_index,
1463 mapping->first_mapping_index, mapping->path, mapping->mode);
1465 if (mapping->mode & MODE_DIRECTORY)
1466 fprintf(stderr, "parent_mapping_index = %d, first_dir_index = %d\n", mapping->info.dir.parent_mapping_index, mapping->info.dir.first_dir_index);
1467 else
1468 fprintf(stderr, "offset = %u\n", mapping->info.file.offset);
1470 #endif
1472 static int coroutine_fn GRAPH_RDLOCK
1473 vvfat_read(BlockDriverState *bs, int64_t sector_num, uint8_t *buf, int nb_sectors)
1475 BDRVVVFATState *s = bs->opaque;
1476 int i;
1478 for(i=0;i<nb_sectors;i++,sector_num++) {
1479 if (sector_num >= bs->total_sectors)
1480 return -1;
1481 if (s->qcow) {
1482 int64_t n;
1483 int ret;
1484 ret = bdrv_co_is_allocated(s->qcow->bs, sector_num * BDRV_SECTOR_SIZE,
1485 (nb_sectors - i) * BDRV_SECTOR_SIZE, &n);
1486 if (ret < 0) {
1487 return ret;
1489 if (ret) {
1490 DLOG(fprintf(stderr, "sectors %" PRId64 "+%" PRId64
1491 " allocated\n", sector_num,
1492 n >> BDRV_SECTOR_BITS));
1493 if (bdrv_co_pread(s->qcow, sector_num * BDRV_SECTOR_SIZE, n,
1494 buf + i * 0x200, 0) < 0) {
1495 return -1;
1497 i += (n >> BDRV_SECTOR_BITS) - 1;
1498 sector_num += (n >> BDRV_SECTOR_BITS) - 1;
1499 continue;
1501 DLOG(fprintf(stderr, "sector %" PRId64 " not allocated\n",
1502 sector_num));
1504 if (sector_num < s->offset_to_root_dir) {
1505 if (sector_num < s->offset_to_fat) {
1506 memcpy(buf + i * 0x200,
1507 &(s->first_sectors[sector_num * 0x200]),
1508 0x200);
1509 } else if (sector_num < s->offset_to_fat + s->sectors_per_fat) {
1510 memcpy(buf + i * 0x200,
1511 &(s->fat.pointer[(sector_num
1512 - s->offset_to_fat) * 0x200]),
1513 0x200);
1514 } else if (sector_num < s->offset_to_root_dir) {
1515 memcpy(buf + i * 0x200,
1516 &(s->fat.pointer[(sector_num - s->offset_to_fat
1517 - s->sectors_per_fat) * 0x200]),
1518 0x200);
1520 } else {
1521 uint32_t sector = sector_num - s->offset_to_root_dir,
1522 sector_offset_in_cluster=(sector%s->sectors_per_cluster),
1523 cluster_num=sector/s->sectors_per_cluster;
1524 if(cluster_num > s->cluster_count || read_cluster(s, cluster_num) != 0) {
1525 /* LATER TODO: strict: return -1; */
1526 memset(buf+i*0x200,0,0x200);
1527 continue;
1529 memcpy(buf+i*0x200,s->cluster+sector_offset_in_cluster*0x200,0x200);
1532 return 0;
1535 static int coroutine_fn GRAPH_RDLOCK
1536 vvfat_co_preadv(BlockDriverState *bs, int64_t offset, int64_t bytes,
1537 QEMUIOVector *qiov, BdrvRequestFlags flags)
1539 int ret;
1540 BDRVVVFATState *s = bs->opaque;
1541 uint64_t sector_num = offset >> BDRV_SECTOR_BITS;
1542 int nb_sectors = bytes >> BDRV_SECTOR_BITS;
1543 void *buf;
1545 assert(QEMU_IS_ALIGNED(offset, BDRV_SECTOR_SIZE));
1546 assert(QEMU_IS_ALIGNED(bytes, BDRV_SECTOR_SIZE));
1548 buf = g_try_malloc(bytes);
1549 if (bytes && buf == NULL) {
1550 return -ENOMEM;
1553 qemu_co_mutex_lock(&s->lock);
1554 ret = vvfat_read(bs, sector_num, buf, nb_sectors);
1555 qemu_co_mutex_unlock(&s->lock);
1557 qemu_iovec_from_buf(qiov, 0, buf, bytes);
1558 g_free(buf);
1560 return ret;
1563 /* LATER TODO: statify all functions */
1566 * Idea of the write support (use snapshot):
1568 * 1. check if all data is consistent, recording renames, modifications,
1569 * new files and directories (in s->commits).
1571 * 2. if the data is not consistent, stop committing
1573 * 3. handle renames, and create new files and directories (do not yet
1574 * write their contents)
1576 * 4. walk the directories, fixing the mapping and direntries, and marking
1577 * the handled mappings as not deleted
1579 * 5. commit the contents of the files
1581 * 6. handle deleted files and directories
1585 typedef struct commit_t {
1586 char* path;
1587 union {
1588 struct { uint32_t cluster; } rename;
1589 struct { int dir_index; uint32_t modified_offset; } writeout;
1590 struct { uint32_t first_cluster; } new_file;
1591 struct { uint32_t cluster; } mkdir;
1592 } param;
1593 /* DELETEs and RMDIRs are handled differently: see handle_deletes() */
1594 enum {
1595 ACTION_RENAME, ACTION_WRITEOUT, ACTION_NEW_FILE, ACTION_MKDIR
1596 } action;
1597 } commit_t;
1599 static void clear_commits(BDRVVVFATState* s)
1601 int i;
1602 DLOG(fprintf(stderr, "clear_commits (%u commits)\n", s->commits.next));
1603 for (i = 0; i < s->commits.next; i++) {
1604 commit_t* commit = array_get(&(s->commits), i);
1605 assert(commit->path || commit->action == ACTION_WRITEOUT);
1606 if (commit->action != ACTION_WRITEOUT) {
1607 assert(commit->path);
1608 g_free(commit->path);
1609 } else
1610 assert(commit->path == NULL);
1612 s->commits.next = 0;
1615 static void schedule_rename(BDRVVVFATState* s,
1616 uint32_t cluster, char* new_path)
1618 commit_t* commit = array_get_next(&(s->commits));
1619 commit->path = new_path;
1620 commit->param.rename.cluster = cluster;
1621 commit->action = ACTION_RENAME;
1624 static void schedule_writeout(BDRVVVFATState* s,
1625 int dir_index, uint32_t modified_offset)
1627 commit_t* commit = array_get_next(&(s->commits));
1628 commit->path = NULL;
1629 commit->param.writeout.dir_index = dir_index;
1630 commit->param.writeout.modified_offset = modified_offset;
1631 commit->action = ACTION_WRITEOUT;
1634 static void schedule_new_file(BDRVVVFATState* s,
1635 char* path, uint32_t first_cluster)
1637 commit_t* commit = array_get_next(&(s->commits));
1638 commit->path = path;
1639 commit->param.new_file.first_cluster = first_cluster;
1640 commit->action = ACTION_NEW_FILE;
1643 static void schedule_mkdir(BDRVVVFATState* s, uint32_t cluster, char* path)
1645 commit_t* commit = array_get_next(&(s->commits));
1646 commit->path = path;
1647 commit->param.mkdir.cluster = cluster;
1648 commit->action = ACTION_MKDIR;
1651 typedef struct {
1653 * Since the sequence number is at most 0x3f, and the filename
1654 * length is at most 13 times the sequence number, the maximal
1655 * filename length is 0x3f * 13 bytes.
1657 unsigned char name[0x3f * 13 + 1];
1658 gunichar2 name2[0x3f * 13 + 1];
1659 int checksum, len;
1660 int sequence_number;
1661 } long_file_name;
1663 static void lfn_init(long_file_name* lfn)
1665 lfn->sequence_number = lfn->len = 0;
1666 lfn->checksum = 0x100;
1669 /* return 0 if parsed successfully, > 0 if no long name, < 0 if error */
1670 static int parse_long_name(long_file_name* lfn,
1671 const direntry_t* direntry)
1673 int i, j, offset;
1674 const unsigned char* pointer = (const unsigned char*)direntry;
1676 if (!is_long_name(direntry))
1677 return 1;
1679 if (pointer[0] & 0x40) {
1680 /* first entry; do some initialization */
1681 lfn->sequence_number = pointer[0] & 0x3f;
1682 lfn->checksum = pointer[13];
1683 lfn->name[0] = 0;
1684 lfn->name[lfn->sequence_number * 13] = 0;
1685 } else if ((pointer[0] & 0x3f) != --lfn->sequence_number) {
1686 /* not the expected sequence number */
1687 return -1;
1688 } else if (pointer[13] != lfn->checksum) {
1689 /* not the expected checksum */
1690 return -2;
1691 } else if (pointer[12] || pointer[26] || pointer[27]) {
1692 /* invalid zero fields */
1693 return -3;
1696 offset = 13 * (lfn->sequence_number - 1);
1697 for (i = 0, j = 1; i < 13; i++, j+=2) {
1698 if (j == 11)
1699 j = 14;
1700 else if (j == 26)
1701 j = 28;
1703 if (pointer[j] == 0 && pointer[j + 1] == 0) {
1704 /* end of long file name */
1705 break;
1707 gunichar2 c = (pointer[j + 1] << 8) + pointer[j];
1708 lfn->name2[offset + i] = c;
1711 if (pointer[0] & 0x40) {
1712 /* first entry; set len */
1713 lfn->len = offset + i;
1715 if ((pointer[0] & 0x3f) == 0x01) {
1716 /* last entry; finalize entry */
1717 glong olen;
1718 gchar *utf8 = g_utf16_to_utf8(lfn->name2, lfn->len, NULL, &olen, NULL);
1719 if (!utf8) {
1720 return -4;
1722 lfn->len = olen;
1723 memcpy(lfn->name, utf8, olen + 1);
1724 g_free(utf8);
1727 return 0;
1730 /* returns 0 if successful, >0 if no short_name, and <0 on error */
1731 static int parse_short_name(BDRVVVFATState* s,
1732 long_file_name* lfn, direntry_t* direntry)
1734 int i, j;
1736 if (!is_short_name(direntry))
1737 return 1;
1739 for (j = 7; j >= 0 && direntry->name[j] == ' '; j--);
1740 for (i = 0; i <= j; i++) {
1741 uint8_t c = direntry->name[i];
1742 if (c != to_valid_short_char(c)) {
1743 return -1;
1744 } else if (s->downcase_short_names) {
1745 lfn->name[i] = qemu_tolower(direntry->name[i]);
1746 } else {
1747 lfn->name[i] = direntry->name[i];
1751 for (j = 2; j >= 0 && direntry->name[8 + j] == ' '; j--) {
1753 if (j >= 0) {
1754 lfn->name[i++] = '.';
1755 lfn->name[i + j + 1] = '\0';
1756 for (;j >= 0; j--) {
1757 uint8_t c = direntry->name[8 + j];
1758 if (c != to_valid_short_char(c)) {
1759 return -2;
1760 } else if (s->downcase_short_names) {
1761 lfn->name[i + j] = qemu_tolower(c);
1762 } else {
1763 lfn->name[i + j] = c;
1766 } else
1767 lfn->name[i + j + 1] = '\0';
1769 if (lfn->name[0] == DIR_KANJI_FAKE) {
1770 lfn->name[0] = DIR_KANJI;
1772 lfn->len = strlen((char*)lfn->name);
1774 return 0;
1777 static inline uint32_t modified_fat_get(BDRVVVFATState* s,
1778 unsigned int cluster)
1780 if (cluster < s->last_cluster_of_root_directory) {
1781 if (cluster + 1 == s->last_cluster_of_root_directory)
1782 return s->max_fat_value;
1783 else
1784 return cluster + 1;
1787 if (s->fat_type==32) {
1788 uint32_t* entry=((uint32_t*)s->fat2)+cluster;
1789 return le32_to_cpu(*entry);
1790 } else if (s->fat_type==16) {
1791 uint16_t* entry=((uint16_t*)s->fat2)+cluster;
1792 return le16_to_cpu(*entry);
1793 } else {
1794 const uint8_t* x=s->fat2+cluster*3/2;
1795 return ((x[0]|(x[1]<<8))>>(cluster&1?4:0))&0x0fff;
1799 static inline bool coroutine_fn GRAPH_RDLOCK
1800 cluster_was_modified(BDRVVVFATState *s, uint32_t cluster_num)
1802 int was_modified = 0;
1803 int i;
1805 if (s->qcow == NULL) {
1806 return 0;
1809 for (i = 0; !was_modified && i < s->sectors_per_cluster; i++) {
1810 was_modified = bdrv_co_is_allocated(s->qcow->bs,
1811 (cluster2sector(s, cluster_num) +
1812 i) * BDRV_SECTOR_SIZE,
1813 BDRV_SECTOR_SIZE, NULL);
1817 * Note that this treats failures to learn allocation status the
1818 * same as if an allocation has occurred. It's as safe as
1819 * anything else, given that a failure to learn allocation status
1820 * will probably result in more failures.
1822 return !!was_modified;
1825 static const char* get_basename(const char* path)
1827 char* basename = strrchr(path, '/');
1828 if (basename == NULL)
1829 return path;
1830 else
1831 return basename + 1; /* strip '/' */
1835 * The array s->used_clusters holds the states of the clusters. If it is
1836 * part of a file, it has bit 2 set, in case of a directory, bit 1. If it
1837 * was modified, bit 3 is set.
1838 * If any cluster is allocated, but not part of a file or directory, this
1839 * driver refuses to commit.
1841 typedef enum {
1842 USED_DIRECTORY = 1, USED_FILE = 2, USED_ANY = 3, USED_ALLOCATED = 4
1843 } used_t;
1846 * get_cluster_count_for_direntry() not only determines how many clusters
1847 * are occupied by direntry, but also if it was renamed or modified.
1849 * A file is thought to be renamed *only* if there already was a file with
1850 * exactly the same first cluster, but a different name.
1852 * Further, the files/directories handled by this function are
1853 * assumed to be *not* deleted (and *only* those).
1855 static uint32_t coroutine_fn GRAPH_RDLOCK
1856 get_cluster_count_for_direntry(BDRVVVFATState* s, direntry_t* direntry, const char* path)
1859 * This is a little bit tricky:
1860 * IF the guest OS just inserts a cluster into the file chain,
1861 * and leaves the rest alone, (i.e. the original file had clusters
1862 * 15 -> 16, but now has 15 -> 32 -> 16), then the following happens:
1864 * - do_commit will write the cluster into the file at the given
1865 * offset, but
1867 * - the cluster which is overwritten should be moved to a later
1868 * position in the file.
1870 * I am not aware that any OS does something as braindead, but this
1871 * situation could happen anyway when not committing for a long time.
1872 * Just to be sure that this does not bite us, detect it, and copy the
1873 * contents of the clusters to-be-overwritten into the qcow.
1875 int copy_it = 0;
1876 int was_modified = 0;
1877 int32_t ret = 0;
1879 uint32_t cluster_num = begin_of_direntry(direntry);
1880 uint32_t offset = 0;
1881 int first_mapping_index = -1;
1882 mapping_t* mapping = NULL;
1883 const char* basename2 = NULL;
1885 vvfat_close_current_file(s);
1887 /* the root directory */
1888 if (cluster_num == 0)
1889 return 0;
1891 /* write support */
1892 if (s->qcow) {
1893 basename2 = get_basename(path);
1895 mapping = find_mapping_for_cluster(s, cluster_num);
1897 if (mapping) {
1898 const char* basename;
1900 assert(mapping->mode & MODE_DELETED);
1901 mapping->mode &= ~MODE_DELETED;
1903 basename = get_basename(mapping->path);
1905 assert(mapping->mode & MODE_NORMAL);
1907 /* rename */
1908 if (strcmp(basename, basename2))
1909 schedule_rename(s, cluster_num, g_strdup(path));
1910 } else if (is_file(direntry))
1911 /* new file */
1912 schedule_new_file(s, g_strdup(path), cluster_num);
1913 else {
1914 abort();
1915 return 0;
1919 while(1) {
1920 if (s->qcow) {
1921 if (!copy_it && cluster_was_modified(s, cluster_num)) {
1922 if (mapping == NULL ||
1923 mapping->begin > cluster_num ||
1924 mapping->end <= cluster_num)
1925 mapping = find_mapping_for_cluster(s, cluster_num);
1928 if (mapping &&
1929 (mapping->mode & MODE_DIRECTORY) == 0) {
1931 /* was modified in qcow */
1932 if (offset != mapping->info.file.offset + s->cluster_size
1933 * (cluster_num - mapping->begin)) {
1934 /* offset of this cluster in file chain has changed */
1935 abort();
1936 copy_it = 1;
1937 } else if (offset == 0) {
1938 const char* basename = get_basename(mapping->path);
1940 if (strcmp(basename, basename2))
1941 copy_it = 1;
1942 first_mapping_index = array_index(&(s->mapping), mapping);
1945 if (mapping->first_mapping_index != first_mapping_index
1946 && mapping->info.file.offset > 0) {
1947 abort();
1948 copy_it = 1;
1951 /* need to write out? */
1952 if (!was_modified && is_file(direntry)) {
1953 was_modified = 1;
1954 schedule_writeout(s, mapping->dir_index, offset);
1959 if (copy_it) {
1960 int i;
1962 * This is horribly inefficient, but that is okay, since
1963 * it is rarely executed, if at all.
1965 int64_t offs = cluster2sector(s, cluster_num);
1967 vvfat_close_current_file(s);
1968 for (i = 0; i < s->sectors_per_cluster; i++) {
1969 int res;
1971 res = bdrv_co_is_allocated(s->qcow->bs,
1972 (offs + i) * BDRV_SECTOR_SIZE,
1973 BDRV_SECTOR_SIZE, NULL);
1974 if (res < 0) {
1975 return -1;
1977 if (!res) {
1978 res = vvfat_read(s->bs, offs, s->cluster_buffer, 1);
1979 if (res) {
1980 return -1;
1982 res = bdrv_co_pwrite(s->qcow, offs * BDRV_SECTOR_SIZE,
1983 BDRV_SECTOR_SIZE, s->cluster_buffer,
1985 if (res < 0) {
1986 return -2;
1993 ret++;
1994 if (s->used_clusters[cluster_num] & USED_ANY)
1995 return 0;
1996 s->used_clusters[cluster_num] = USED_FILE;
1998 cluster_num = modified_fat_get(s, cluster_num);
2000 if (fat_eof(s, cluster_num))
2001 return ret;
2002 else if (cluster_num < 2 || cluster_num > s->max_fat_value - 16)
2003 return -1;
2005 offset += s->cluster_size;
2010 * This function looks at the modified data (qcow).
2011 * It returns 0 upon inconsistency or error, and the number of clusters
2012 * used by the directory, its subdirectories and their files.
2014 static int coroutine_fn GRAPH_RDLOCK
2015 check_directory_consistency(BDRVVVFATState *s, int cluster_num, const char* path)
2017 int ret = 0;
2018 unsigned char* cluster = g_malloc(s->cluster_size);
2019 direntry_t* direntries = (direntry_t*)cluster;
2020 mapping_t* mapping = find_mapping_for_cluster(s, cluster_num);
2022 long_file_name lfn;
2023 int path_len = strlen(path);
2024 char path2[PATH_MAX + 1];
2026 assert(path_len < PATH_MAX); /* len was tested before! */
2027 pstrcpy(path2, sizeof(path2), path);
2028 path2[path_len] = '/';
2029 path2[path_len + 1] = '\0';
2031 if (mapping) {
2032 const char* basename = get_basename(mapping->path);
2033 const char* basename2 = get_basename(path);
2035 assert(mapping->mode & MODE_DIRECTORY);
2037 assert(mapping->mode & MODE_DELETED);
2038 mapping->mode &= ~MODE_DELETED;
2040 if (strcmp(basename, basename2))
2041 schedule_rename(s, cluster_num, g_strdup(path));
2042 } else
2043 /* new directory */
2044 schedule_mkdir(s, cluster_num, g_strdup(path));
2046 lfn_init(&lfn);
2047 do {
2048 int i;
2049 int subret = 0;
2051 ret++;
2053 if (s->used_clusters[cluster_num] & USED_ANY) {
2054 fprintf(stderr, "cluster %d used more than once\n", (int)cluster_num);
2055 goto fail;
2057 s->used_clusters[cluster_num] = USED_DIRECTORY;
2059 DLOG(fprintf(stderr, "read cluster %d (sector %d)\n", (int)cluster_num, (int)cluster2sector(s, cluster_num)));
2060 subret = vvfat_read(s->bs, cluster2sector(s, cluster_num), cluster,
2061 s->sectors_per_cluster);
2062 if (subret) {
2063 fprintf(stderr, "Error fetching direntries\n");
2064 fail:
2065 g_free(cluster);
2066 return 0;
2069 for (i = 0; i < 0x10 * s->sectors_per_cluster; i++) {
2070 int cluster_count = 0;
2072 DLOG(fprintf(stderr, "check direntry %d:\n", i); print_direntry(direntries + i));
2073 if (is_volume_label(direntries + i) || is_dot(direntries + i) ||
2074 is_free(direntries + i))
2075 continue;
2077 subret = parse_long_name(&lfn, direntries + i);
2078 if (subret < 0) {
2079 fprintf(stderr, "Error in long name\n");
2080 goto fail;
2082 if (subret == 0 || is_free(direntries + i))
2083 continue;
2085 if (fat_chksum(direntries+i) != lfn.checksum) {
2086 subret = parse_short_name(s, &lfn, direntries + i);
2087 if (subret < 0) {
2088 fprintf(stderr, "Error in short name (%d)\n", subret);
2089 goto fail;
2091 if (subret > 0 || !strcmp((char*)lfn.name, ".")
2092 || !strcmp((char*)lfn.name, ".."))
2093 continue;
2095 lfn.checksum = 0x100; /* cannot use long name twice */
2097 if (!valid_filename(lfn.name)) {
2098 fprintf(stderr, "Invalid file name\n");
2099 goto fail;
2101 if (path_len + 1 + lfn.len >= PATH_MAX) {
2102 fprintf(stderr, "Name too long: %s/%s\n", path, lfn.name);
2103 goto fail;
2105 pstrcpy(path2 + path_len + 1, sizeof(path2) - path_len - 1,
2106 (char*)lfn.name);
2108 if (is_directory(direntries + i)) {
2109 if (begin_of_direntry(direntries + i) == 0) {
2110 DLOG(fprintf(stderr, "invalid begin for directory: %s\n", path2); print_direntry(direntries + i));
2111 goto fail;
2113 cluster_count = check_directory_consistency(s,
2114 begin_of_direntry(direntries + i), path2);
2115 if (cluster_count == 0) {
2116 DLOG(fprintf(stderr, "problem in directory %s:\n", path2); print_direntry(direntries + i));
2117 goto fail;
2119 } else if (is_file(direntries + i)) {
2120 /* check file size with FAT */
2121 cluster_count = get_cluster_count_for_direntry(s, direntries + i, path2);
2122 if (cluster_count !=
2123 DIV_ROUND_UP(le32_to_cpu(direntries[i].size), s->cluster_size)) {
2124 DLOG(fprintf(stderr, "Cluster count mismatch\n"));
2125 goto fail;
2127 } else
2128 abort(); /* cluster_count = 0; */
2130 ret += cluster_count;
2133 cluster_num = modified_fat_get(s, cluster_num);
2134 } while(!fat_eof(s, cluster_num));
2136 g_free(cluster);
2137 return ret;
2140 /* returns 1 on success */
2141 static int coroutine_fn GRAPH_RDLOCK
2142 is_consistent(BDRVVVFATState* s)
2144 int i, check;
2145 int used_clusters_count = 0;
2147 DLOG(checkpoint());
2149 * - get modified FAT
2150 * - compare the two FATs (TODO)
2151 * - get buffer for marking used clusters
2152 * - recurse direntries from root (using bs->bdrv_pread to make
2153 * sure to get the new data)
2154 * - check that the FAT agrees with the size
2155 * - count the number of clusters occupied by this directory and
2156 * its files
2157 * - check that the cumulative used cluster count agrees with the
2158 * FAT
2159 * - if all is fine, return number of used clusters
2161 if (s->fat2 == NULL) {
2162 int size = 0x200 * s->sectors_per_fat;
2163 s->fat2 = g_malloc(size);
2164 memcpy(s->fat2, s->fat.pointer, size);
2166 check = vvfat_read(s->bs,
2167 s->offset_to_fat, s->fat2, s->sectors_per_fat);
2168 if (check) {
2169 fprintf(stderr, "Could not copy fat\n");
2170 return 0;
2172 assert (s->used_clusters);
2173 for (i = 0; i < sector2cluster(s, s->sector_count); i++)
2174 s->used_clusters[i] &= ~USED_ANY;
2176 clear_commits(s);
2178 /* mark every mapped file/directory as deleted.
2179 * (check_directory_consistency() will unmark those still present). */
2180 if (s->qcow)
2181 for (i = 0; i < s->mapping.next; i++) {
2182 mapping_t* mapping = array_get(&(s->mapping), i);
2183 if (mapping->first_mapping_index < 0)
2184 mapping->mode |= MODE_DELETED;
2187 used_clusters_count = check_directory_consistency(s, 0, s->path);
2188 if (used_clusters_count <= 0) {
2189 DLOG(fprintf(stderr, "problem in directory\n"));
2190 return 0;
2193 check = s->last_cluster_of_root_directory;
2194 for (i = check; i < sector2cluster(s, s->sector_count); i++) {
2195 if (modified_fat_get(s, i)) {
2196 if(!s->used_clusters[i]) {
2197 DLOG(fprintf(stderr, "FAT was modified (%d), but cluster is not used?\n", i));
2198 return 0;
2200 check++;
2203 if (s->used_clusters[i] == USED_ALLOCATED) {
2204 /* allocated, but not used... */
2205 DLOG(fprintf(stderr, "unused, modified cluster: %d\n", i));
2206 return 0;
2210 if (check != used_clusters_count)
2211 return 0;
2213 return used_clusters_count;
2216 static inline void adjust_mapping_indices(BDRVVVFATState* s,
2217 int offset, int adjust)
2219 int i;
2221 for (i = 0; i < s->mapping.next; i++) {
2222 mapping_t* mapping = array_get(&(s->mapping), i);
2224 #define ADJUST_MAPPING_INDEX(name) \
2225 if (mapping->name >= offset) \
2226 mapping->name += adjust
2228 ADJUST_MAPPING_INDEX(first_mapping_index);
2229 if (mapping->mode & MODE_DIRECTORY)
2230 ADJUST_MAPPING_INDEX(info.dir.parent_mapping_index);
2234 /* insert or update mapping */
2235 static mapping_t* insert_mapping(BDRVVVFATState* s,
2236 uint32_t begin, uint32_t end)
2239 * - find mapping where mapping->begin >= begin,
2240 * - if mapping->begin > begin: insert
2241 * - adjust all references to mappings!
2242 * - else: adjust
2243 * - replace name
2245 int index = find_mapping_for_cluster_aux(s, begin, 0, s->mapping.next);
2246 mapping_t* mapping = NULL;
2247 mapping_t* first_mapping = array_get(&(s->mapping), 0);
2249 if (index < s->mapping.next && (mapping = array_get(&(s->mapping), index))
2250 && mapping->begin < begin) {
2251 mapping->end = begin;
2252 index++;
2253 mapping = array_get(&(s->mapping), index);
2255 if (index >= s->mapping.next || mapping->begin > begin) {
2256 mapping = array_insert(&(s->mapping), index, 1);
2257 mapping->path = NULL;
2258 adjust_mapping_indices(s, index, +1);
2261 mapping->begin = begin;
2262 mapping->end = end;
2264 DLOG(mapping_t* next_mapping;
2265 assert(index + 1 >= s->mapping.next ||
2266 ((next_mapping = array_get(&(s->mapping), index + 1)) &&
2267 next_mapping->begin >= end)));
2269 if (s->current_mapping && first_mapping != (mapping_t*)s->mapping.pointer)
2270 s->current_mapping = array_get(&(s->mapping),
2271 s->current_mapping - first_mapping);
2273 return mapping;
2276 static int remove_mapping(BDRVVVFATState* s, int mapping_index)
2278 mapping_t* mapping = array_get(&(s->mapping), mapping_index);
2279 mapping_t* first_mapping = array_get(&(s->mapping), 0);
2281 /* free mapping */
2282 if (mapping->first_mapping_index < 0) {
2283 g_free(mapping->path);
2286 /* remove from s->mapping */
2287 array_remove(&(s->mapping), mapping_index);
2289 /* adjust all references to mappings */
2290 adjust_mapping_indices(s, mapping_index, -1);
2292 if (s->current_mapping && first_mapping != (mapping_t*)s->mapping.pointer)
2293 s->current_mapping = array_get(&(s->mapping),
2294 s->current_mapping - first_mapping);
2296 return 0;
2299 static void adjust_dirindices(BDRVVVFATState* s, int offset, int adjust)
2301 int i;
2302 for (i = 0; i < s->mapping.next; i++) {
2303 mapping_t* mapping = array_get(&(s->mapping), i);
2304 if (mapping->dir_index >= offset)
2305 mapping->dir_index += adjust;
2306 if ((mapping->mode & MODE_DIRECTORY) &&
2307 mapping->info.dir.first_dir_index >= offset)
2308 mapping->info.dir.first_dir_index += adjust;
2312 static direntry_t* insert_direntries(BDRVVVFATState* s,
2313 int dir_index, int count)
2316 * make room in s->directory,
2317 * adjust_dirindices
2319 direntry_t* result = array_insert(&(s->directory), dir_index, count);
2320 if (result == NULL)
2321 return NULL;
2322 adjust_dirindices(s, dir_index, count);
2323 return result;
2326 static int remove_direntries(BDRVVVFATState* s, int dir_index, int count)
2328 int ret = array_remove_slice(&(s->directory), dir_index, count);
2329 if (ret)
2330 return ret;
2331 adjust_dirindices(s, dir_index, -count);
2332 return 0;
2336 * Adapt the mappings of the cluster chain starting at first cluster
2337 * (i.e. if a file starts at first_cluster, the chain is followed according
2338 * to the modified fat, and the corresponding entries in s->mapping are
2339 * adjusted)
2341 static int commit_mappings(BDRVVVFATState* s,
2342 uint32_t first_cluster, int dir_index)
2344 mapping_t* mapping = find_mapping_for_cluster(s, first_cluster);
2345 direntry_t* direntry = array_get(&(s->directory), dir_index);
2346 uint32_t cluster = first_cluster;
2348 vvfat_close_current_file(s);
2350 assert(mapping);
2351 assert(mapping->begin == first_cluster);
2352 mapping->first_mapping_index = -1;
2353 mapping->dir_index = dir_index;
2354 mapping->mode = (dir_index <= 0 || is_directory(direntry)) ?
2355 MODE_DIRECTORY : MODE_NORMAL;
2357 while (!fat_eof(s, cluster)) {
2358 uint32_t c, c1;
2360 for (c = cluster, c1 = modified_fat_get(s, c); c + 1 == c1;
2361 c = c1, c1 = modified_fat_get(s, c1));
2363 c++;
2364 if (c > mapping->end) {
2365 int index = array_index(&(s->mapping), mapping);
2366 int i, max_i = s->mapping.next - index;
2367 for (i = 1; i < max_i && mapping[i].begin < c; i++);
2368 while (--i > 0)
2369 remove_mapping(s, index + 1);
2371 assert(mapping == array_get(&(s->mapping), s->mapping.next - 1)
2372 || mapping[1].begin >= c);
2373 mapping->end = c;
2375 if (!fat_eof(s, c1)) {
2376 int i = find_mapping_for_cluster_aux(s, c1, 0, s->mapping.next);
2377 mapping_t* next_mapping = i >= s->mapping.next ? NULL :
2378 array_get(&(s->mapping), i);
2380 if (next_mapping == NULL || next_mapping->begin > c1) {
2381 int i1 = array_index(&(s->mapping), mapping);
2383 next_mapping = insert_mapping(s, c1, c1+1);
2385 if (c1 < c)
2386 i1++;
2387 mapping = array_get(&(s->mapping), i1);
2390 next_mapping->dir_index = mapping->dir_index;
2391 next_mapping->first_mapping_index =
2392 mapping->first_mapping_index < 0 ?
2393 array_index(&(s->mapping), mapping) :
2394 mapping->first_mapping_index;
2395 next_mapping->path = mapping->path;
2396 next_mapping->mode = mapping->mode;
2397 next_mapping->read_only = mapping->read_only;
2398 if (mapping->mode & MODE_DIRECTORY) {
2399 next_mapping->info.dir.parent_mapping_index =
2400 mapping->info.dir.parent_mapping_index;
2401 next_mapping->info.dir.first_dir_index =
2402 mapping->info.dir.first_dir_index +
2403 0x10 * s->sectors_per_cluster *
2404 (mapping->end - mapping->begin);
2405 } else
2406 next_mapping->info.file.offset = mapping->info.file.offset +
2407 mapping->end - mapping->begin;
2409 mapping = next_mapping;
2412 cluster = c1;
2415 return 0;
2418 static int coroutine_fn GRAPH_RDLOCK
2419 commit_direntries(BDRVVVFATState* s, int dir_index, int parent_mapping_index)
2421 direntry_t* direntry = array_get(&(s->directory), dir_index);
2422 uint32_t first_cluster = dir_index == 0 ? 0 : begin_of_direntry(direntry);
2423 mapping_t* mapping = find_mapping_for_cluster(s, first_cluster);
2424 int factor = 0x10 * s->sectors_per_cluster;
2425 int old_cluster_count, new_cluster_count;
2426 int current_dir_index;
2427 int first_dir_index;
2428 int ret, i;
2429 uint32_t c;
2431 assert(direntry);
2432 assert(mapping);
2433 assert(mapping->begin == first_cluster);
2434 assert(mapping->info.dir.first_dir_index < s->directory.next);
2435 assert(mapping->mode & MODE_DIRECTORY);
2436 assert(dir_index == 0 || is_directory(direntry));
2438 DLOG(fprintf(stderr, "commit_direntries for %s, parent_mapping_index %d\n",
2439 mapping->path, parent_mapping_index));
2441 current_dir_index = mapping->info.dir.first_dir_index;
2442 first_dir_index = current_dir_index;
2443 mapping->info.dir.parent_mapping_index = parent_mapping_index;
2445 if (first_cluster == 0) {
2446 old_cluster_count = new_cluster_count =
2447 s->last_cluster_of_root_directory;
2448 } else {
2449 for (old_cluster_count = 0, c = first_cluster; !fat_eof(s, c);
2450 c = fat_get(s, c))
2451 old_cluster_count++;
2453 for (new_cluster_count = 0, c = first_cluster; !fat_eof(s, c);
2454 c = modified_fat_get(s, c))
2455 new_cluster_count++;
2458 if (new_cluster_count > old_cluster_count) {
2459 if (insert_direntries(s,
2460 current_dir_index + factor * old_cluster_count,
2461 factor * (new_cluster_count - old_cluster_count)) == NULL)
2462 return -1;
2463 } else if (new_cluster_count < old_cluster_count)
2464 remove_direntries(s,
2465 current_dir_index + factor * new_cluster_count,
2466 factor * (old_cluster_count - new_cluster_count));
2468 for (c = first_cluster; !fat_eof(s, c); c = modified_fat_get(s, c)) {
2469 direntry_t *first_direntry;
2471 direntry = array_get(&(s->directory), current_dir_index);
2472 ret = vvfat_read(s->bs, cluster2sector(s, c), (uint8_t *)direntry,
2473 s->sectors_per_cluster);
2474 if (ret)
2475 return ret;
2477 /* The first directory entry on the filesystem is the volume name */
2478 first_direntry = (direntry_t*) s->directory.pointer;
2479 assert(!memcmp(first_direntry->name, s->volume_label, 11));
2481 current_dir_index += factor;
2484 ret = commit_mappings(s, first_cluster, dir_index);
2485 if (ret)
2486 return ret;
2488 /* recurse */
2489 for (i = 0; i < factor * new_cluster_count; i++) {
2490 direntry = array_get(&(s->directory), first_dir_index + i);
2491 if (is_directory(direntry) && !is_dot(direntry)) {
2492 mapping = find_mapping_for_cluster(s, first_cluster);
2493 if (mapping == NULL) {
2494 return -1;
2496 assert(mapping->mode & MODE_DIRECTORY);
2497 ret = commit_direntries(s, first_dir_index + i,
2498 array_index(&(s->mapping), mapping));
2499 if (ret)
2500 return ret;
2504 return 0;
2507 /* commit one file (adjust contents, adjust mapping),
2508 return first_mapping_index */
2509 static int coroutine_fn GRAPH_RDLOCK
2510 commit_one_file(BDRVVVFATState* s, int dir_index, uint32_t offset)
2512 direntry_t* direntry = array_get(&(s->directory), dir_index);
2513 uint32_t c = begin_of_direntry(direntry);
2514 uint32_t first_cluster = c;
2515 mapping_t* mapping = find_mapping_for_cluster(s, c);
2516 uint32_t size = filesize_of_direntry(direntry);
2517 char *cluster;
2518 uint32_t i;
2519 int fd = 0;
2521 assert(offset < size);
2522 assert((offset % s->cluster_size) == 0);
2524 if (mapping == NULL) {
2525 return -1;
2528 for (i = s->cluster_size; i < offset; i += s->cluster_size)
2529 c = modified_fat_get(s, c);
2531 fd = qemu_open_old(mapping->path, O_RDWR | O_CREAT | O_BINARY, 0666);
2532 if (fd < 0) {
2533 fprintf(stderr, "Could not open %s... (%s, %d)\n", mapping->path,
2534 strerror(errno), errno);
2535 return fd;
2537 if (offset > 0) {
2538 if (lseek(fd, offset, SEEK_SET) != offset) {
2539 qemu_close(fd);
2540 return -3;
2544 cluster = g_malloc(s->cluster_size);
2546 while (offset < size) {
2547 uint32_t c1;
2548 int rest_size = (size - offset > s->cluster_size ?
2549 s->cluster_size : size - offset);
2550 int ret;
2552 c1 = modified_fat_get(s, c);
2554 assert((size - offset == 0 && fat_eof(s, c)) ||
2555 (size > offset && c >=2 && !fat_eof(s, c)));
2557 ret = vvfat_read(s->bs, cluster2sector(s, c),
2558 (uint8_t*)cluster, DIV_ROUND_UP(rest_size, 0x200));
2560 if (ret < 0) {
2561 qemu_close(fd);
2562 g_free(cluster);
2563 return ret;
2566 if (write(fd, cluster, rest_size) < 0) {
2567 qemu_close(fd);
2568 g_free(cluster);
2569 return -2;
2572 offset += rest_size;
2573 c = c1;
2576 if (ftruncate(fd, size)) {
2577 perror("ftruncate()");
2578 qemu_close(fd);
2579 g_free(cluster);
2580 return -4;
2582 qemu_close(fd);
2583 g_free(cluster);
2585 return commit_mappings(s, first_cluster, dir_index);
2588 #ifdef DEBUG
2589 /* test, if all mappings point to valid direntries */
2590 static void check1(BDRVVVFATState* s)
2592 int i;
2593 for (i = 0; i < s->mapping.next; i++) {
2594 mapping_t* mapping = array_get(&(s->mapping), i);
2595 if (mapping->mode & MODE_DELETED) {
2596 fprintf(stderr, "deleted\n");
2597 continue;
2599 assert(mapping->dir_index < s->directory.next);
2600 direntry_t* direntry = array_get(&(s->directory), mapping->dir_index);
2601 assert(mapping->begin == begin_of_direntry(direntry) || mapping->first_mapping_index >= 0);
2602 if (mapping->mode & MODE_DIRECTORY) {
2603 assert(mapping->info.dir.first_dir_index + 0x10 * s->sectors_per_cluster * (mapping->end - mapping->begin) <= s->directory.next);
2604 assert((mapping->info.dir.first_dir_index % (0x10 * s->sectors_per_cluster)) == 0);
2609 /* test, if all direntries have mappings */
2610 static void check2(BDRVVVFATState* s)
2612 int i;
2613 int first_mapping = -1;
2615 for (i = 0; i < s->directory.next; i++) {
2616 direntry_t* direntry = array_get(&(s->directory), i);
2618 if (is_short_name(direntry) && begin_of_direntry(direntry)) {
2619 mapping_t* mapping = find_mapping_for_cluster(s, begin_of_direntry(direntry));
2620 assert(mapping);
2621 assert(mapping->dir_index == i || is_dot(direntry));
2622 assert(mapping->begin == begin_of_direntry(direntry) || is_dot(direntry));
2625 if ((i % (0x10 * s->sectors_per_cluster)) == 0) {
2626 /* cluster start */
2627 int j, count = 0;
2629 for (j = 0; j < s->mapping.next; j++) {
2630 mapping_t* mapping = array_get(&(s->mapping), j);
2631 if (mapping->mode & MODE_DELETED)
2632 continue;
2633 if (mapping->mode & MODE_DIRECTORY) {
2634 if (mapping->info.dir.first_dir_index <= i && mapping->info.dir.first_dir_index + 0x10 * s->sectors_per_cluster > i) {
2635 assert(++count == 1);
2636 if (mapping->first_mapping_index == -1)
2637 first_mapping = array_index(&(s->mapping), mapping);
2638 else
2639 assert(first_mapping == mapping->first_mapping_index);
2640 if (mapping->info.dir.parent_mapping_index < 0)
2641 assert(j == 0);
2642 else {
2643 mapping_t* parent = array_get(&(s->mapping), mapping->info.dir.parent_mapping_index);
2644 assert(parent->mode & MODE_DIRECTORY);
2645 assert(parent->info.dir.first_dir_index < mapping->info.dir.first_dir_index);
2650 if (count == 0)
2651 first_mapping = -1;
2655 #endif
2657 static int handle_renames_and_mkdirs(BDRVVVFATState* s)
2659 int i;
2661 #ifdef DEBUG
2662 fprintf(stderr, "handle_renames\n");
2663 for (i = 0; i < s->commits.next; i++) {
2664 commit_t* commit = array_get(&(s->commits), i);
2665 fprintf(stderr, "%d, %s (%u, %d)\n", i,
2666 commit->path ? commit->path : "(null)",
2667 commit->param.rename.cluster, commit->action);
2669 #endif
2671 for (i = 0; i < s->commits.next;) {
2672 commit_t* commit = array_get(&(s->commits), i);
2673 if (commit->action == ACTION_RENAME) {
2674 mapping_t* mapping = find_mapping_for_cluster(s,
2675 commit->param.rename.cluster);
2676 char *old_path;
2678 if (mapping == NULL) {
2679 return -1;
2681 old_path = mapping->path;
2682 assert(commit->path);
2683 mapping->path = commit->path;
2684 if (rename(old_path, mapping->path))
2685 return -2;
2687 if (mapping->mode & MODE_DIRECTORY) {
2688 int l1 = strlen(mapping->path);
2689 int l2 = strlen(old_path);
2690 int diff = l1 - l2;
2691 direntry_t* direntry = array_get(&(s->directory),
2692 mapping->info.dir.first_dir_index);
2693 uint32_t c = mapping->begin;
2694 int j = 0;
2696 /* recurse */
2697 while (!fat_eof(s, c)) {
2698 do {
2699 direntry_t *d = direntry + j;
2701 if (is_file(d) || (is_directory(d) && !is_dot(d))) {
2702 int l;
2703 char *new_path;
2704 mapping_t* m = find_mapping_for_cluster(s,
2705 begin_of_direntry(d));
2706 if (m == NULL) {
2707 return -1;
2709 l = strlen(m->path);
2710 new_path = g_malloc(l + diff + 1);
2712 assert(!strncmp(m->path, mapping->path, l2));
2714 pstrcpy(new_path, l + diff + 1, mapping->path);
2715 pstrcpy(new_path + l1, l + diff + 1 - l1,
2716 m->path + l2);
2718 schedule_rename(s, m->begin, new_path);
2720 j++;
2721 } while (j % (0x10 * s->sectors_per_cluster) != 0);
2722 c = fat_get(s, c);
2726 g_free(old_path);
2727 array_remove(&(s->commits), i);
2728 continue;
2729 } else if (commit->action == ACTION_MKDIR) {
2730 mapping_t* mapping;
2731 int j, parent_path_len;
2733 if (g_mkdir(commit->path, 0755)) {
2734 return -5;
2737 mapping = insert_mapping(s, commit->param.mkdir.cluster,
2738 commit->param.mkdir.cluster + 1);
2739 if (mapping == NULL)
2740 return -6;
2742 mapping->mode = MODE_DIRECTORY;
2743 mapping->read_only = 0;
2744 mapping->path = commit->path;
2745 j = s->directory.next;
2746 assert(j);
2747 insert_direntries(s, s->directory.next,
2748 0x10 * s->sectors_per_cluster);
2749 mapping->info.dir.first_dir_index = j;
2751 parent_path_len = strlen(commit->path)
2752 - strlen(get_basename(commit->path)) - 1;
2753 for (j = 0; j < s->mapping.next; j++) {
2754 mapping_t* m = array_get(&(s->mapping), j);
2755 if (m->first_mapping_index < 0 && m != mapping &&
2756 !strncmp(m->path, mapping->path, parent_path_len) &&
2757 strlen(m->path) == parent_path_len)
2758 break;
2760 assert(j < s->mapping.next);
2761 mapping->info.dir.parent_mapping_index = j;
2763 array_remove(&(s->commits), i);
2764 continue;
2767 i++;
2769 return 0;
2773 * TODO: make sure that the short name is not matching *another* file
2775 static int coroutine_fn GRAPH_RDLOCK handle_commits(BDRVVVFATState* s)
2777 int i, fail = 0;
2779 vvfat_close_current_file(s);
2781 for (i = 0; !fail && i < s->commits.next; i++) {
2782 commit_t* commit = array_get(&(s->commits), i);
2783 switch(commit->action) {
2784 case ACTION_RENAME: case ACTION_MKDIR:
2785 abort();
2786 fail = -2;
2787 break;
2788 case ACTION_WRITEOUT: {
2789 direntry_t* entry = array_get(&(s->directory),
2790 commit->param.writeout.dir_index);
2791 uint32_t begin = begin_of_direntry(entry);
2792 mapping_t* mapping = find_mapping_for_cluster(s, begin);
2794 assert(mapping);
2795 assert(mapping->begin == begin);
2796 assert(commit->path == NULL);
2798 if (commit_one_file(s, commit->param.writeout.dir_index,
2799 commit->param.writeout.modified_offset))
2800 fail = -3;
2802 break;
2804 case ACTION_NEW_FILE: {
2805 int begin = commit->param.new_file.first_cluster;
2806 mapping_t* mapping = find_mapping_for_cluster(s, begin);
2807 direntry_t* entry;
2808 int j;
2810 /* find direntry */
2811 for (j = 0; j < s->directory.next; j++) {
2812 entry = array_get(&(s->directory), j);
2813 if (is_file(entry) && begin_of_direntry(entry) == begin)
2814 break;
2817 if (j >= s->directory.next) {
2818 fail = -6;
2819 continue;
2822 /* make sure there exists an initial mapping */
2823 if (mapping && mapping->begin != begin) {
2824 mapping->end = begin;
2825 mapping = NULL;
2827 if (mapping == NULL) {
2828 mapping = insert_mapping(s, begin, begin+1);
2830 /* most members will be fixed in commit_mappings() */
2831 assert(commit->path);
2832 mapping->path = commit->path;
2833 mapping->read_only = 0;
2834 mapping->mode = MODE_NORMAL;
2835 mapping->info.file.offset = 0;
2837 if (commit_one_file(s, j, 0)) {
2838 fail = -7;
2841 break;
2843 default:
2844 abort();
2847 if (i > 0 && array_remove_slice(&(s->commits), 0, i))
2848 return -1;
2849 return fail;
2852 static int handle_deletes(BDRVVVFATState* s)
2854 int i, deferred = 1, deleted = 1;
2856 /* delete files corresponding to mappings marked as deleted */
2857 /* handle DELETEs and unused mappings (modified_fat_get(s, mapping->begin) == 0) */
2858 while (deferred && deleted) {
2859 deferred = 0;
2860 deleted = 0;
2862 for (i = 1; i < s->mapping.next; i++) {
2863 mapping_t* mapping = array_get(&(s->mapping), i);
2864 if (mapping->mode & MODE_DELETED) {
2865 direntry_t* entry = array_get(&(s->directory),
2866 mapping->dir_index);
2868 if (is_free(entry)) {
2869 /* remove file/directory */
2870 if (mapping->mode & MODE_DIRECTORY) {
2871 int j, next_dir_index = s->directory.next,
2872 first_dir_index = mapping->info.dir.first_dir_index;
2874 if (rmdir(mapping->path) < 0) {
2875 if (errno == ENOTEMPTY) {
2876 deferred++;
2877 continue;
2878 } else
2879 return -5;
2882 for (j = 1; j < s->mapping.next; j++) {
2883 mapping_t* m = array_get(&(s->mapping), j);
2884 if (m->mode & MODE_DIRECTORY &&
2885 m->info.dir.first_dir_index >
2886 first_dir_index &&
2887 m->info.dir.first_dir_index <
2888 next_dir_index)
2889 next_dir_index =
2890 m->info.dir.first_dir_index;
2892 remove_direntries(s, first_dir_index,
2893 next_dir_index - first_dir_index);
2895 deleted++;
2897 } else {
2898 if (unlink(mapping->path))
2899 return -4;
2900 deleted++;
2902 DLOG(fprintf(stderr, "DELETE (%d)\n", i); print_mapping(mapping); print_direntry(entry));
2903 remove_mapping(s, i);
2908 return 0;
2912 * synchronize mapping with new state:
2914 * - copy FAT (with bdrv_pread)
2915 * - mark all filenames corresponding to mappings as deleted
2916 * - recurse direntries from root (using bs->bdrv_pread)
2917 * - delete files corresponding to mappings marked as deleted
2919 static int coroutine_fn GRAPH_RDLOCK do_commit(BDRVVVFATState* s)
2921 int ret = 0;
2923 /* the real meat are the commits. Nothing to do? Move along! */
2924 if (s->commits.next == 0)
2925 return 0;
2927 vvfat_close_current_file(s);
2929 ret = handle_renames_and_mkdirs(s);
2930 if (ret) {
2931 fprintf(stderr, "Error handling renames (%d)\n", ret);
2932 abort();
2933 return ret;
2936 /* copy FAT (with bdrv_pread) */
2937 memcpy(s->fat.pointer, s->fat2, 0x200 * s->sectors_per_fat);
2939 /* recurse direntries from root (using bs->bdrv_pread) */
2940 ret = commit_direntries(s, 0, -1);
2941 if (ret) {
2942 fprintf(stderr, "Fatal: error while committing (%d)\n", ret);
2943 abort();
2944 return ret;
2947 ret = handle_commits(s);
2948 if (ret) {
2949 fprintf(stderr, "Error handling commits (%d)\n", ret);
2950 abort();
2951 return ret;
2954 ret = handle_deletes(s);
2955 if (ret) {
2956 fprintf(stderr, "Error deleting\n");
2957 abort();
2958 return ret;
2961 bdrv_make_empty(s->qcow, NULL);
2963 memset(s->used_clusters, 0, sector2cluster(s, s->sector_count));
2965 DLOG(checkpoint());
2966 return 0;
2969 static int coroutine_fn GRAPH_RDLOCK try_commit(BDRVVVFATState* s)
2971 vvfat_close_current_file(s);
2972 DLOG(checkpoint());
2973 if(!is_consistent(s))
2974 return -1;
2975 return do_commit(s);
2978 static int coroutine_fn GRAPH_RDLOCK
2979 vvfat_write(BlockDriverState *bs, int64_t sector_num,
2980 const uint8_t *buf, int nb_sectors)
2982 BDRVVVFATState *s = bs->opaque;
2983 int i, ret;
2984 int first_cluster, last_cluster;
2986 DLOG(checkpoint());
2988 /* Check if we're operating in read-only mode */
2989 if (s->qcow == NULL) {
2990 return -EACCES;
2993 vvfat_close_current_file(s);
2995 if (sector_num == s->offset_to_bootsector && nb_sectors == 1) {
2997 * Write on bootsector. Allow only changing the reserved1 field,
2998 * used to mark volume dirtiness
3000 unsigned char *bootsector = s->first_sectors
3001 + s->offset_to_bootsector * 0x200;
3003 * LATER TODO: if FAT32, this is wrong (see init_directories(),
3004 * which always creates a FAT16 bootsector)
3006 const int reserved1_offset = offsetof(bootsector_t, u.fat16.reserved1);
3008 for (i = 0; i < 0x200; i++) {
3009 if (i != reserved1_offset && bootsector[i] != buf[i]) {
3010 fprintf(stderr, "Tried to write to protected bootsector\n");
3011 return -1;
3015 /* Update bootsector with the only updatable byte, and return success */
3016 bootsector[reserved1_offset] = buf[reserved1_offset];
3017 return 0;
3021 * Some sanity checks:
3022 * - do not allow writing to the boot sector
3024 if (sector_num < s->offset_to_fat)
3025 return -1;
3028 * Values will be negative for writes to the FAT, which is located before
3029 * the root directory.
3031 first_cluster = sector2cluster(s, sector_num);
3032 last_cluster = sector2cluster(s, sector_num + nb_sectors - 1);
3034 for (i = first_cluster; i <= last_cluster;) {
3035 mapping_t *mapping = NULL;
3037 if (i >= 0) {
3038 mapping = find_mapping_for_cluster(s, i);
3041 if (mapping) {
3042 if (mapping->read_only) {
3043 fprintf(stderr, "Tried to write to write-protected file %s\n",
3044 mapping->path);
3045 return -1;
3048 if (mapping->mode & MODE_DIRECTORY) {
3049 int begin = cluster2sector(s, i);
3050 int end = begin + s->sectors_per_cluster, k;
3051 int dir_index;
3052 const direntry_t* direntries;
3053 long_file_name lfn;
3055 lfn_init(&lfn);
3057 if (begin < sector_num)
3058 begin = sector_num;
3059 if (end > sector_num + nb_sectors)
3060 end = sector_num + nb_sectors;
3061 dir_index = mapping->dir_index +
3062 0x10 * (begin - mapping->begin * s->sectors_per_cluster);
3063 direntries = (direntry_t*)(buf + 0x200 * (begin - sector_num));
3065 for (k = 0; k < (end - begin) * 0x10; k++) {
3066 /* no access to the direntry of a read-only file */
3067 if (is_short_name(direntries + k) &&
3068 (direntries[k].attributes & 1)) {
3069 if (memcmp(direntries + k,
3070 array_get(&(s->directory), dir_index + k),
3071 sizeof(direntry_t))) {
3072 warn_report("tried to write to write-protected "
3073 "file");
3074 return -1;
3079 i = mapping->end;
3080 } else {
3081 i++;
3086 * Use qcow backend. Commit later.
3088 DLOG(fprintf(stderr, "Write to qcow backend: %d + %d\n", (int)sector_num, nb_sectors));
3089 ret = bdrv_co_pwrite(s->qcow, sector_num * BDRV_SECTOR_SIZE,
3090 nb_sectors * BDRV_SECTOR_SIZE, buf, 0);
3091 if (ret < 0) {
3092 fprintf(stderr, "Error writing to qcow backend\n");
3093 return ret;
3096 for (i = first_cluster; i <= last_cluster; i++) {
3097 if (i >= 0) {
3098 s->used_clusters[i] |= USED_ALLOCATED;
3102 DLOG(checkpoint());
3103 /* TODO: add timeout */
3104 try_commit(s);
3106 DLOG(checkpoint());
3107 return 0;
3110 static int coroutine_fn GRAPH_RDLOCK
3111 vvfat_co_pwritev(BlockDriverState *bs, int64_t offset, int64_t bytes,
3112 QEMUIOVector *qiov, BdrvRequestFlags flags)
3114 int ret;
3115 BDRVVVFATState *s = bs->opaque;
3116 uint64_t sector_num = offset >> BDRV_SECTOR_BITS;
3117 int nb_sectors = bytes >> BDRV_SECTOR_BITS;
3118 void *buf;
3120 assert(QEMU_IS_ALIGNED(offset, BDRV_SECTOR_SIZE));
3121 assert(QEMU_IS_ALIGNED(bytes, BDRV_SECTOR_SIZE));
3123 buf = g_try_malloc(bytes);
3124 if (bytes && buf == NULL) {
3125 return -ENOMEM;
3127 qemu_iovec_to_buf(qiov, 0, buf, bytes);
3129 qemu_co_mutex_lock(&s->lock);
3130 ret = vvfat_write(bs, sector_num, buf, nb_sectors);
3131 qemu_co_mutex_unlock(&s->lock);
3133 g_free(buf);
3135 return ret;
3138 static int coroutine_fn vvfat_co_block_status(BlockDriverState *bs,
3139 bool want_zero, int64_t offset,
3140 int64_t bytes, int64_t *n,
3141 int64_t *map,
3142 BlockDriverState **file)
3144 *n = bytes;
3145 return BDRV_BLOCK_DATA;
3148 static void vvfat_qcow_options(BdrvChildRole role, bool parent_is_format,
3149 int *child_flags, QDict *child_options,
3150 int parent_flags, QDict *parent_options)
3152 qdict_set_default_str(child_options, BDRV_OPT_READ_ONLY, "off");
3153 qdict_set_default_str(child_options, BDRV_OPT_AUTO_READ_ONLY, "off");
3154 qdict_set_default_str(child_options, BDRV_OPT_CACHE_NO_FLUSH, "on");
3157 static BdrvChildClass child_vvfat_qcow;
3159 static int enable_write_target(BlockDriverState *bs, Error **errp)
3161 BDRVVVFATState *s = bs->opaque;
3162 BlockDriver *bdrv_qcow = NULL;
3163 QemuOpts *opts = NULL;
3164 int ret;
3165 int size = sector2cluster(s, s->sector_count);
3166 QDict *options;
3168 s->used_clusters = g_malloc0(size);
3170 array_init(&(s->commits), sizeof(commit_t));
3172 s->qcow_filename = create_tmp_file(errp);
3173 if (!s->qcow_filename) {
3174 ret = -ENOENT;
3175 goto err;
3178 bdrv_qcow = bdrv_find_format("qcow");
3179 if (!bdrv_qcow) {
3180 error_setg(errp, "Failed to locate qcow driver");
3181 ret = -ENOENT;
3182 goto err;
3185 opts = qemu_opts_create(bdrv_qcow->create_opts, NULL, 0, &error_abort);
3186 qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
3187 bs->total_sectors * BDRV_SECTOR_SIZE, &error_abort);
3188 qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, "fat:", &error_abort);
3190 ret = bdrv_create(bdrv_qcow, s->qcow_filename, opts, errp);
3191 qemu_opts_del(opts);
3192 if (ret < 0) {
3193 goto err;
3196 options = qdict_new();
3197 qdict_put_str(options, "write-target.driver", "qcow");
3198 s->qcow = bdrv_open_child(s->qcow_filename, options, "write-target", bs,
3199 &child_vvfat_qcow,
3200 BDRV_CHILD_DATA | BDRV_CHILD_METADATA,
3201 false, errp);
3202 qobject_unref(options);
3203 if (!s->qcow) {
3204 ret = -EINVAL;
3205 goto err;
3208 #ifndef _WIN32
3209 unlink(s->qcow_filename);
3210 #endif
3212 return 0;
3214 err:
3215 return ret;
3218 static void vvfat_child_perm(BlockDriverState *bs, BdrvChild *c,
3219 BdrvChildRole role,
3220 BlockReopenQueue *reopen_queue,
3221 uint64_t perm, uint64_t shared,
3222 uint64_t *nperm, uint64_t *nshared)
3224 assert(role & BDRV_CHILD_DATA);
3225 /* This is a private node, nobody should try to attach to it */
3226 *nperm = BLK_PERM_CONSISTENT_READ | BLK_PERM_WRITE;
3227 *nshared = BLK_PERM_WRITE_UNCHANGED;
3230 static void vvfat_close(BlockDriverState *bs)
3232 BDRVVVFATState *s = bs->opaque;
3234 vvfat_close_current_file(s);
3235 array_free(&(s->fat));
3236 array_free(&(s->directory));
3237 array_free(&(s->mapping));
3238 g_free(s->cluster_buffer);
3240 if (s->qcow) {
3241 migrate_del_blocker(&s->migration_blocker);
3245 static const char *const vvfat_strong_runtime_opts[] = {
3246 "dir",
3247 "fat-type",
3248 "floppy",
3249 "label",
3250 "rw",
3252 NULL
3255 static BlockDriver bdrv_vvfat = {
3256 .format_name = "vvfat",
3257 .protocol_name = "fat",
3258 .instance_size = sizeof(BDRVVVFATState),
3260 .bdrv_parse_filename = vvfat_parse_filename,
3261 .bdrv_file_open = vvfat_open,
3262 .bdrv_refresh_limits = vvfat_refresh_limits,
3263 .bdrv_close = vvfat_close,
3264 .bdrv_child_perm = vvfat_child_perm,
3266 .bdrv_co_preadv = vvfat_co_preadv,
3267 .bdrv_co_pwritev = vvfat_co_pwritev,
3268 .bdrv_co_block_status = vvfat_co_block_status,
3270 .strong_runtime_opts = vvfat_strong_runtime_opts,
3273 static void bdrv_vvfat_init(void)
3275 child_vvfat_qcow = child_of_bds;
3276 child_vvfat_qcow.inherit_options = vvfat_qcow_options;
3277 bdrv_register(&bdrv_vvfat);
3280 block_init(bdrv_vvfat_init);
3282 #ifdef DEBUG
3283 static void checkpoint(void)
3285 assert(((mapping_t*)array_get(&(vvv->mapping), 0))->end == 2);
3286 check1(vvv);
3287 check2(vvv);
3288 assert(!vvv->current_mapping || vvv->current_fd || (vvv->current_mapping->mode & MODE_DIRECTORY));
3290 #endif