44c1dcdf5a2cac24bdef7c0f81bb56131f654b2c
[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 (size_old>size_new) {
224 guint64 now;
225
226                         for (now=size_new;now<size_old;now+=PAGE_SIZE) {
227                                 if (!captive_shared_cache_map_object->pages[now/PAGE_SIZE].data_valid)
228                                         continue;
229                                 g_assert(!captive_shared_cache_map_object->pages[now/PAGE_SIZE].dirty);
230                                 }
231                         }
232                 captive_shared_cache_map_object->pages=g_realloc(captive_shared_cache_map_object->pages,
233                                 size_new/PAGE_SIZE*sizeof(*captive_shared_cache_map_object->pages));
234                 if (size_new>size_old)  /* prevent 'size_new-size_old' as it is unsigned! */
235                         memset(captive_shared_cache_map_object->pages+(size_old/PAGE_SIZE),0,
236                                         (size_new-size_old)/PAGE_SIZE*sizeof(*captive_shared_cache_map_object->pages));
237                 }
238
239         captive_shared_cache_map_object->AllocationSize=AllocationSize;
240         captive_shared_cache_map_object->FileSize=FileSize;
241         captive_shared_cache_map_object->ValidDataLength=ValidDataLength;
242
243         g_assert((!captive_shared_cache_map_object->buffer)==(!captive_shared_cache_map_object->AllocationSize));
244         g_assert((!captive_shared_cache_map_object->pages)==(!captive_shared_cache_map_object->AllocationSize));
245 }
246
247 static void captive_shared_cache_map_object_purge(CaptiveSharedCacheMapObject *captive_shared_cache_map_object)
248 {
249         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
250
251         /* NOP; just to provide slot for checking by Bcbs */
252 }
253
254 CaptiveSharedCacheMapObject *captive_shared_cache_map_get_ref(FILE_OBJECT *FileObject,
255                 const CC_FILE_SIZES *FileSizes,BOOLEAN PinAccess,CACHE_MANAGER_CALLBACKS *CallBacks,VOID *LazyWriterContext)
256 {
257 CaptiveSharedCacheMapObject *captive_shared_cache_map_object;
258
259         g_return_val_if_fail(FileObject!=NULL,NULL);
260         g_return_val_if_fail(FileObject->SectionObjectPointers!=NULL,NULL);
261         g_return_val_if_fail(FileSizes!=NULL,NULL);
262         g_return_val_if_fail(CallBacks!=NULL,NULL);
263
264         if ((captive_shared_cache_map_object=FileObject->SectionObjectPointers->SharedCacheMap)) {
265                 captive_shared_cache_map_w32_ref(captive_shared_cache_map_object);
266                 }
267         else {
268                 captive_shared_cache_map_object=g_object_new(
269                                 CAPTIVE_SHARED_CACHE_MAP_TYPE_OBJECT,   /* object_type */
270                                 NULL);  /* first_property_name; FIXME: support properties */
271
272                 /* W32 references twice. */
273                 ObReferenceObject(FileObject);
274                 captive_shared_cache_map_object->FileObject=FileObject;
275                 captive_shared_cache_map_object->SectionObjectPointers=FileObject->SectionObjectPointers;
276                 captive_shared_cache_map_object->AllocationSize=0;
277                 captive_shared_cache_map_object->FileSize=0;
278                 captive_shared_cache_map_object->ValidDataLength=0;
279                 captive_shared_cache_map_object->PinAccess=PinAccess;
280                 captive_shared_cache_map_object->CallBacks=*CallBacks;
281                 captive_shared_cache_map_object->LazyWriterContext=LazyWriterContext;
282
283                 FileObject->SectionObjectPointers->SharedCacheMap=captive_shared_cache_map_object;
284                 }
285
286         g_assert(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
287         /* FileObject may differ - we can have a different reference to the same FCB. */
288         g_assert(FileObject->SectionObjectPointers==captive_shared_cache_map_object->SectionObjectPointers);
289         g_assert(PinAccess==captive_shared_cache_map_object->PinAccess);
290         g_assert(CallBacks->AcquireForLazyWrite==captive_shared_cache_map_object->CallBacks.AcquireForLazyWrite);
291         g_assert(CallBacks->ReleaseFromLazyWrite==captive_shared_cache_map_object->CallBacks.ReleaseFromLazyWrite);
292         g_assert(CallBacks->AcquireForReadAhead==captive_shared_cache_map_object->CallBacks.AcquireForReadAhead);
293         g_assert(CallBacks->ReleaseFromReadAhead==captive_shared_cache_map_object->CallBacks.ReleaseFromReadAhead);
294         g_assert(LazyWriterContext==captive_shared_cache_map_object->LazyWriterContext);
295
296         captive_shared_cache_map_FileSizes_set(captive_shared_cache_map_object,FileSizes);
297
298         return captive_shared_cache_map_object;
299 }
300
301 void captive_shared_cache_map_FileSizes_set(CaptiveSharedCacheMapObject *captive_shared_cache_map_object,
302                 const CC_FILE_SIZES *FileSizes)
303 {
304 guint64 AllocationSize,FileSize,ValidDataLength;
305
306         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
307         g_return_if_fail(FileSizes!=NULL);
308
309         AllocationSize=FileSizes->AllocationSize.QuadPart;
310         FileSize=FileSizes->FileSize.QuadPart;
311         ValidDataLength=FileSizes->ValidDataLength.QuadPart;
312
313         if (ValidDataLength==G_MAXINT64)
314                 ValidDataLength=FileSize;
315
316         g_assert(AllocationSize>=0);
317         g_assert(FileSize>=0);
318         g_assert(ValidDataLength>=0);
319
320         g_assert(ValidDataLength<=FileSize);
321         /* Do not: g_assert(0==(AllocationSize%0x200));
322          * as it is true for ntfs.sys of NT-5.1sp1 but it fails for fastfat.sys of NT-5.1sp1.
323          */
324         /* AllocationSize can be much higher: */
325         g_assert(FileSize<=AllocationSize);
326
327         /* Prevent signalling if not needed as signal is forbidden in captive_shared_cache_map_object_finalize() */
328         if (0
329                         || captive_shared_cache_map_object->AllocationSize!=AllocationSize
330                         || captive_shared_cache_map_object->FileSize!=FileSize
331                         || captive_shared_cache_map_object->ValidDataLength!=ValidDataLength)
332                 g_signal_emit(captive_shared_cache_map_object,FileSizes_changed_signal,0,
333                                 AllocationSize,FileSize,ValidDataLength);
334
335         g_assert(captive_shared_cache_map_object->AllocationSize==AllocationSize);
336         g_assert(captive_shared_cache_map_object->FileSize==FileSize);
337         g_assert(captive_shared_cache_map_object->ValidDataLength==ValidDataLength);
338 }
339
340 CaptiveSharedCacheMapObject *captive_SectionObjectPointers_to_SharedCacheMap(SECTION_OBJECT_POINTERS *SectionObjectPointers)
341 {
342         g_return_val_if_fail(SectionObjectPointers!=NULL,NULL);
343         g_return_val_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(SectionObjectPointers->SharedCacheMap),NULL);
344
345         return SectionObjectPointers->SharedCacheMap;
346 }
347
348 CaptiveSharedCacheMapObject *captive_FileObject_to_SharedCacheMap(FILE_OBJECT *FileObject)
349 {
350         g_return_val_if_fail(FileObject!=NULL,NULL);
351
352         return captive_SectionObjectPointers_to_SharedCacheMap(FileObject->SectionObjectPointers);
353 }
354
355 void captive_shared_cache_map_w32_ref(CaptiveSharedCacheMapObject *captive_shared_cache_map_object)
356 {
357         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
358
359         g_object_ref(captive_shared_cache_map_object);
360         captive_shared_cache_map_object->w32_ref_count++;
361 }
362
363 void captive_shared_cache_map_w32_unref(CaptiveSharedCacheMapObject *captive_shared_cache_map_object)
364 {
365         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
366         g_return_if_fail(G_OBJECT(captive_shared_cache_map_object)->ref_count>0);
367
368         if (captive_shared_cache_map_object->w32_ref_count==1) {
369 static const CC_FILE_SIZES FileSizes_zero;
370
371                 g_assert(G_OBJECT(captive_shared_cache_map_object)->ref_count==1);
372
373                 /* Prevent such truncation in captive_shared_cache_map_object_finalize()
374                  * as it would do forbidden g_object_ref() there.
375                  */
376                 captive_shared_cache_map_FileSizes_set(captive_shared_cache_map_object,&FileSizes_zero);
377                 g_assert(captive_shared_cache_map_object->buffer==NULL);
378                 g_assert(captive_shared_cache_map_object->pages==NULL);
379                 }
380
381         captive_shared_cache_map_object->w32_ref_count--;
382         g_object_unref(captive_shared_cache_map_object);
383 }
384
385 void captive_shared_cache_map_data_validate_read(CaptiveSharedCacheMapObject *captive_shared_cache_map_object,
386                 FILE_OBJECT *FileObject,guint64 start,guint64 end)
387 {
388 guint64 now;
389 gboolean after_eof=FALSE;       /* Did we reached the end of file already? */
390
391         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
392         g_return_if_fail(captive_shared_cache_map_object==captive_FileObject_to_SharedCacheMap(FileObject));
393         g_return_if_fail(start<=end);
394         g_return_if_fail(end<=CAPTIVE_ROUND_UP64(captive_shared_cache_map_object->FileSize,PAGE_SIZE));
395
396         start=CAPTIVE_ROUND_DOWN64(start,PAGE_SIZE);
397         end=CAPTIVE_ROUND_UP64(end,PAGE_SIZE);
398
399         for (now=start;now<end;now+=PAGE_SIZE) {
400 LARGE_INTEGER now_LargeInteger;
401 ULONG got;
402
403                 if (captive_shared_cache_map_object->pages[now/PAGE_SIZE].data_valid)
404                         continue;
405                 now_LargeInteger.QuadPart=now;
406                 got=captive_Cc_IoPageRead(FileObject,captive_shared_cache_map_object->buffer+now,PAGE_SIZE,&now_LargeInteger);
407                 if (after_eof)
408                         g_assert(got==0);
409                 else
410                         g_assert(got<=PAGE_SIZE);
411                 after_eof=(got<PAGE_SIZE);
412                 captive_shared_cache_map_object->pages[now/PAGE_SIZE].data_valid=TRUE;
413                 }
414 }
415
416 void captive_shared_cache_map_data_validate_noread(CaptiveSharedCacheMapObject *captive_shared_cache_map_object,
417                 guint64 start,guint64 end)
418 {
419 guint64 now;
420
421         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
422         g_return_if_fail(start<=end);
423         g_return_if_fail(end<=CAPTIVE_ROUND_UP64(captive_shared_cache_map_object->FileSize,PAGE_SIZE));
424
425         start=CAPTIVE_ROUND_DOWN64(start,PAGE_SIZE);
426         end=CAPTIVE_ROUND_UP64(end,PAGE_SIZE);
427
428         for (now=start;now<end;now+=PAGE_SIZE) {
429                 g_assert(captive_shared_cache_map_object->pages[now/PAGE_SIZE].data_valid);
430                 }
431 }
432
433 void captive_shared_cache_map_set_data_valid(CaptiveSharedCacheMapObject *captive_shared_cache_map_object,
434                 guint64 start,guint64 end)
435 {
436 guint64 now;
437
438         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
439         g_return_if_fail(start<=end);
440         g_return_if_fail(end<=CAPTIVE_ROUND_UP64(captive_shared_cache_map_object->FileSize,PAGE_SIZE));
441
442         start=CAPTIVE_ROUND_DOWN64(start,PAGE_SIZE);
443         end=CAPTIVE_ROUND_UP64(end,PAGE_SIZE);
444
445         for (now=start;now<end;now+=PAGE_SIZE) {
446                 captive_shared_cache_map_object->pages[now/PAGE_SIZE].data_valid=TRUE;
447                 }
448 }
449
450 void captive_shared_cache_map_set_dirty(CaptiveSharedCacheMapObject *captive_shared_cache_map_object,
451                 guint64 start,guint64 end)
452 {
453 guint64 now;
454 CaptiveSharedCacheMapObject_page *page;
455
456         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
457         g_return_if_fail(end<=CAPTIVE_ROUND_UP64(captive_shared_cache_map_object->FileSize,PAGE_SIZE));
458
459         start=CAPTIVE_ROUND_DOWN64(start,PAGE_SIZE);
460         end=CAPTIVE_ROUND_UP64(end,PAGE_SIZE);
461
462         for (now=start;now<end;now+=PAGE_SIZE) {
463                 page=captive_shared_cache_map_object->pages+now/PAGE_SIZE;
464                 g_assert(page->data_valid);
465                 if (!page->dirty) {
466                         page->dirty=TRUE;
467                         page->lsn_oldest=0;
468                         page->lsn_newest=0;
469                         }
470                 }
471 }
472
473 gboolean captive_shared_cache_map_is_page_dirty(CaptiveSharedCacheMapObject *captive_shared_cache_map_object,
474                 guint64 offset)
475 {
476 CaptiveSharedCacheMapObject_page *page;
477
478         g_return_val_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object),FALSE);
479         g_return_val_if_fail(offset<CAPTIVE_ROUND_UP64(captive_shared_cache_map_object->FileSize,PAGE_SIZE),FALSE);
480         g_return_val_if_fail(0==CAPTIVE_ROUND_DOWN_EXCEEDING64(offset,PAGE_SIZE),FALSE);
481         page=captive_shared_cache_map_object->pages+offset/PAGE_SIZE;
482         g_return_val_if_fail(page->data_valid,FALSE);
483
484         return page->dirty;
485 }
486
487 void captive_shared_cache_map_page_set_lsn(CaptiveSharedCacheMapObject *captive_shared_cache_map_object,
488                 guint64 offset,gint64 lsn)
489 {
490 CaptiveSharedCacheMapObject_page *page;
491
492         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
493         g_return_if_fail(offset<=CAPTIVE_ROUND_UP64(captive_shared_cache_map_object->FileSize,PAGE_SIZE));
494         g_return_if_fail(0==CAPTIVE_ROUND_DOWN_EXCEEDING64(offset,PAGE_SIZE));
495         page=captive_shared_cache_map_object->pages+offset/PAGE_SIZE;
496         g_return_if_fail(page->data_valid);
497         g_return_if_fail(page->dirty);
498         g_return_if_fail(page->lsn_oldest<=page->lsn_newest);
499         g_return_if_fail(!page->lsn_newest || lsn>=page->lsn_newest);
500         g_return_if_fail(captive_shared_cache_map_object->LogHandle_set);
501         g_return_if_fail(captive_shared_cache_map_object->FlushToLsnRoutine_set);
502
503         if (!page->lsn_oldest)
504                 page->lsn_oldest=lsn;
505         page->lsn_newest=lsn;
506 }
507
508 void captive_shared_cache_map_purge(CaptiveSharedCacheMapObject *captive_shared_cache_map_object)
509 {
510 guint64 offset;
511 CaptiveSharedCacheMapObject_page *page;
512
513         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
514
515         g_signal_emit(captive_shared_cache_map_object,purge_signal,0);
516
517         for (offset=0;offset<CAPTIVE_ROUND_UP64(captive_shared_cache_map_object->AllocationSize,PAGE_SIZE);offset+=PAGE_SIZE) {
518                 page=captive_shared_cache_map_object->pages+offset/PAGE_SIZE;
519                 if (!page->data_valid)
520                         continue;
521                 g_assert(!page->dirty); /* FIXME: Is it allowed by W32? */
522                 page->data_valid=FALSE;
523                 }
524 }
525
526 static VOID *captive_LogHandle;
527 static PFLUSH_TO_LSN captive_FlushToLsnRoutine;
528
529 void captive_shared_cache_map_set_LogHandle(CaptiveSharedCacheMapObject *captive_shared_cache_map_object,VOID *LogHandle)
530 {
531         g_return_if_fail(!captive_shared_cache_map_object || CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
532         /* FIXME: 'captive_shared_cache_map_object->LogHandle_set' may be set.
533          * Does it mean 'LogHandle_set' is 'FileObject'-based instead of 'SharedCacheMap'-based?
534          */
535
536         if (!LogHandle)
537                 return;
538         g_assert(!captive_LogHandle || captive_LogHandle==LogHandle);
539         captive_LogHandle=LogHandle;
540         if (LogHandle && captive_shared_cache_map_object)
541                 captive_shared_cache_map_object->LogHandle_set=TRUE;
542 }
543
544 void captive_shared_cache_map_set_FlushToLsnRoutine
545                 (CaptiveSharedCacheMapObject *captive_shared_cache_map_object,PFLUSH_TO_LSN FlushToLsnRoutine)
546 {
547         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
548         /* FIXME: 'captive_shared_cache_map_object->FlushToLsnRoutine_set' may be set.
549          * Does it mean 'FlushToLsnRoutine_set' is 'FileObject'-based instead of 'SharedCacheMap'-based?
550          */
551
552         if (!FlushToLsnRoutine)
553                 return;
554         g_assert(!captive_FlushToLsnRoutine || captive_FlushToLsnRoutine==FlushToLsnRoutine);
555         captive_FlushToLsnRoutine=FlushToLsnRoutine;
556         if (FlushToLsnRoutine)
557                 captive_shared_cache_map_object->FlushToLsnRoutine_set=TRUE;
558 }
559
560 static void captive_shared_cache_map_page_write(CaptiveSharedCacheMapObject *captive_shared_cache_map_object,
561                 guint64 offset)
562 {
563 LARGE_INTEGER offset_LargeInteger;
564 static gint64 lsn_last;
565 CaptiveSharedCacheMapObject_page *page;
566
567         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
568         g_return_if_fail(captive_shared_cache_map_object->FileObject!=NULL);
569         g_return_if_fail(offset<=CAPTIVE_ROUND_UP64(captive_shared_cache_map_object->FileSize,PAGE_SIZE));
570         g_return_if_fail(0==CAPTIVE_ROUND_DOWN_EXCEEDING64(offset,PAGE_SIZE));
571         page=captive_shared_cache_map_object->pages+offset/PAGE_SIZE;
572         g_return_if_fail(page->data_valid);
573         g_return_if_fail(page->dirty);
574
575         if (page->lsn_newest) {
576 LARGE_INTEGER lsn_newest_LargeInteger;
577
578                 /* sanity check */
579                 g_assert(!lsn_last || lsn_last<=page->lsn_newest);
580                 lsn_last=page->lsn_newest;
581
582                 lsn_newest_LargeInteger.QuadPart=page->lsn_newest;
583                 (*captive_FlushToLsnRoutine)(captive_LogHandle,lsn_newest_LargeInteger);
584                 }
585
586         offset_LargeInteger.QuadPart=offset;
587         captive_Cc_IoPageWrite(captive_shared_cache_map_object->FileObject,
588                         captive_shared_cache_map_object->buffer+offset,PAGE_SIZE,&offset_LargeInteger);
589
590         page->dirty=FALSE;
591         page->lsn_oldest=0;
592         page->lsn_newest=0;
593 }
594
595 typedef struct _captive_shared_cache_map_page_write_lsn_foreach_param captive_shared_cache_map_page_write_lsn_foreach_param;
596 struct _captive_shared_cache_map_page_write_lsn_foreach_param {
597         gint64 lsn_target;
598         gint64 lsn_best;
599         CaptiveSharedCacheMapObject *captive_shared_cache_map_object_best;
600         guint64 offset_best;
601         };
602
603 static void captive_shared_cache_map_page_write_lsn_foreach(
604                 CaptiveSharedCacheMapObject *captive_shared_cache_map_object,  /* key */
605                 CaptiveSharedCacheMapObject *captive_shared_cache_map_object_value,  /* value */
606                 captive_shared_cache_map_page_write_lsn_foreach_param *param)   /* user_data */
607 {
608 guint64 now;
609 CaptiveSharedCacheMapObject_page *page;
610
611         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
612         g_return_if_fail(captive_shared_cache_map_object==captive_shared_cache_map_object_value);
613         g_return_if_fail(param!=NULL);
614
615         for (now=0;now<captive_shared_cache_map_object->AllocationSize;now+=PAGE_SIZE) {
616                 page=captive_shared_cache_map_object->pages+now/PAGE_SIZE;
617                 if (!page->data_valid)
618                         continue;
619                 if (!page->dirty)
620                         continue;
621                 if (!page->lsn_newest)
622                         continue;
623                 if (page->lsn_newest>=param->lsn_target)
624                         continue;
625                 if (param->lsn_best && page->lsn_newest>param->lsn_best)
626                         continue;
627                 param->lsn_best=page->lsn_newest;
628                 param->captive_shared_cache_map_object_best=captive_shared_cache_map_object;
629                 param->offset_best=now;
630                 }
631 }
632
633 static void captive_shared_cache_map_page_write_lsn(CaptiveSharedCacheMapObject *captive_shared_cache_map_object,
634                 guint64 offset)
635 {
636 CaptiveSharedCacheMapObject_page *page;
637
638         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
639         g_return_if_fail(captive_shared_cache_map_object->FileObject!=NULL);
640         g_return_if_fail(offset<CAPTIVE_ROUND_UP64(captive_shared_cache_map_object->FileSize,PAGE_SIZE));
641         g_return_if_fail(0==CAPTIVE_ROUND_DOWN_EXCEEDING64(offset,PAGE_SIZE));
642         page=captive_shared_cache_map_object->pages+offset/PAGE_SIZE;
643         g_return_if_fail(page->data_valid);
644         g_return_if_fail(page->dirty);
645
646         if (page->lsn_newest) {
647                 CaptiveSharedCacheMapObject_hash_init();
648                 for (;;) {
649 captive_shared_cache_map_page_write_lsn_foreach_param param;
650
651                         param.lsn_target=page->lsn_newest;
652                         param.lsn_best=0;
653                         g_hash_table_foreach(
654                                         CaptiveSharedCacheMapObject_hash,       /* hash_table */
655                                         (GHFunc)captive_shared_cache_map_page_write_lsn_foreach,        /* func */
656                                         &param);        /* user_data */
657                         if (!param.lsn_best)
658                                 break;
659                         captive_shared_cache_map_page_write(param.captive_shared_cache_map_object_best,param.offset_best);
660                         }
661                 }
662
663         captive_shared_cache_map_page_write(captive_shared_cache_map_object,offset);
664 }
665
666 guint64 captive_shared_cache_map_flush(CaptiveSharedCacheMapObject *captive_shared_cache_map_object,
667                 guint64 start,guint64 end)
668 {
669 guint64 flushed;
670 guint64 now;
671
672         g_return_val_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object),0);
673         g_return_val_if_fail(start<=end,0);
674
675         end=MIN(end,CAPTIVE_ROUND_UP64(captive_shared_cache_map_object->FileSize,PAGE_SIZE));
676
677         start=CAPTIVE_ROUND_DOWN64(start,PAGE_SIZE);
678         end=CAPTIVE_ROUND_UP64(end,PAGE_SIZE);
679
680         flushed=0;
681         for (now=start;now<end;now+=PAGE_SIZE) {
682                 if (!captive_shared_cache_map_object->pages[now/PAGE_SIZE].data_valid)
683                         continue;
684                 if (!captive_shared_cache_map_object->pages[now/PAGE_SIZE].dirty)
685                         continue;
686                 captive_shared_cache_map_page_write_lsn(captive_shared_cache_map_object,now);
687                 flushed+=PAGE_SIZE;
688                 }
689
690         /* We were calling W32 code - recheck our task completion. */
691         for (now=start;now<end;now+=PAGE_SIZE) {
692                 if (!captive_shared_cache_map_object->pages[now/PAGE_SIZE].data_valid)
693                         continue;
694                 g_assert(!captive_shared_cache_map_object->pages[now/PAGE_SIZE].dirty);
695                 }
696
697         return flushed;
698 }
699
700 static void captive_shared_cache_map_is_any_dirty_foreach(
701                 CaptiveSharedCacheMapObject *captive_shared_cache_map_object,  /* key */
702                 CaptiveSharedCacheMapObject *captive_shared_cache_map_object_value,  /* value */
703                 gboolean *dirty_foundp) /* user_data */
704 {
705 guint64 now;
706
707         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
708         g_return_if_fail(captive_shared_cache_map_object==captive_shared_cache_map_object_value);
709         g_return_if_fail(dirty_foundp!=NULL);
710
711         for (now=0;now<captive_shared_cache_map_object->AllocationSize;now+=PAGE_SIZE) {
712                 if (!captive_shared_cache_map_object->pages[now/PAGE_SIZE].data_valid)
713                         continue;
714                 if (!captive_shared_cache_map_object->pages[now/PAGE_SIZE].dirty)
715                         continue;
716                 *dirty_foundp=TRUE;     /* FIXME: stop the traversal. */
717                 break;
718                 }
719 }
720
721
722 gboolean captive_shared_cache_map_is_any_dirty(void)
723 {
724 gboolean dirty_found;
725
726         CaptiveSharedCacheMapObject_hash_init();
727         dirty_found=FALSE;
728         g_hash_table_foreach(
729                         CaptiveSharedCacheMapObject_hash,       /* hash_table */
730                         (GHFunc)captive_shared_cache_map_is_any_dirty_foreach,  /* func */
731                         &dirty_found);  /* user_data */
732
733         return dirty_found;
734 }
735
736
737 typedef struct _captive_shared_cache_map_CcGetDirtyPages_foreach_param captive_shared_cache_map_CcGetDirtyPages_foreach_param;
738 struct _captive_shared_cache_map_CcGetDirtyPages_foreach_param {
739         PDIRTY_PAGE_ROUTINE DirtyPageRoutine;
740         VOID *Context1;
741         VOID *Context2;
742         gint64 result;
743         };
744
745 static void captive_shared_cache_map_CcGetDirtyPages_foreach(
746                 CaptiveSharedCacheMapObject *captive_shared_cache_map_object,  /* key */
747                 CaptiveSharedCacheMapObject *captive_shared_cache_map_object_value,  /* value */
748                 captive_shared_cache_map_CcGetDirtyPages_foreach_param *param)  /* user_data */
749 {
750 gint64 now;
751 CaptiveSharedCacheMapObject_page *page;
752
753         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
754         g_return_if_fail(captive_shared_cache_map_object->FileObject!=NULL);
755         g_return_if_fail(captive_shared_cache_map_object==captive_shared_cache_map_object_value);
756         g_return_if_fail(param!=NULL);
757
758         for (now=CAPTIVE_ROUND_DOWN64(captive_shared_cache_map_object->AllocationSize-1,PAGE_SIZE);now>=0;now-=PAGE_SIZE) {
759 LARGE_INTEGER now_LargeInteger,lsn_oldest_LargeInteger,lsn_newest_LargeInteger;
760
761                 page=captive_shared_cache_map_object->pages+now/PAGE_SIZE;
762                 if (!page->data_valid)
763                         continue;
764                 if (!page->dirty)
765                         continue;
766                 if (page->lsn_oldest && (!param->result || param->result>page->lsn_oldest))
767                         param->result=page->lsn_oldest;
768
769                 now_LargeInteger.QuadPart=now;
770                 lsn_oldest_LargeInteger.QuadPart=page->lsn_oldest;
771                 lsn_newest_LargeInteger.QuadPart=page->lsn_newest;
772                 (*param->DirtyPageRoutine)(
773                                 captive_shared_cache_map_object->FileObject,    /* FileObject */
774                                 &now_LargeInteger,      /* FileOffset */
775                                 PAGE_SIZE,      /* Length */
776                                 &lsn_oldest_LargeInteger,       /* OldestLsn */
777                                 &lsn_newest_LargeInteger,       /* NewestLsn */
778                                 param->Context1,        /* Context1 */
779                                 param->Context2);       /* Context2 */
780                 }
781 }
782
783 gint64 captive_shared_cache_map_CcGetDirtyPages(PDIRTY_PAGE_ROUTINE DirtyPageRoutine,VOID *Context1,VOID *Context2)
784 {
785 captive_shared_cache_map_CcGetDirtyPages_foreach_param param;
786
787         g_return_val_if_fail(DirtyPageRoutine!=NULL,0);
788
789         param.DirtyPageRoutine=DirtyPageRoutine;
790         param.Context1=Context1;
791         param.Context2=Context2;
792         param.result=0;
793
794         CaptiveSharedCacheMapObject_hash_init();
795         g_hash_table_foreach(
796                         CaptiveSharedCacheMapObject_hash,       /* hash_table */
797                         (GHFunc)captive_shared_cache_map_CcGetDirtyPages_foreach,       /* func */
798                         &param);        /* user_data */
799
800         return param.result;
801 }
802
803 gpointer captive_shared_cache_map_get_buffer(CaptiveSharedCacheMapObject *captive_shared_cache_map_object)
804 {
805         g_return_val_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object),NULL);
806         g_return_val_if_fail(captive_shared_cache_map_object->buffer!=NULL,NULL);
807
808         return captive_shared_cache_map_object->buffer;
809 }
810
811 static void captive_cc_FileObject_delete_foreach(
812                 CaptiveSharedCacheMapObject *captive_shared_cache_map_object,  /* key */
813                 CaptiveSharedCacheMapObject *captive_shared_cache_map_object_value,  /* value */
814                 FILE_OBJECT *FileObject)        /* user_data */
815 {
816         g_return_if_fail(CAPTIVE_SHARED_CACHE_MAP_IS_OBJECT(captive_shared_cache_map_object));
817         g_return_if_fail(captive_shared_cache_map_object==captive_shared_cache_map_object_value);
818         g_return_if_fail(FileObject!=NULL);
819
820         g_assert(FileObject!=captive_shared_cache_map_object->FileObject);
821 }
822
823 BOOLEAN captive_cc_FileObject_delete(FILE_OBJECT *FileObject)
824 {
825         g_return_val_if_fail(FileObject!=NULL,FALSE);
826
827         CaptiveSharedCacheMapObject_hash_init();
828         g_hash_table_foreach(
829                         CaptiveSharedCacheMapObject_hash,       /* hash_table */
830                         (GHFunc)captive_cc_FileObject_delete_foreach,   /* func */
831                         FileObject);    /* user_data */
832
833         return FALSE;   /* FIXME: remove useless return code. */
834 }