1 /******************************************************************************
5 * This is the implementation of a file that consists of blocks of
6 * a predetermined size.
7 * This class is used in the Compound File implementation of the
8 * IStorage and IStream interfaces. It provides the functionality
9 * to read and write any blocks in the file as well as setting and
10 * obtaining the size of the file.
11 * The blocks are indexed sequentially from the start of the file
15 * - Support for a transacted mode
17 * Copyright 1999 Thuy Nguyen
19 * This library is free software; you can redistribute it and/or
20 * modify it under the terms of the GNU Lesser General Public
21 * License as published by the Free Software Foundation; either
22 * version 2.1 of the License, or (at your option) any later version.
24 * This library is distributed in the hope that it will be useful,
25 * but WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
27 * Lesser General Public License for more details.
29 * You should have received a copy of the GNU Lesser General Public
30 * License along with this library; if not, write to the Free Software
31 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
42 #define NONAMELESSUNION
43 #define NONAMELESSSTRUCT
52 #include "storage32.h"
54 #include "wine/debug.h"
56 WINE_DEFAULT_DEBUG_CHANNEL(storage);
58 /***********************************************************
59 * Data structures used internally by the BigBlockFile
63 /* We map in PAGE_SIZE-sized chunks. Must be a multiple of 4096. */
64 #define PAGE_SIZE 131072
66 #define BLOCKS_PER_PAGE (PAGE_SIZE / BIG_BLOCK_SIZE)
68 /* We keep a list of recently-discarded pages. This controls the
69 * size of that list. */
70 #define MAX_VICTIM_PAGES 16
72 /* This structure provides one bit for each block in a page.
73 * Use BIGBLOCKFILE_{Test,Set,Clear}Bit to manipulate it. */
76 unsigned int bits[BLOCKS_PER_PAGE / (CHAR_BIT * sizeof(unsigned int))];
80 * This structure identifies the paged that are mapped
81 * from the file and their position in memory. It is
82 * also used to hold a reference count to those pages.
84 * page_index identifies which PAGE_SIZE chunk from the
85 * file this mapping represents. (The mappings are always
97 BlockBits readable_blocks;
98 BlockBits writable_blocks;
101 /***********************************************************
102 * Prototypes for private methods
104 static void* BIGBLOCKFILE_GetMappedView(LPBIGBLOCKFILE This,
106 static void BIGBLOCKFILE_ReleaseMappedPage(LPBIGBLOCKFILE This,
108 static void BIGBLOCKFILE_FreeAllMappedPages(LPBIGBLOCKFILE This);
109 static void BIGBLOCKFILE_UnmapAllMappedPages(LPBIGBLOCKFILE This);
110 static void BIGBLOCKFILE_RemapAllMappedPages(LPBIGBLOCKFILE This);
111 static void* BIGBLOCKFILE_GetBigBlockPointer(LPBIGBLOCKFILE This,
113 DWORD desired_access);
114 static MappedPage* BIGBLOCKFILE_GetPageFromPointer(LPBIGBLOCKFILE This,
116 static MappedPage* BIGBLOCKFILE_CreatePage(LPBIGBLOCKFILE This,
118 static DWORD BIGBLOCKFILE_GetProtectMode(DWORD openFlags);
119 static BOOL BIGBLOCKFILE_FileInit(LPBIGBLOCKFILE This, HANDLE hFile);
120 static BOOL BIGBLOCKFILE_MemInit(LPBIGBLOCKFILE This, ILockBytes* plkbyt);
122 /* Note that this evaluates a and b multiple times, so don't
123 * pass expressions with side effects. */
124 #define ROUND_UP(a, b) ((((a) + (b) - 1)/(b))*(b))
126 /***********************************************************
127 * Blockbits functions.
129 static inline BOOL BIGBLOCKFILE_TestBit(const BlockBits *bb,
132 unsigned int array_index = index / (CHAR_BIT * sizeof(unsigned int));
133 unsigned int bit_index = index % (CHAR_BIT * sizeof(unsigned int));
135 return bb->bits[array_index] & (1 << bit_index);
138 static inline void BIGBLOCKFILE_SetBit(BlockBits *bb, unsigned int index)
140 unsigned int array_index = index / (CHAR_BIT * sizeof(unsigned int));
141 unsigned int bit_index = index % (CHAR_BIT * sizeof(unsigned int));
143 bb->bits[array_index] |= (1 << bit_index);
146 static inline void BIGBLOCKFILE_ClearBit(BlockBits *bb, unsigned int index)
148 unsigned int array_index = index / (CHAR_BIT * sizeof(unsigned int));
149 unsigned int bit_index = index % (CHAR_BIT * sizeof(unsigned int));
151 bb->bits[array_index] &= ~(1 << bit_index);
154 static inline void BIGBLOCKFILE_Zero(BlockBits *bb)
156 memset(bb->bits, 0, sizeof(bb->bits));
159 /******************************************************************************
160 * BIGBLOCKFILE_Construct
162 * Construct a big block file. Create the file mapping object.
163 * Create the read only mapped pages list, the writable mapped page list
164 * and the blocks in use list.
166 BigBlockFile * BIGBLOCKFILE_Construct(
175 This = HeapAlloc(GetProcessHeap(), 0, sizeof(BigBlockFile));
180 This->fileBased = fileBased;
182 This->flProtect = BIGBLOCKFILE_GetProtectMode(openFlags);
184 This->blocksize = blocksize;
186 This->maplist = NULL;
187 This->victimhead = NULL;
188 This->victimtail = NULL;
189 This->num_victim_pages = 0;
193 if (!BIGBLOCKFILE_FileInit(This, hFile))
195 HeapFree(GetProcessHeap(), 0, This);
201 if (!BIGBLOCKFILE_MemInit(This, pLkByt))
203 HeapFree(GetProcessHeap(), 0, This);
211 /******************************************************************************
212 * BIGBLOCKFILE_FileInit
214 * Initialize a big block object supported by a file.
216 static BOOL BIGBLOCKFILE_FileInit(LPBIGBLOCKFILE This, HANDLE hFile)
219 This->hbytearray = 0;
220 This->pbytearray = NULL;
224 if (This->hfile == INVALID_HANDLE_VALUE)
227 This->filesize.u.LowPart = GetFileSize(This->hfile,
228 &This->filesize.u.HighPart);
230 if( This->filesize.u.LowPart || This->filesize.u.HighPart )
232 /* create the file mapping object
234 This->hfilemap = CreateFileMappingA(This->hfile,
242 CloseHandle(This->hfile);
247 This->hfilemap = NULL;
249 This->maplist = NULL;
251 TRACE("file len %u\n", This->filesize.u.LowPart);
256 /******************************************************************************
257 * BIGBLOCKFILE_MemInit
259 * Initialize a big block object supported by an ILockBytes on HGLOABL.
261 static BOOL BIGBLOCKFILE_MemInit(LPBIGBLOCKFILE This, ILockBytes* plkbyt)
267 * Retrieve the handle to the byte array from the LockByte object.
269 if (GetHGlobalFromILockBytes(plkbyt, &(This->hbytearray)) != S_OK)
271 FIXME("May not be an ILockBytes on HGLOBAL\n");
275 This->pLkbyt = plkbyt;
278 * Increment the reference count of the ILockByte object since
279 * we're keeping a reference to it.
281 ILockBytes_AddRef(This->pLkbyt);
283 This->filesize.u.LowPart = GlobalSize(This->hbytearray);
284 This->filesize.u.HighPart = 0;
286 This->pbytearray = GlobalLock(This->hbytearray);
288 TRACE("mem on %p len %u\n", This->pbytearray, This->filesize.u.LowPart);
293 /******************************************************************************
294 * BIGBLOCKFILE_Destructor
296 * Destructor. Clean up, free memory.
298 void BIGBLOCKFILE_Destructor(
301 BIGBLOCKFILE_FreeAllMappedPages(This);
305 CloseHandle(This->hfilemap);
306 CloseHandle(This->hfile);
310 GlobalUnlock(This->hbytearray);
311 ILockBytes_Release(This->pLkbyt);
316 HeapFree(GetProcessHeap(), 0, This);
319 /******************************************************************************
320 * BIGBLOCKFILE_GetROBigBlock
322 * Returns the specified block in read only mode.
323 * Will return NULL if the block doesn't exists.
325 void* BIGBLOCKFILE_GetROBigBlock(
330 * block index starts at -1
331 * translate to zero based index
333 if (index == 0xffffffff)
339 * validate the block index
342 if (This->blocksize * (index + 1)
343 > ROUND_UP(This->filesize.u.LowPart, This->blocksize))
345 TRACE("out of range %u vs %u\n", This->blocksize * (index + 1),
346 This->filesize.u.LowPart);
350 return BIGBLOCKFILE_GetBigBlockPointer(This, index, FILE_MAP_READ);
353 /******************************************************************************
354 * BIGBLOCKFILE_EnsureExists
356 * Grows the file if necessary to make sure the block is valid.
358 void BIGBLOCKFILE_EnsureExists(LPBIGBLOCKFILE This, ULONG index)
361 * block index starts at -1
362 * translate to zero based index
364 if (index == 0xffffffff)
370 * make sure that the block physically exists
372 if ((This->blocksize * (index + 1)) > This->filesize.u.LowPart)
374 ULARGE_INTEGER newSize;
376 newSize.u.HighPart = 0;
377 newSize.u.LowPart = This->blocksize * (index + 1);
379 BIGBLOCKFILE_SetSize(This, newSize);
383 /******************************************************************************
384 * BIGBLOCKFILE_GetBigBlock
386 * Returns the specified block.
387 * Will grow the file if necessary.
389 void* BIGBLOCKFILE_GetBigBlock(LPBIGBLOCKFILE This, ULONG index)
391 /* FIXME: is this necessary? */
392 BIGBLOCKFILE_EnsureExists(This, index);
395 * block index starts at -1
396 * translate to zero based index
398 if (index == 0xffffffff)
403 return BIGBLOCKFILE_GetBigBlockPointer(This, index, FILE_MAP_WRITE);
406 /******************************************************************************
407 * BIGBLOCKFILE_ReleaseBigBlock
409 * Releases the specified block.
411 void BIGBLOCKFILE_ReleaseBigBlock(LPBIGBLOCKFILE This, void *pBlock)
418 page = BIGBLOCKFILE_GetPageFromPointer(This, pBlock);
423 BIGBLOCKFILE_ReleaseMappedPage(This, page);
426 /******************************************************************************
427 * BIGBLOCKFILE_SetSize
429 * Sets the size of the file.
432 void BIGBLOCKFILE_SetSize(LPBIGBLOCKFILE This, ULARGE_INTEGER newSize)
434 if (This->filesize.u.LowPart == newSize.u.LowPart)
437 TRACE("from %u to %u\n", This->filesize.u.LowPart, newSize.u.LowPart);
439 * unmap all views, must be done before call to SetEndFile
441 BIGBLOCKFILE_UnmapAllMappedPages(This);
445 LARGE_INTEGER newpos;
447 newpos.QuadPart = newSize.QuadPart;
448 if (SetFilePointerEx(This->hfile, newpos, NULL, FILE_BEGIN))
450 if( This->hfilemap ) CloseHandle(This->hfilemap);
452 SetEndOfFile(This->hfile);
455 * re-create the file mapping object
457 This->hfilemap = CreateFileMappingA(This->hfile,
466 GlobalUnlock(This->hbytearray);
469 * Resize the byte array object.
471 ILockBytes_SetSize(This->pLkbyt, newSize);
474 * Re-acquire the handle, it may have changed.
476 GetHGlobalFromILockBytes(This->pLkbyt, &This->hbytearray);
477 This->pbytearray = GlobalLock(This->hbytearray);
480 This->filesize.u.LowPart = newSize.u.LowPart;
481 This->filesize.u.HighPart = newSize.u.HighPart;
483 BIGBLOCKFILE_RemapAllMappedPages(This);
486 /******************************************************************************
487 * BIGBLOCKFILE_GetSize
489 * Returns the size of the file.
492 ULARGE_INTEGER BIGBLOCKFILE_GetSize(LPBIGBLOCKFILE This)
494 return This->filesize;
497 /******************************************************************************
498 * BIGBLOCKFILE_AccessCheck [PRIVATE]
500 * block_index is the index within the page.
502 static BOOL BIGBLOCKFILE_AccessCheck(MappedPage *page, ULONG block_index,
503 DWORD desired_access)
505 assert(block_index < BLOCKS_PER_PAGE);
507 if (desired_access == FILE_MAP_READ)
509 if (BIGBLOCKFILE_TestBit(&page->writable_blocks, block_index))
512 BIGBLOCKFILE_SetBit(&page->readable_blocks, block_index);
516 assert(desired_access == FILE_MAP_WRITE);
518 if (BIGBLOCKFILE_TestBit(&page->readable_blocks, block_index))
521 BIGBLOCKFILE_SetBit(&page->writable_blocks, block_index);
527 /******************************************************************************
528 * BIGBLOCKFILE_GetBigBlockPointer [PRIVATE]
530 * Returns a pointer to the specified block.
532 static void* BIGBLOCKFILE_GetBigBlockPointer(
535 DWORD desired_access)
537 DWORD page_index = block_index / BLOCKS_PER_PAGE;
538 DWORD block_on_page = block_index % BLOCKS_PER_PAGE;
540 MappedPage *page = BIGBLOCKFILE_GetMappedView(This, page_index);
541 if (!page || !page->lpBytes) return NULL;
543 if (!BIGBLOCKFILE_AccessCheck(page, block_on_page, desired_access))
545 BIGBLOCKFILE_ReleaseMappedPage(This, page);
549 return (LPBYTE)page->lpBytes + (block_on_page * This->blocksize);
552 /******************************************************************************
553 * BIGBLOCKFILE_GetMappedPageFromPointer [PRIVATE]
555 * pBlock is a pointer to a block on a page.
556 * The page has to be on the in-use list. (As oppsed to the victim list.)
558 * Does not increment the usage count.
560 static MappedPage *BIGBLOCKFILE_GetPageFromPointer(LPBIGBLOCKFILE This,
565 for (page = This->maplist; page != NULL; page = page->next)
567 if ((LPBYTE)pBlock >= (LPBYTE)page->lpBytes
568 && (LPBYTE)pBlock <= (LPBYTE)page->lpBytes + PAGE_SIZE)
576 /******************************************************************************
577 * BIGBLOCKFILE_FindPageInList [PRIVATE]
580 static MappedPage *BIGBLOCKFILE_FindPageInList(MappedPage *head,
583 for (; head != NULL; head = head->next)
585 if (head->page_index == page_index)
587 InterlockedIncrement(&head->refcnt);
596 static void BIGBLOCKFILE_UnlinkPage(MappedPage *page)
598 if (page->next) page->next->prev = page->prev;
599 if (page->prev) page->prev->next = page->next;
602 static void BIGBLOCKFILE_LinkHeadPage(MappedPage **head, MappedPage *page)
604 if (*head) (*head)->prev = page;
610 /******************************************************************************
611 * BIGBLOCKFILE_GetMappedView [PRIVATE]
613 * Gets the page requested if it is already mapped.
614 * If it's not already mapped, this method will map it
616 static void * BIGBLOCKFILE_GetMappedView(
622 page = BIGBLOCKFILE_FindPageInList(This->maplist, page_index);
625 page = BIGBLOCKFILE_FindPageInList(This->victimhead, page_index);
628 This->num_victim_pages--;
630 BIGBLOCKFILE_Zero(&page->readable_blocks);
631 BIGBLOCKFILE_Zero(&page->writable_blocks);
637 /* If the page is not already at the head of the list, move
638 * it there. (Also moves pages from victim to main list.) */
639 if (This->maplist != page)
641 if (This->victimhead == page) This->victimhead = page->next;
642 if (This->victimtail == page) This->victimtail = page->prev;
644 BIGBLOCKFILE_UnlinkPage(page);
646 BIGBLOCKFILE_LinkHeadPage(&This->maplist, page);
652 page = BIGBLOCKFILE_CreatePage(This, page_index);
653 if (!page) return NULL;
655 BIGBLOCKFILE_LinkHeadPage(&This->maplist, page);
660 static BOOL BIGBLOCKFILE_MapPage(LPBIGBLOCKFILE This, MappedPage *page)
662 DWORD lowoffset = PAGE_SIZE * page->page_index;
667 DWORD desired_access;
669 if( !This->hfilemap )
672 if (lowoffset + PAGE_SIZE > This->filesize.u.LowPart)
673 numBytesToMap = This->filesize.u.LowPart - lowoffset;
675 numBytesToMap = PAGE_SIZE;
677 if (This->flProtect == PAGE_READONLY)
678 desired_access = FILE_MAP_READ;
680 desired_access = FILE_MAP_WRITE;
682 page->lpBytes = MapViewOfFile(This->hfilemap, desired_access, 0,
683 lowoffset, numBytesToMap);
687 page->lpBytes = (LPBYTE)This->pbytearray + lowoffset;
690 TRACE("mapped page %u to %p\n", page->page_index, page->lpBytes);
692 return page->lpBytes != NULL;
695 static MappedPage *BIGBLOCKFILE_CreatePage(LPBIGBLOCKFILE This,
700 page = HeapAlloc(GetProcessHeap(), 0, sizeof(MappedPage));
704 page->page_index = page_index;
710 BIGBLOCKFILE_MapPage(This, page);
712 BIGBLOCKFILE_Zero(&page->readable_blocks);
713 BIGBLOCKFILE_Zero(&page->writable_blocks);
718 static void BIGBLOCKFILE_UnmapPage(LPBIGBLOCKFILE This, MappedPage *page)
720 TRACE("%d at %p\n", page->page_index, page->lpBytes);
721 if (page->refcnt > 0)
722 ERR("unmapping inuse page %p\n", page->lpBytes);
724 if (This->fileBased && page->lpBytes)
725 UnmapViewOfFile(page->lpBytes);
727 page->lpBytes = NULL;
730 static void BIGBLOCKFILE_DeletePage(LPBIGBLOCKFILE This, MappedPage *page)
732 BIGBLOCKFILE_UnmapPage(This, page);
734 HeapFree(GetProcessHeap(), 0, page);
737 /******************************************************************************
738 * BIGBLOCKFILE_ReleaseMappedPage [PRIVATE]
740 * Decrements the reference count of the mapped page.
742 static void BIGBLOCKFILE_ReleaseMappedPage(
746 assert(This != NULL);
747 assert(page != NULL);
749 /* If the page is no longer refenced, move it to the victim list.
750 * If the victim list is too long, kick somebody off. */
751 if (!InterlockedDecrement(&page->refcnt))
753 if (This->maplist == page) This->maplist = page->next;
755 BIGBLOCKFILE_UnlinkPage(page);
757 if (MAX_VICTIM_PAGES > 0)
759 if (This->num_victim_pages >= MAX_VICTIM_PAGES)
761 MappedPage *victim = This->victimtail;
764 This->victimtail = victim->prev;
765 if (This->victimhead == victim)
766 This->victimhead = victim->next;
768 BIGBLOCKFILE_UnlinkPage(victim);
769 BIGBLOCKFILE_DeletePage(This, victim);
772 else This->num_victim_pages++;
774 BIGBLOCKFILE_LinkHeadPage(&This->victimhead, page);
775 if (This->victimtail == NULL) This->victimtail = page;
778 BIGBLOCKFILE_DeletePage(This, page);
782 static void BIGBLOCKFILE_DeleteList(LPBIGBLOCKFILE This, MappedPage *list)
786 MappedPage *next = list->next;
788 BIGBLOCKFILE_DeletePage(This, list);
794 /******************************************************************************
795 * BIGBLOCKFILE_FreeAllMappedPages [PRIVATE]
797 * Unmap all currently mapped pages.
798 * Empty mapped pages list.
800 static void BIGBLOCKFILE_FreeAllMappedPages(
803 BIGBLOCKFILE_DeleteList(This, This->maplist);
804 BIGBLOCKFILE_DeleteList(This, This->victimhead);
806 This->maplist = NULL;
807 This->victimhead = NULL;
808 This->victimtail = NULL;
809 This->num_victim_pages = 0;
812 static void BIGBLOCKFILE_UnmapList(LPBIGBLOCKFILE This, MappedPage *list)
814 for (; list != NULL; list = list->next)
816 BIGBLOCKFILE_UnmapPage(This, list);
820 static void BIGBLOCKFILE_UnmapAllMappedPages(LPBIGBLOCKFILE This)
822 BIGBLOCKFILE_UnmapList(This, This->maplist);
823 BIGBLOCKFILE_UnmapList(This, This->victimhead);
826 static void BIGBLOCKFILE_RemapList(LPBIGBLOCKFILE This, MappedPage *list)
830 MappedPage *next = list->next;
832 if (list->page_index * PAGE_SIZE > This->filesize.u.LowPart)
834 TRACE("discarding %u\n", list->page_index);
836 /* page is entirely outside of the file, delete it */
837 BIGBLOCKFILE_UnlinkPage(list);
838 BIGBLOCKFILE_DeletePage(This, list);
842 /* otherwise, remap it */
843 BIGBLOCKFILE_MapPage(This, list);
850 static void BIGBLOCKFILE_RemapAllMappedPages(LPBIGBLOCKFILE This)
852 BIGBLOCKFILE_RemapList(This, This->maplist);
853 BIGBLOCKFILE_RemapList(This, This->victimhead);
856 /****************************************************************************
857 * BIGBLOCKFILE_GetProtectMode
859 * This function will return a protection mode flag for a file-mapping object
860 * from the open flags of a file.
862 static DWORD BIGBLOCKFILE_GetProtectMode(DWORD openFlags)
864 switch(STGM_ACCESS_MODE(openFlags))
868 return PAGE_READWRITE;
870 return PAGE_READONLY;