*_FileSizes_changed(): It appears it is valid to squeeze out 'dirty' blocks.
[captive.git] / src / libcaptive / cc / sharedcachemap.c
1 /* $Id$
2  * reactos Cache Manager (Cc*) SharedCacheMap structure of libcaptive
3  * Copyright (C) 2003 Jan Kratochvil <project-captive@jankratochvil.net>
4  * 
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; exactly version 2 of June 1991 is required
8  * 
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  * 
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17  */
18
19
20 #include "config.h"
21
22 #include "sharedcachemap.h"     /* self */
23 #include "sharedcachemap-priv.h"        /* self */
24 #include "io.h"
25 #include "marshallers.h"
26 #include <glib-object.h>
27 #include "privatebcbpin.h"
28 #include "captive/macros.h"
29 #include <sys/mman.h>
30 #include "reactos/ddk/obfuncs.h"
31
32
33 static GHashTable *CaptiveSharedCacheMapObject_hash;
34
35 static void CaptiveSharedCacheMapObject_hash_init(void)
36 {
37         if (CaptiveSharedCacheMapObject_hash)
38                 return;
39         CaptiveSharedCacheMapObject_hash=g_hash_table_new(
40                         g_direct_hash,  /* hash_func */
41                         g_direct_equal);        /* key_equal_func */
42 }
43
44
45 static gpointer captive_shared_cache_map_object_parent_class=NULL;
46
47
48 static void captive_shared_cache_map_object_finalize(CaptiveSharedCacheMapObject *captive_shared_cache_map_object)
49 {
50 static const CC_FILE_SIZES FileSizes_zero;
51 gboolean errbool;
52 guint64 offset;
53 CaptiveSharedCacheMapObject_page *page;
54
55         g_return_if_fail(captive_shared_cache_map_object!=NULL);
56
57         for (offset=0;offset<CAPTIVE_ROUND_UP64(captive_shared_cache_map_object->AllocationSize,PAGE_SIZE);offset+=PAGE_SIZE) {
58                 page=captive_shared_cache_map_object->pages+offset/PAGE_SIZE;
59                 if (!page->data_valid)
60                         continue;
61                 g_assert(!page->dirty); /* FIXME: Is it allowed by W32? */
62                 }
63
64         CaptiveSharedCacheMapObject_hash_init();
65         errbool=g_hash_table_remove(CaptiveSharedCacheMapObject_hash,captive_shared_cache_map_object);
66         g_assert(errbool==TRUE);
67
68         captive_shared_cache_map_FileSizes_set(captive_shared_cache_map_object,&FileSizes_zero);
69         g_assert(captive_shared_cache_map_object->buffer==NULL);
70         g_assert(captive_shared_cache_map_object->pages==NULL);
71
72         if (captive_shared_cache_map_object->pin_hash) {
73                 captive_private_bcb_pin_object_hash_destroy(captive_shared_cache_map_object->pin_hash);
74                 captive_shared_cache_map_object->pin_hash=NULL;
75                 }
76         g_assert(captive_shared_cache_map_object->map==NULL);
77         if (captive_shared_cache_map_object->SectionObjectPointers) {
78                 g_assert(captive_shared_cache_map_object==captive_shared_cache_map_object->SectionObjectPointers->SharedCacheMap);
79                 captive_shared_cache_map_object->SectionObjectPointers->SharedCacheMap=NULL;
80                 }
81
82         if (captive_shared_cache_map_object->FileObject) {
83                 /* W32 dereferences twice. */
84                 ObDereferenceObject(captive_shared_cache_map_object->FileObject);
85                 captive_shared_cache_map_object->FileObject=NULL;
86                 }
87
88         G_OBJECT_CLASS(captive_shared_cache_map_object_parent_class)->finalize((GObject *)captive_shared_cache_map_object);
89 }
90
91 static guint FileSizes_changed_signal;
92 static guint purge_signal;
93
94 static void captive_shared_cache_map_object_FileSizes_changed(CaptiveSharedCacheMapObject *captive_shared_cache_map_object,
95                 guint64 AllocationSize,guint64 FileSize,guint64 ValidDataLength);
96 static void captive_shared_cache_map_object_purge(CaptiveSharedCacheMapObject *captive_shared_cache_map_object);
97
98 static void captive_shared_cache_map_object_class_init(CaptiveSharedCacheMapObjectClass *class)
99 {
100 GObjectClass *gobject_class=G_OBJECT_CLASS(class);
101
102         captive_shared_cache_map_object_parent_class=g_type_class_ref(G_TYPE_OBJECT);
103         gobject_class->finalize=(void (*)(GObject *object))captive_shared_cache_map_object_finalize;
104
105         class->FileSizes_changed=captive_shared_cache_map_object_FileSizes_changed;
106         class->purge=captive_shared_cache_map_object_purge;
107
108         FileSizes_changed_signal=g_signal_new("FileSizes_changed",
109                         G_TYPE_FROM_CLASS(gobject_class),
110                         G_SIGNAL_RUN_LAST,
111                         G_STRUCT_OFFSET(CaptiveSharedCacheMapObjectClass,FileSizes_changed),
112                         NULL,NULL,
113                         captive_cc_VOID__UINT64_UINT64_UINT64,
114                         G_TYPE_NONE,3,G_TYPE_UINT64,G_TYPE_UINT64,G_TYPE_UINT64);
115         purge_signal=g_signal_new("purge",
116                         G_TYPE_FROM_CLASS(gobject_class),
117                         G_SIGNAL_RUN_LAST,
118                         G_STRUCT_OFFSET(CaptiveSharedCacheMapObjectClass,purge),
119                         NULL,NULL,
120                         captive_cc_VOID__VOID,
121                         G_TYPE_NONE,0);
122 }
123
124
125 static void captive_shared_cache_map_object_init(CaptiveSharedCacheMapObject *captive_shared_cache_map_object)
126 {
127         captive_shared_cache_map_object->pin_hash=captive_private_bcb_pin_object_hash_new();
128
129         captive_shared_cache_map_w32_ref(captive_shared_cache_map_object);
130         g_object_unref(captive_shared_cache_map_object);        /* ==sink */
131
132         CaptiveSharedCacheMapObject_hash_init();
133         g_hash_table_insert(CaptiveSharedCacheMapObject_hash,
134                         captive_shared_cache_map_object,captive_shared_cache_map_object);
135 }
136
137
138 GType captive_shared_cache_map_object_get_type(void)
139 {
140 static GType captive_shared_cache_map_object_type=0;
141
142         if (!captive_shared_cache_map_object_type) {
143 static const GTypeInfo captive_shared_cache_map_object_info={
144                                 sizeof(CaptiveSharedCacheMapObjectClass),
145                                 NULL,   /* base_init */
146                                 NULL,   /* base_finalize */
147                                 (GClassInitFunc)captive_shared_cache_map_object_class_init,
148                                 NULL,   /* class_finalize */
149                                 NULL,   /* class_data */
150                                 sizeof(CaptiveSharedCacheMapObject),
151                                 5,      /* n_preallocs */
152                                 (GInstanceInitFunc)captive_shared_cache_map_object_init,
153                                 };
154
155                 captive_shared_cache_map_object_type=g_type_register_static(G_TYPE_OBJECT,
156                                 "CaptiveSharedCacheMapObject",&captive_shared_cache_map_object_info,0);
157                 }
158
159         return captive_shared_cache_map_object_type;
160 }
161
162 static void captive_shared_cache_map_object_FileSizes_changed(CaptiveSharedCacheMapObject *captive_shared_cache_map_object,
163                 guint64 AllocationSize,guint64 FileSize,guint64 ValidDataLength)
164 {
165 size_t size_old,size_new;
166 guint64 size64_old,size64_new;
167
168         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
169
170         g_assert((!captive_shared_cache_map_object->buffer)==(!captive_shared_cache_map_object->AllocationSize));
171         g_assert((!captive_shared_cache_map_object->pages)==(!captive_shared_cache_map_object->AllocationSize));
172
173         size64_old=CAPTIVE_ROUND_UP64(captive_shared_cache_map_object->AllocationSize,PAGE_SIZE);       
174         size_old=size64_old;
175         g_assert(size_old==size64_old);
176         size64_new=CAPTIVE_ROUND_UP64(AllocationSize,PAGE_SIZE);        
177         size_new=size64_new;
178         g_assert(size_new==size64_new);
179
180         if (size_old!=size_new) {
181 gpointer buffer_new;
182
183                 /* These two assertions should be already catched by pin/map signal handlers. */
184                 g_assert(!captive_shared_cache_map_object->map);
185                 g_assert(!g_hash_table_size(captive_shared_cache_map_object->pin_hash));
186
187                 if (AllocationSize) {
188 gpointer base;
189 int errint;
190
191                         base=mmap(
192                                         NULL,   /* start */
193                                         PAGE_SIZE+size_new+PAGE_SIZE,   /* length; leading and trailing boundary check pages */
194                                         PROT_READ|PROT_WRITE,   /* prot; read/write must be possible although write is not guaranteed to be flushed yet */
195                                         MAP_PRIVATE|MAP_ANONYMOUS,      /* flags */
196                                         -1,     /* fd; ignored due to MAP_ANONYMOUS */
197                                         0);     /* offset; ignored due to MAP_ANONYMOUS */
198                         g_assert(base!=NULL);
199
200                         base+=PAGE_SIZE;
201                         errint=munmap(base-PAGE_SIZE,PAGE_SIZE);        /* unmap leading boundary check page */
202                         g_assert(errint==0);
203                         errint=munmap(base+size_new,PAGE_SIZE); /* unmap trailing boundary check page */
204                         g_assert(errint==0);
205
206                         buffer_new=base;
207                         }
208                 else
209                         buffer_new=NULL;
210
211                 memcpy(buffer_new,captive_shared_cache_map_object->buffer,
212                                 MIN(AllocationSize,captive_shared_cache_map_object->AllocationSize));
213
214                 if (captive_shared_cache_map_object->AllocationSize) {
215 int errint;
216
217                         errint=munmap(captive_shared_cache_map_object->buffer,size_old);
218                         g_assert(errint==0);
219                         }
220
221                 captive_shared_cache_map_object->buffer=buffer_new;
222
223 #if 0   /* It appears it is valid to squeeze out 'dirty' blocks. FIXME: Flush them? */
224                 if (size_old>size_new) {
225 guint64 now;
226
227                         for (now=size_new;now<size_old;now+=PAGE_SIZE) {
228                                 if (!captive_shared_cache_map_object->pages[now/PAGE_SIZE].data_valid)
229                                         continue;
230                                 g_assert(!captive_shared_cache_map_object->pages[now/PAGE_SIZE].dirty);
231                                 }
232                         }
233 #endif
234                 captive_shared_cache_map_object->pages=g_realloc(captive_shared_cache_map_object->pages,
235                                 size_new/PAGE_SIZE*sizeof(*captive_shared_cache_map_object->pages));
236                 if (size_new>size_old)  /* prevent 'size_new-size_old' as it is unsigned! */
237                         memset(captive_shared_cache_map_object->pages+(size_old/PAGE_SIZE),0,
238                                         (size_new-size_old)/PAGE_SIZE*sizeof(*captive_shared_cache_map_object->pages));
239                 }
240
241         captive_shared_cache_map_object->AllocationSize=AllocationSize;
242         captive_shared_cache_map_object->FileSize=FileSize;
243         captive_shared_cache_map_object->ValidDataLength=ValidDataLength;
244
245         g_assert((!captive_shared_cache_map_object->buffer)==(!captive_shared_cache_map_object->AllocationSize));
246         g_assert((!captive_shared_cache_map_object->pages)==(!captive_shared_cache_map_object->AllocationSize));
247 }
248
249 static void captive_shared_cache_map_object_purge(CaptiveSharedCacheMapObject *captive_shared_cache_map_object)
250 {
251         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
252
253         /* NOP; just to provide slot for checking by Bcbs */
254 }
255
256 CaptiveSharedCacheMapObject *captive_shared_cache_map_get_ref(FILE_OBJECT *FileObject,
257                 const CC_FILE_SIZES *FileSizes,BOOLEAN PinAccess,CACHE_MANAGER_CALLBACKS *CallBacks,VOID *LazyWriterContext)
258 {
259 CaptiveSharedCacheMapObject *captive_shared_cache_map_object;
260
261         g_return_val_if_fail(FileObject!=NULL,NULL);
262         g_return_val_if_fail(FileObject->SectionObjectPointers!=NULL,NULL);
263         g_return_val_if_fail(FileSizes!=NULL,NULL);
264         g_return_val_if_fail(CallBacks!=NULL,NULL);
265
266         if ((captive_shared_cache_map_object=FileObject->SectionObjectPointers->SharedCacheMap)) {
267                 captive_shared_cache_map_w32_ref(captive_shared_cache_map_object);
268                 }
269         else {
270                 captive_shared_cache_map_object=g_object_new(
271                                 CAPTIVE_SHARED_CACHE_MAP_TYPE_OBJECT,   /* object_type */
272                                 NULL);  /* first_property_name; FIXME: support properties */
273
274                 /* W32 references twice. */
275                 ObReferenceObject(FileObject);
276                 captive_shared_cache_map_object->FileObject=FileObject;
277                 captive_shared_cache_map_object->SectionObjectPointers=FileObject->SectionObjectPointers;
278                 captive_shared_cache_map_object->AllocationSize=0;
279                 captive_shared_cache_map_object->FileSize=0;
280                 captive_shared_cache_map_object->ValidDataLength=0;
281                 captive_shared_cache_map_object->PinAccess=PinAccess;
282                 captive_shared_cache_map_object->CallBacks=*CallBacks;
283                 captive_shared_cache_map_object->LazyWriterContext=LazyWriterContext;
284
285                 FileObject->SectionObjectPointers->SharedCacheMap=captive_shared_cache_map_object;
286                 }
287
288         g_assert(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
289         /* FileObject may differ - we can have a different reference to the same FCB. */
290         g_assert(FileObject->SectionObjectPointers==captive_shared_cache_map_object->SectionObjectPointers);
291         g_assert(PinAccess==captive_shared_cache_map_object->PinAccess);
292         g_assert(CallBacks->AcquireForLazyWrite==captive_shared_cache_map_object->CallBacks.AcquireForLazyWrite);
293         g_assert(CallBacks->ReleaseFromLazyWrite==captive_shared_cache_map_object->CallBacks.ReleaseFromLazyWrite);
294         g_assert(CallBacks->AcquireForReadAhead==captive_shared_cache_map_object->CallBacks.AcquireForReadAhead);
295         g_assert(CallBacks->ReleaseFromReadAhead==captive_shared_cache_map_object->CallBacks.ReleaseFromReadAhead);
296         g_assert(LazyWriterContext==captive_shared_cache_map_object->LazyWriterContext);
297
298         captive_shared_cache_map_FileSizes_set(captive_shared_cache_map_object,FileSizes);
299
300         return captive_shared_cache_map_object;
301 }
302
303 void captive_shared_cache_map_FileSizes_set(CaptiveSharedCacheMapObject *captive_shared_cache_map_object,
304                 const CC_FILE_SIZES *FileSizes)
305 {
306 guint64 AllocationSize,FileSize,ValidDataLength;
307
308         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
309         g_return_if_fail(FileSizes!=NULL);
310
311         AllocationSize=FileSizes->AllocationSize.QuadPart;
312         FileSize=FileSizes->FileSize.QuadPart;
313         ValidDataLength=FileSizes->ValidDataLength.QuadPart;
314
315         if (ValidDataLength==G_MAXINT64)
316                 ValidDataLength=FileSize;
317
318         g_assert(AllocationSize>=0);
319         g_assert(FileSize>=0);
320         g_assert(ValidDataLength>=0);
321
322         g_assert(ValidDataLength<=FileSize);
323         /* Do not: g_assert(0==(AllocationSize%0x200));
324          * as it is true for ntfs.sys of NT-5.1sp1 but it fails for fastfat.sys of NT-5.1sp1.
325          */
326         /* AllocationSize can be much higher: */
327         g_assert(FileSize<=AllocationSize);
328
329         /* Prevent signalling if not needed as signal is forbidden in captive_shared_cache_map_object_finalize() */
330         if (0
331                         || captive_shared_cache_map_object->AllocationSize!=AllocationSize
332                         || captive_shared_cache_map_object->FileSize!=FileSize
333                         || captive_shared_cache_map_object->ValidDataLength!=ValidDataLength)
334                 g_signal_emit(captive_shared_cache_map_object,FileSizes_changed_signal,0,
335                                 AllocationSize,FileSize,ValidDataLength);
336
337         g_assert(captive_shared_cache_map_object->AllocationSize==AllocationSize);
338         g_assert(captive_shared_cache_map_object->FileSize==FileSize);
339         g_assert(captive_shared_cache_map_object->ValidDataLength==ValidDataLength);
340 }
341
342 CaptiveSharedCacheMapObject *captive_SectionObjectPointers_to_SharedCacheMap(SECTION_OBJECT_POINTERS *SectionObjectPointers)
343 {
344         g_return_val_if_fail(SectionObjectPointers!=NULL,NULL);
345         g_return_val_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(SectionObjectPointers->SharedCacheMap),NULL);
346
347         return SectionObjectPointers->SharedCacheMap;
348 }
349
350 CaptiveSharedCacheMapObject *captive_FileObject_to_SharedCacheMap(FILE_OBJECT *FileObject)
351 {
352         g_return_val_if_fail(FileObject!=NULL,NULL);
353
354         return captive_SectionObjectPointers_to_SharedCacheMap(FileObject->SectionObjectPointers);
355 }
356
357 void captive_shared_cache_map_w32_ref(CaptiveSharedCacheMapObject *captive_shared_cache_map_object)
358 {
359         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
360
361         g_object_ref(captive_shared_cache_map_object);
362         captive_shared_cache_map_object->w32_ref_count++;
363 }
364
365 void captive_shared_cache_map_w32_unref(CaptiveSharedCacheMapObject *captive_shared_cache_map_object)
366 {
367         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
368         g_return_if_fail(G_OBJECT(captive_shared_cache_map_object)->ref_count>0);
369
370         if (captive_shared_cache_map_object->w32_ref_count==1) {
371 static const CC_FILE_SIZES FileSizes_zero;
372
373                 g_assert(G_OBJECT(captive_shared_cache_map_object)->ref_count==1);
374
375                 /* Prevent such truncation in captive_shared_cache_map_object_finalize()
376                  * as it would do forbidden g_object_ref() there.
377                  */
378                 captive_shared_cache_map_FileSizes_set(captive_shared_cache_map_object,&FileSizes_zero);
379                 g_assert(captive_shared_cache_map_object->buffer==NULL);
380                 g_assert(captive_shared_cache_map_object->pages==NULL);
381                 }
382
383         captive_shared_cache_map_object->w32_ref_count--;
384         g_object_unref(captive_shared_cache_map_object);
385 }
386
387 void captive_shared_cache_map_data_validate_read(CaptiveSharedCacheMapObject *captive_shared_cache_map_object,
388                 FILE_OBJECT *FileObject,guint64 start,guint64 end)
389 {
390 guint64 now;
391 gboolean after_eof=FALSE;       /* Did we reached the end of file already? */
392
393         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
394         g_return_if_fail(captive_shared_cache_map_object==captive_FileObject_to_SharedCacheMap(FileObject));
395         g_return_if_fail(start<=end);
396         g_return_if_fail(end<=CAPTIVE_ROUND_UP64(captive_shared_cache_map_object->AllocationSize,PAGE_SIZE));
397
398         start=CAPTIVE_ROUND_DOWN64(start,PAGE_SIZE);
399         end=CAPTIVE_ROUND_UP64(end,PAGE_SIZE);
400
401         for (now=start;now<end;now+=PAGE_SIZE) {
402 LARGE_INTEGER now_LargeInteger;
403 ULONG got;
404
405                 if (captive_shared_cache_map_object->pages[now/PAGE_SIZE].data_valid)
406                         continue;
407                 now_LargeInteger.QuadPart=now;
408                 got=captive_Cc_IoPageRead(FileObject,captive_shared_cache_map_object->buffer+now,PAGE_SIZE,&now_LargeInteger);
409                 if (after_eof)
410                         g_assert(got==0);
411                 else
412                         g_assert(got<=PAGE_SIZE);
413                 after_eof=(got<PAGE_SIZE);
414                 captive_shared_cache_map_object->pages[now/PAGE_SIZE].data_valid=TRUE;
415                 }
416 }
417
418 void captive_shared_cache_map_data_validate_noread(CaptiveSharedCacheMapObject *captive_shared_cache_map_object,
419                 guint64 start,guint64 end)
420 {
421 guint64 now;
422
423         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
424         g_return_if_fail(start<=end);
425         g_return_if_fail(end<=CAPTIVE_ROUND_UP64(captive_shared_cache_map_object->AllocationSize,PAGE_SIZE));
426
427         start=CAPTIVE_ROUND_DOWN64(start,PAGE_SIZE);
428         end=CAPTIVE_ROUND_UP64(end,PAGE_SIZE);
429
430         for (now=start;now<end;now+=PAGE_SIZE) {
431                 g_assert(captive_shared_cache_map_object->pages[now/PAGE_SIZE].data_valid);
432                 }
433 }
434
435 void captive_shared_cache_map_set_data_valid(CaptiveSharedCacheMapObject *captive_shared_cache_map_object,
436                 guint64 start,guint64 end)
437 {
438 guint64 now;
439
440         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
441         g_return_if_fail(start<=end);
442         g_return_if_fail(end<=CAPTIVE_ROUND_UP64(captive_shared_cache_map_object->AllocationSize,PAGE_SIZE));
443
444         start=CAPTIVE_ROUND_DOWN64(start,PAGE_SIZE);
445         end=CAPTIVE_ROUND_UP64(end,PAGE_SIZE);
446
447         for (now=start;now<end;now+=PAGE_SIZE) {
448                 captive_shared_cache_map_object->pages[now/PAGE_SIZE].data_valid=TRUE;
449                 }
450 }
451
452 void captive_shared_cache_map_set_dirty(CaptiveSharedCacheMapObject *captive_shared_cache_map_object,
453                 guint64 start,guint64 end)
454 {
455 guint64 now;
456 CaptiveSharedCacheMapObject_page *page;
457
458         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
459         g_return_if_fail(end<=CAPTIVE_ROUND_UP64(captive_shared_cache_map_object->AllocationSize,PAGE_SIZE));
460
461         start=CAPTIVE_ROUND_DOWN64(start,PAGE_SIZE);
462         end=CAPTIVE_ROUND_UP64(end,PAGE_SIZE);
463
464         for (now=start;now<end;now+=PAGE_SIZE) {
465                 page=captive_shared_cache_map_object->pages+now/PAGE_SIZE;
466                 g_assert(page->data_valid);
467                 if (!page->dirty) {
468                         page->dirty=TRUE;
469                         page->lsn_oldest=0;
470                         page->lsn_newest=0;
471                         }
472                 }
473 }
474
475 gboolean captive_shared_cache_map_is_page_dirty(CaptiveSharedCacheMapObject *captive_shared_cache_map_object,
476                 guint64 offset)
477 {
478 CaptiveSharedCacheMapObject_page *page;
479
480         g_return_val_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object),FALSE);
481         g_return_val_if_fail(offset<CAPTIVE_ROUND_UP64(captive_shared_cache_map_object->AllocationSize,PAGE_SIZE),FALSE);
482         g_return_val_if_fail(0==CAPTIVE_ROUND_DOWN_EXCEEDING64(offset,PAGE_SIZE),FALSE);
483         page=captive_shared_cache_map_object->pages+offset/PAGE_SIZE;
484         g_return_val_if_fail(page->data_valid,FALSE);
485
486         return page->dirty;
487 }
488
489 void captive_shared_cache_map_page_set_lsn(CaptiveSharedCacheMapObject *captive_shared_cache_map_object,
490                 guint64 offset,gint64 lsn)
491 {
492 CaptiveSharedCacheMapObject_page *page;
493
494         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
495         g_return_if_fail(offset<=CAPTIVE_ROUND_UP64(captive_shared_cache_map_object->AllocationSize,PAGE_SIZE));
496         g_return_if_fail(0==CAPTIVE_ROUND_DOWN_EXCEEDING64(offset,PAGE_SIZE));
497         page=captive_shared_cache_map_object->pages+offset/PAGE_SIZE;
498         g_return_if_fail(page->data_valid);
499         g_return_if_fail(page->dirty);
500         g_return_if_fail(page->lsn_oldest<=page->lsn_newest);
501         g_return_if_fail(!page->lsn_newest || lsn>=page->lsn_newest);
502         g_return_if_fail(captive_shared_cache_map_object->LogHandle_set);
503         g_return_if_fail(captive_shared_cache_map_object->FlushToLsnRoutine_set);
504
505         if (!page->lsn_oldest)
506                 page->lsn_oldest=lsn;
507         page->lsn_newest=lsn;
508 }
509
510 void captive_shared_cache_map_purge(CaptiveSharedCacheMapObject *captive_shared_cache_map_object)
511 {
512 guint64 offset;
513 CaptiveSharedCacheMapObject_page *page;
514
515         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
516
517         g_signal_emit(captive_shared_cache_map_object,purge_signal,0);
518
519         for (offset=0;offset<CAPTIVE_ROUND_UP64(captive_shared_cache_map_object->AllocationSize,PAGE_SIZE);offset+=PAGE_SIZE) {
520                 page=captive_shared_cache_map_object->pages+offset/PAGE_SIZE;
521                 if (!page->data_valid)
522                         continue;
523                 g_assert(!page->dirty); /* FIXME: Is it allowed by W32? */
524                 page->data_valid=FALSE;
525                 }
526 }
527
528 static VOID *captive_LogHandle;
529 static PFLUSH_TO_LSN captive_FlushToLsnRoutine;
530
531 void captive_shared_cache_map_set_LogHandle(CaptiveSharedCacheMapObject *captive_shared_cache_map_object,VOID *LogHandle)
532 {
533         g_return_if_fail(!captive_shared_cache_map_object || CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
534         /* FIXME: 'captive_shared_cache_map_object->LogHandle_set' may be set.
535          * Does it mean 'LogHandle_set' is 'FileObject'-based instead of 'SharedCacheMap'-based?
536          */
537
538         if (!LogHandle)
539                 return;
540         g_assert(!captive_LogHandle || captive_LogHandle==LogHandle);
541         captive_LogHandle=LogHandle;
542         if (LogHandle && captive_shared_cache_map_object)
543                 captive_shared_cache_map_object->LogHandle_set=TRUE;
544 }
545
546 void captive_shared_cache_map_set_FlushToLsnRoutine
547                 (CaptiveSharedCacheMapObject *captive_shared_cache_map_object,PFLUSH_TO_LSN FlushToLsnRoutine)
548 {
549         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
550         /* FIXME: 'captive_shared_cache_map_object->FlushToLsnRoutine_set' may be set.
551          * Does it mean 'FlushToLsnRoutine_set' is 'FileObject'-based instead of 'SharedCacheMap'-based?
552          */
553
554         if (!FlushToLsnRoutine)
555                 return;
556         g_assert(!captive_FlushToLsnRoutine || captive_FlushToLsnRoutine==FlushToLsnRoutine);
557         captive_FlushToLsnRoutine=FlushToLsnRoutine;
558         if (FlushToLsnRoutine)
559                 captive_shared_cache_map_object->FlushToLsnRoutine_set=TRUE;
560 }
561
562 static void captive_shared_cache_map_page_write(CaptiveSharedCacheMapObject *captive_shared_cache_map_object,
563                 guint64 offset)
564 {
565 LARGE_INTEGER offset_LargeInteger;
566 static gint64 lsn_last;
567 CaptiveSharedCacheMapObject_page *page;
568
569         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
570         g_return_if_fail(captive_shared_cache_map_object->FileObject!=NULL);
571         g_return_if_fail(offset<=CAPTIVE_ROUND_UP64(captive_shared_cache_map_object->AllocationSize,PAGE_SIZE));
572         g_return_if_fail(0==CAPTIVE_ROUND_DOWN_EXCEEDING64(offset,PAGE_SIZE));
573         page=captive_shared_cache_map_object->pages+offset/PAGE_SIZE;
574         g_return_if_fail(page->data_valid);
575         g_return_if_fail(page->dirty);
576
577         if (page->lsn_newest) {
578 LARGE_INTEGER lsn_newest_LargeInteger;
579
580                 /* sanity check */
581                 g_assert(!lsn_last || lsn_last<=page->lsn_newest);
582                 lsn_last=page->lsn_newest;
583
584                 lsn_newest_LargeInteger.QuadPart=page->lsn_newest;
585                 (*captive_FlushToLsnRoutine)(captive_LogHandle,lsn_newest_LargeInteger);
586                 }
587
588         offset_LargeInteger.QuadPart=offset;
589         captive_Cc_IoPageWrite(captive_shared_cache_map_object->FileObject,
590                         captive_shared_cache_map_object->buffer+offset,PAGE_SIZE,&offset_LargeInteger);
591
592         page->dirty=FALSE;
593         page->lsn_oldest=0;
594         page->lsn_newest=0;
595 }
596
597 typedef struct _captive_shared_cache_map_page_write_lsn_foreach_param captive_shared_cache_map_page_write_lsn_foreach_param;
598 struct _captive_shared_cache_map_page_write_lsn_foreach_param {
599         gint64 lsn_target;
600         gint64 lsn_best;
601         CaptiveSharedCacheMapObject *captive_shared_cache_map_object_best;
602         guint64 offset_best;
603         };
604
605 static void captive_shared_cache_map_page_write_lsn_foreach(
606                 CaptiveSharedCacheMapObject *captive_shared_cache_map_object,  /* key */
607                 CaptiveSharedCacheMapObject *captive_shared_cache_map_object_value,  /* value */
608                 captive_shared_cache_map_page_write_lsn_foreach_param *param)   /* user_data */
609 {
610 guint64 now;
611 CaptiveSharedCacheMapObject_page *page;
612
613         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
614         g_return_if_fail(captive_shared_cache_map_object==captive_shared_cache_map_object_value);
615         g_return_if_fail(param!=NULL);
616
617         for (now=0;now<captive_shared_cache_map_object->AllocationSize;now+=PAGE_SIZE) {
618                 page=captive_shared_cache_map_object->pages+now/PAGE_SIZE;
619                 if (!page->data_valid)
620                         continue;
621                 if (!page->dirty)
622                         continue;
623                 if (!page->lsn_newest)
624                         continue;
625                 if (page->lsn_newest>=param->lsn_target)
626                         continue;
627                 if (param->lsn_best && page->lsn_newest>param->lsn_best)
628                         continue;
629                 param->lsn_best=page->lsn_newest;
630                 param->captive_shared_cache_map_object_best=captive_shared_cache_map_object;
631                 param->offset_best=now;
632                 }
633 }
634
635 static void captive_shared_cache_map_page_write_lsn(CaptiveSharedCacheMapObject *captive_shared_cache_map_object,
636                 guint64 offset)
637 {
638 CaptiveSharedCacheMapObject_page *page;
639
640         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
641         g_return_if_fail(captive_shared_cache_map_object->FileObject!=NULL);
642         g_return_if_fail(offset<CAPTIVE_ROUND_UP64(captive_shared_cache_map_object->AllocationSize,PAGE_SIZE));
643         g_return_if_fail(0==CAPTIVE_ROUND_DOWN_EXCEEDING64(offset,PAGE_SIZE));
644         page=captive_shared_cache_map_object->pages+offset/PAGE_SIZE;
645         g_return_if_fail(page->data_valid);
646         g_return_if_fail(page->dirty);
647
648         if (page->lsn_newest) {
649                 CaptiveSharedCacheMapObject_hash_init();
650                 for (;;) {
651 captive_shared_cache_map_page_write_lsn_foreach_param param;
652
653                         param.lsn_target=page->lsn_newest;
654                         param.lsn_best=0;
655                         g_hash_table_foreach(
656                                         CaptiveSharedCacheMapObject_hash,       /* hash_table */
657                                         (GHFunc)captive_shared_cache_map_page_write_lsn_foreach,        /* func */
658                                         &param);        /* user_data */
659                         if (!param.lsn_best)
660                                 break;
661                         captive_shared_cache_map_page_write(param.captive_shared_cache_map_object_best,param.offset_best);
662                         }
663                 }
664
665         captive_shared_cache_map_page_write(captive_shared_cache_map_object,offset);
666 }
667
668 guint64 captive_shared_cache_map_flush(CaptiveSharedCacheMapObject *captive_shared_cache_map_object,
669                 guint64 start,guint64 end)
670 {
671 guint64 flushed;
672 guint64 now;
673
674         g_return_val_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object),0);
675         g_return_val_if_fail(start<=end,0);
676
677         end=MIN(end,CAPTIVE_ROUND_UP64(captive_shared_cache_map_object->AllocationSize,PAGE_SIZE));
678
679         start=CAPTIVE_ROUND_DOWN64(start,PAGE_SIZE);
680         end=CAPTIVE_ROUND_UP64(end,PAGE_SIZE);
681
682         flushed=0;
683         for (now=start;now<end;now+=PAGE_SIZE) {
684                 if (!captive_shared_cache_map_object->pages[now/PAGE_SIZE].data_valid)
685                         continue;
686                 if (!captive_shared_cache_map_object->pages[now/PAGE_SIZE].dirty)
687                         continue;
688                 captive_shared_cache_map_page_write_lsn(captive_shared_cache_map_object,now);
689                 flushed+=PAGE_SIZE;
690                 }
691
692         /* We were calling W32 code - recheck our task completion. */
693         for (now=start;now<end;now+=PAGE_SIZE) {
694                 if (!captive_shared_cache_map_object->pages[now/PAGE_SIZE].data_valid)
695                         continue;
696                 g_assert(!captive_shared_cache_map_object->pages[now/PAGE_SIZE].dirty);
697                 }
698
699         return flushed;
700 }
701
702 static void captive_shared_cache_map_is_any_dirty_foreach(
703                 CaptiveSharedCacheMapObject *captive_shared_cache_map_object,  /* key */
704                 CaptiveSharedCacheMapObject *captive_shared_cache_map_object_value,  /* value */
705                 gboolean *dirty_foundp) /* user_data */
706 {
707 guint64 now;
708
709         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
710         g_return_if_fail(captive_shared_cache_map_object==captive_shared_cache_map_object_value);
711         g_return_if_fail(dirty_foundp!=NULL);
712
713         for (now=0;now<captive_shared_cache_map_object->AllocationSize;now+=PAGE_SIZE) {
714                 if (!captive_shared_cache_map_object->pages[now/PAGE_SIZE].data_valid)
715                         continue;
716                 if (!captive_shared_cache_map_object->pages[now/PAGE_SIZE].dirty)
717                         continue;
718                 *dirty_foundp=TRUE;     /* FIXME: stop the traversal. */
719                 break;
720                 }
721 }
722
723
724 gboolean captive_shared_cache_map_is_any_dirty(void)
725 {
726 gboolean dirty_found;
727
728         CaptiveSharedCacheMapObject_hash_init();
729         dirty_found=FALSE;
730         g_hash_table_foreach(
731                         CaptiveSharedCacheMapObject_hash,       /* hash_table */
732                         (GHFunc)captive_shared_cache_map_is_any_dirty_foreach,  /* func */
733                         &dirty_found);  /* user_data */
734
735         return dirty_found;
736 }
737
738
739 typedef struct _captive_shared_cache_map_CcGetDirtyPages_foreach_param captive_shared_cache_map_CcGetDirtyPages_foreach_param;
740 struct _captive_shared_cache_map_CcGetDirtyPages_foreach_param {
741         PDIRTY_PAGE_ROUTINE DirtyPageRoutine;
742         VOID *Context1;
743         VOID *Context2;
744         gint64 result;
745         };
746
747 static void captive_shared_cache_map_CcGetDirtyPages_foreach(
748                 CaptiveSharedCacheMapObject *captive_shared_cache_map_object,  /* key */
749                 CaptiveSharedCacheMapObject *captive_shared_cache_map_object_value,  /* value */
750                 captive_shared_cache_map_CcGetDirtyPages_foreach_param *param)  /* user_data */
751 {
752 gint64 now;
753 CaptiveSharedCacheMapObject_page *page;
754
755         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
756         g_return_if_fail(captive_shared_cache_map_object->FileObject!=NULL);
757         g_return_if_fail(captive_shared_cache_map_object==captive_shared_cache_map_object_value);
758         g_return_if_fail(param!=NULL);
759
760         for (now=CAPTIVE_ROUND_DOWN64(captive_shared_cache_map_object->AllocationSize-1,PAGE_SIZE);now>=0;now-=PAGE_SIZE) {
761 LARGE_INTEGER now_LargeInteger,lsn_oldest_LargeInteger,lsn_newest_LargeInteger;
762
763                 page=captive_shared_cache_map_object->pages+now/PAGE_SIZE;
764                 if (!page->data_valid)
765                         continue;
766                 if (!page->dirty)
767                         continue;
768                 if (page->lsn_oldest && (!param->result || param->result>page->lsn_oldest))
769                         param->result=page->lsn_oldest;
770
771                 now_LargeInteger.QuadPart=now;
772                 lsn_oldest_LargeInteger.QuadPart=page->lsn_oldest;
773                 lsn_newest_LargeInteger.QuadPart=page->lsn_newest;
774                 (*param->DirtyPageRoutine)(
775                                 captive_shared_cache_map_object->FileObject,    /* FileObject */
776                                 &now_LargeInteger,      /* FileOffset */
777                                 PAGE_SIZE,      /* Length */
778                                 &lsn_oldest_LargeInteger,       /* OldestLsn */
779                                 &lsn_newest_LargeInteger,       /* NewestLsn */
780                                 param->Context1,        /* Context1 */
781                                 param->Context2);       /* Context2 */
782                 }
783 }
784
785 gint64 captive_shared_cache_map_CcGetDirtyPages(PDIRTY_PAGE_ROUTINE DirtyPageRoutine,VOID *Context1,VOID *Context2)
786 {
787 captive_shared_cache_map_CcGetDirtyPages_foreach_param param;
788
789         g_return_val_if_fail(DirtyPageRoutine!=NULL,0);
790
791         param.DirtyPageRoutine=DirtyPageRoutine;
792         param.Context1=Context1;
793         param.Context2=Context2;
794         param.result=0;
795
796         CaptiveSharedCacheMapObject_hash_init();
797         g_hash_table_foreach(
798                         CaptiveSharedCacheMapObject_hash,       /* hash_table */
799                         (GHFunc)captive_shared_cache_map_CcGetDirtyPages_foreach,       /* func */
800                         &param);        /* user_data */
801
802         return param.result;
803 }
804
805 gpointer captive_shared_cache_map_get_buffer(CaptiveSharedCacheMapObject *captive_shared_cache_map_object)
806 {
807         g_return_val_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object),NULL);
808         g_return_val_if_fail(captive_shared_cache_map_object->buffer!=NULL,NULL);
809
810         return captive_shared_cache_map_object->buffer;
811 }
812
813 static void captive_cc_FileObject_delete_foreach(
814                 CaptiveSharedCacheMapObject *captive_shared_cache_map_object,  /* key */
815                 CaptiveSharedCacheMapObject *captive_shared_cache_map_object_value,  /* value */
816                 FILE_OBJECT *FileObject)        /* user_data */
817 {
818         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
819         g_return_if_fail(captive_shared_cache_map_object==captive_shared_cache_map_object_value);
820         g_return_if_fail(FileObject!=NULL);
821
822         g_assert(FileObject!=captive_shared_cache_map_object->FileObject);
823 }
824
825 BOOLEAN captive_cc_FileObject_delete(FILE_OBJECT *FileObject)
826 {
827         g_return_val_if_fail(FileObject!=NULL,FALSE);
828
829         CaptiveSharedCacheMapObject_hash_init();
830         g_hash_table_foreach(
831                         CaptiveSharedCacheMapObject_hash,       /* hash_table */
832                         (GHFunc)captive_cc_FileObject_delete_foreach,   /* func */
833                         FileObject);    /* user_data */
834
835         return FALSE;   /* FIXME: remove useless return code. */
836 }