src/libcaptive/cc/map.c

   1 /* $Id$
   2  * reactos Cache Manager mapper emulation of libcaptive
   3  * Copyright (C) 2002-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 "reactos/ddk/ccfuncs.h"        /* self */
  23 #include <glib/gmessages.h>
  24 #include <glib/ghash.h>
  25 #include <glib/gmem.h>
  26 #include <sys/mman.h>
  27 #include "reactos/ddk/mmfuncs.h"        /* for MmCreateMdl() */
  28 #include "reactos/ddk/kefuncs.h"        /* for KeInitializeEvent() */
  29 #include "reactos/ddk/iofuncs.h"        /* for IoPageRead() */
  30 #include "captive/macros.h"
  31 #include <sys/types.h>
  32 #include <sys/shm.h>
  33 #include <unistd.h>
  34 #include <glib/glist.h>
  35 #include "reactos/internal/io.h"        /* for IoSynchronousPageWrite() */
  36 #include <glib/gmain.h>
  37 #include "captive/leave.h"
  38 #include <glib/gtree.h>
  39
  40
  41 /* CONFIG: */
  42
  43 #define CAPTIVE_PUBLIC_BCB_NODETYPECODE 0xDE45  /* FIXME: unknown, undocumented */
  44 /* Prepare linear mapped space by CcInitializeCacheMap()?
  45  * NT-5.1sp will map the same pages of a file to the same memory location
  46  * either by CcMap*() or CcPin*().
  47  * We do a separate mapping for each Bcb protected by bounding unmapped pages
  48  * with IPC shm shared pages if a file page is mapped multiple times.
  49  * I am not aware how they can reserve enough virtual memory space during
  50  * client with mapping requests of increasing range tendency.
  51  * This define will try to pre-map the file as one linear are during
  52  * CcInitializeCacheMap() according to its (CC_FILE_SIZES *)FileSizes
  53  * but TODO the range is currently left unused in further mapping functions.
  54  */
  55 /* #define CAPTIVE_FILE_INITIALIZED_CACHE_IS_LINEAR 1 */
  56
  57
  58 /* Flush all the buffers directly on the fly.
  59  * For details see the comment in libcaptive/client/init.c/captive_shutdown().
  60  */
  61 gboolean captive_cc_unmounting=FALSE;
  62
  63
  64 /* map: (FILE_OBJECT *)FileObject -> (struct fileobject_cached *) */
  65 static GHashTable *fileobject_cached_hash;
  66
  67 struct fileobject_cached {
  68         CACHE_MANAGER_CALLBACKS CallBacks;
  69         VOID *LazyWriterContext;
  70 #ifdef CAPTIVE_FILE_INITIALIZED_CACHE_IS_LINEAR
  71         PVOID Bcb;
  72 #endif
  73         };
  74
  75 static void fileobject_cached_hash_value_destroy_func(struct fileobject_cached *value)
  76 {
  77         g_return_if_fail(value!=NULL);
  78
  79         g_free(value);
  80 }
  81
  82 static void fileobject_cached_hash_init(void)
  83 {
  84         if (fileobject_cached_hash)
  85                 return;
  86         fileobject_cached_hash=g_hash_table_new_full(
  87                         g_direct_hash,  /* hash_func */
  88                         g_direct_equal, /* key_equal_func */
  89                         NULL,   /* key_destroy_func */
  90                         (GDestroyNotify)fileobject_cached_hash_value_destroy_func);     /* value_destroy_func */
  91 }
  92
  93
  94 /**
  95  * CcInitializeCacheMap:
  96  * @FileObject: Existing file to set callbacks for. Ignored by libcaptive.
  97  * %NULL value is forbidden.
  98  * @FileSizes: Some file sizes suggestions. Ignored by libcaptive.
  99  * %NULL value is forbidden.
 100  * @PinAccess: CcPin*() functions will be used with @FileObject? Ignored by libcaptive.
 101  * @CallBacks: Provided callback functions for readahead/writebehind. Ignored by libcaptive.
 102  * %NULL value is forbidden.
 103  * @LazyWriterContext: Value passed to functions of @CallBacks to bind with @FileObject.
 104  * %NULL value is permitted.
 105  *
 106  * Provides support of readahead/writebehind in W32. Function should be called
 107  * by W32 filesystem to offer its functions to W32 kernel. These functions
 108  * are never called by libcaptive, this call is a NOP in libcaptive.
 109  */
 110 VOID CcInitializeCacheMap(IN PFILE_OBJECT FileObject,
 111                 IN PCC_FILE_SIZES FileSizes,IN BOOLEAN PinAccess,IN PCACHE_MANAGER_CALLBACKS CallBacks,IN PVOID LazyWriterContext)
 112 {
 113 struct fileobject_cached *fileobject_cached;
 114 #ifdef CAPTIVE_FILE_INITIALIZED_CACHE_IS_LINEAR
 115 guint64 size64;
 116 LARGE_INTEGER FileOffset0;
 117 PVOID Buffer_trash;
 118 BOOLEAN errboolean;
 119 #endif
 120
 121         g_return_if_fail(FileObject!=NULL);
 122         g_return_if_fail(FileSizes!=NULL);
 123         g_return_if_fail(CallBacks!=NULL);
 124
 125         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: FileObject=%p,"
 126                         "FileSizes->AllocationSize=0x%llX,FileSizes->FileSize=0x%llX,FileSizes->ValidDataLength=0x%llX,"
 127                         "PinAccess=%d,CallBacks=%p,LazyWriterContext=%p",G_STRLOC,
 128                         FileObject,(guint64)FileSizes->AllocationSize.QuadPart,(guint64)FileSizes->FileSize.QuadPart,
 129                         (guint64)FileSizes->ValidDataLength.QuadPart,(gint)PinAccess,CallBacks,LazyWriterContext);
 130
 131         fileobject_cached_hash_init();
 132
 133         /* TODO:thread */
 134
 135         /* Double reinitialization without CcUninitializeCacheMap()
 136          * is done by both fastfat.sys and ntfs.sys of NT-5.1sp1.
 137          */
 138 #if 0
 139         g_assert(g_hash_table_lookup(fileobject_cached_hash,FileObject)==NULL);
 140 #endif
 141
 142         captive_new(fileobject_cached);
 143         fileobject_cached->CallBacks=*CallBacks;
 144         fileobject_cached->LazyWriterContext=LazyWriterContext;
 145
 146         g_hash_table_insert(fileobject_cached_hash,
 147                         FileObject,     /* key */
 148                         fileobject_cached);     /* value */
 149
 150 #if CAPTIVE_FILE_INITIALIZED_CACHE_IS_LINEAR
 151         size64=MAX(MAX(FileSizes->AllocationSize.QuadPart,FileSizes->FileSize.QuadPart),
 152                         (FileSizes->ValidDataLength.QuadPart==G_MAXINT64 ? 0 : FileSizes->ValidDataLength.QuadPart));
 153         g_assert(((ULONG)size64)==size64);
 154         FileOffset0.QuadPart=0;
 155
 156         errboolean=CcMapData(FileObject,&FileOffset0,size64,MAP_WAIT,&fileobject_cached->Bcb,&Buffer_trash);
 157         g_assert(errboolean==TRUE);
 158 #endif
 159 }
 160
 161
 162 BOOLEAN captive_cc_FileObject_delete(FILE_OBJECT *FileObject);
 163
 164 /**
 165  * CcUninitializeCacheMap:
 166  * @FileObject: File to close caching for.
 167  * %NULL value is forbidden.
 168  * @TruncateSize: Current file size if @FileObject was truncated to it in the meantime.
 169  * @UninitializeCompleteEvent: Optional event to signal after physical write to disk.
 170  * %NULL value is permitted.
 171  *
 172  * Close the cachine facilities from CcInitializeCacheMap().
 173  * It is valid to pass @FileObject without being registered by CcInitializeCacheMap().
 174  *
 175  * FIXME; What to do with files with dirty blocks? Currently we fail assertion on them
 176  * although I think W32 would drop such buffers (purge them - not flush them).
 177  *
 178  * Returns: %TRUE if the caching was closed successfuly.
 179  * %FALSE if @FileObject wasn't registered by CcInitializeCacheMap().
 180  */
 181 BOOLEAN CcUninitializeCacheMap(IN PFILE_OBJECT FileObject,
 182                 IN PLARGE_INTEGER TruncateSize OPTIONAL,IN PCACHE_UNINITIALIZE_EVENT UninitializeCompleteEvent OPTIONAL)
 183 {
 184 BOOLEAN r;
 185
 186         g_return_val_if_fail(FileObject!=NULL,FALSE);
 187         /* assert current size ==*TruncateSize if TruncateSize */
 188
 189         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: FileObject=%p,TruncateSize=0x%llX,UninitializeCompleteEvent=%p",
 190                         G_STRLOC,FileObject,(guint64)(!TruncateSize ? -1 : TruncateSize->QuadPart),UninitializeCompleteEvent);
 191
 192         /* TODO:thread */
 193         /* Here it will check for any dirty blocks and it will fail g_assert() on them.
 194          * I think it may happen for BCBs to exist dirty for 'FileObject' and they
 195          * should be silently discarded if CcUninitializeCacheMap() but currently
 196          * the assertion is left here as some debugging aid.
 197          */
 198         r=captive_cc_FileObject_delete(FileObject);
 199
 200         /* FIXME: should we do KePulseEvent? Are we allowed to signal from inside CcUninitializeCacheMap() ? */
 201         if (UninitializeCompleteEvent)
 202                 KeSetEvent(
 203                                 &UninitializeCompleteEvent->Event,      /* Event */
 204                                 IO_NO_INCREMENT,        /* Increment */
 205                                 FALSE); /* Wait */
 206
 207         return r;
 208 }
 209
 210
 211 static gboolean validate_Bcb(const PUBLIC_BCB *PublicBcb)
 212 {
 213         g_return_val_if_fail(PublicBcb!=NULL,FALSE);
 214         g_return_val_if_fail(PublicBcb->NodeTypeCode==CAPTIVE_PUBLIC_BCB_NODETYPECODE,FALSE);
 215         g_return_val_if_fail(PublicBcb->NodeByteSize==sizeof(*PublicBcb),FALSE);
 216         g_return_val_if_fail(PublicBcb->MappedLength>0,FALSE);
 217         g_return_val_if_fail(PublicBcb->MappedFileOffset.QuadPart>=0,FALSE);
 218
 219         return TRUE;
 220 }
 221
 222
 223 /* position in file */
 224 struct page_position {
 225         FILE_OBJECT *FileObject;
 226         LARGE_INTEGER FileOffset;       /* always PAGE_SIZE aligned */
 227         int shmid;
 228         GList *privbcb_list;    /* each mapped page has its one private_bcb */
 229         gboolean building;      /* data are not yet read; prevention for CcMapData() reentrancy */
 230         };
 231
 232 /* map: (struct page_position *)pagepos -> (struct page_position *)pagepos */
 233 static GHashTable *page_position_hash;
 234
 235 static gboolean validate_page_position(const struct page_position *pagepos)
 236 {
 237 int errint;
 238 struct shmid_ds shmid_ds;
 239
 240         g_return_val_if_fail(pagepos!=NULL,FALSE);
 241         g_return_val_if_fail(pagepos->FileObject!=NULL,FALSE);
 242         g_return_val_if_fail(pagepos->FileOffset.QuadPart>=0,FALSE);
 243         g_return_val_if_fail(0==CAPTIVE_ROUND_DOWN_EXCEEDING64(pagepos->FileOffset.QuadPart,PAGE_SIZE),FALSE);
 244         /* 'pagepos->shmid' may be -1 */
 245         /* 'pagepos->privbcb_list' may be empty */
 246         /* either deleted or alive */
 247         /* shmid exists only for >=2 mappings, it is simple mmap() for single mapping */
 248         g_return_val_if_fail((pagepos->shmid==-1)==(pagepos->privbcb_list==NULL || pagepos->privbcb_list->next==NULL),FALSE);
 249
 250         if (pagepos->shmid!=-1) {
 251                 errint=shmctl(pagepos->shmid,
 252                                 IPC_STAT,       /* cmd */
 253                                 &shmid_ds);     /* buf */
 254                 g_return_val_if_fail(errint==0,FALSE);
 255
 256                 g_return_val_if_fail(shmid_ds.shm_perm.uid==geteuid(),FALSE);
 257                 g_return_val_if_fail(shmid_ds.shm_perm.gid==getegid(),FALSE);
 258                 g_return_val_if_fail(shmid_ds.shm_perm.cuid==geteuid(),FALSE);
 259                 g_return_val_if_fail(shmid_ds.shm_perm.cgid==getegid(),FALSE);
 260                 /* 'shm_perm.mode' was seen with sticky bit 01000: */
 261                 g_return_val_if_fail((shmid_ds.shm_perm.mode&0777)==0600,FALSE);
 262                 g_return_val_if_fail(shmid_ds.shm_segsz==PAGE_SIZE,FALSE);
 263                 /* Do not check 'shmid_ds.shm_cpid' and 'shmid_ds.shm_lpid' against getpid()
 264                  * as we may run as different PIDs in different threads synchronized by client/ .
 265                  */
 266                 g_return_val_if_fail(shmid_ds.shm_nattch==g_list_length(pagepos->privbcb_list),FALSE);
 267                 }
 268
 269         return TRUE;
 270 }
 271
 272 static guint page_position_hash_hash_func(const struct page_position *key)
 273 {
 274         g_return_val_if_fail(validate_page_position(key),0);
 275
 276         return ((guint)key->FileObject)^(key->FileOffset.QuadPart);
 277 }
 278
 279 static gboolean page_position_hash_key_equal_func(const struct page_position *a,const struct page_position *b)
 280 {
 281         g_return_val_if_fail(validate_page_position(a),FALSE);
 282         g_return_val_if_fail(validate_page_position(b),FALSE);
 283
 284         return (a->FileObject==b->FileObject && a->FileOffset.QuadPart==b->FileOffset.QuadPart);
 285 }
 286
 287 static void page_position_hash_key_destroy_func(struct page_position *key)
 288 {
 289         g_return_if_fail(validate_page_position(key));
 290         g_assert(key->privbcb_list==NULL);
 291         g_assert(key->shmid==-1);
 292
 293         g_free(key);
 294 }
 295
 296 static void page_position_hash_init(void)
 297 {
 298         if (page_position_hash)
 299                 return;
 300         page_position_hash=g_hash_table_new_full(
 301                         (GHashFunc)page_position_hash_hash_func,        /* hash_func */
 302                         (GEqualFunc)page_position_hash_key_equal_func,  /* key_equal_func */
 303                         (GDestroyNotify)page_position_hash_key_destroy_func,    /* key_destroy_func */
 304                         NULL);  /* value_destroy_func */
 305 }
 306
 307
 308 struct private_bcb {
 309         PUBLIC_BCB *PublicBcb;  /* ->MappedLength, ->MappedFileOffset */
 310         FILE_OBJECT *FileObject;
 311         gint ref_count;
 312         gboolean leave_func_pending;
 313         /* we save it here as 'PublicBcb' may be already destroyed in private_bcb_hash_value_destroy_func(): */
 314         ULONG MappedLength;     /* It is the real requested size; it is not PAGE_SIZE aligned. */
 315         /* we save it here as 'PublicBcb' may be already destroyed in private_bcb_hash_value_destroy_func(): */
 316         LARGE_INTEGER MappedFileOffset; /* It is the real requested offset; it is not PAGE_SIZE aligned. */
 317         gpointer base;  /* It is the pointer corresponding to MappedFileOffset; it is not PAGE_SIZE aligned. */
 318         gboolean dirty;
 319         LARGE_INTEGER lsn; gboolean lsn_valid;
 320         };
 321
 322
 323 /* map: (struct private_bcb *)privbcb -> (struct private_bcb *)privbcb */
 324 static GTree *private_bcb_lsn_tree;
 325
 326 /* Such debugging messages are too much expensive.
 327  * Use to track for deallocated privbcb-s/PublicBcb-s.
 328  */
 329 /* #define DEBUG_PRIVATE_BCB_LSN_TREE_KEY_COMPARE_FUNC 1 */
 330
 331 /* Although 'private_bcb_lsn_tree' contains only nodes with 'lsn_valid' TRUE
 332  * compare_func cannot expect such arguments as it may be used to lookup
 333  * privbcb unlisted in 'private_bcb_lsn_tree'.
 334  */
 335 static gint private_bcb_lsn_tree_key_compare_func(struct private_bcb *a,struct private_bcb *b,gpointer user_data /* NULL */)
 336 {
 337 gint64 a_lsn,b_lsn;
 338 gint r;
 339
 340 #ifdef DEBUG_PRIVATE_BCB_LSN_TREE_KEY_COMPARE_FUNC
 341         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: privbcb a=%p,privbcb b=%p",G_STRLOC,a,b);
 342         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: privbcb a->PublicBcb=%p",G_STRLOC,a->PublicBcb);
 343         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: privbcb b->PublicBcb=%p",G_STRLOC,b->PublicBcb);
 344         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: privbcb a->PublicBcb->MappedLength=%u",G_STRLOC,(unsigned)a->PublicBcb->MappedLength);
 345         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: privbcb b->PublicBcb->MappedLength=%u",G_STRLOC,(unsigned)b->PublicBcb->MappedLength);
 346 #endif
 347
 348         g_return_val_if_fail(a!=NULL,0);
 349         g_return_val_if_fail(validate_Bcb(a->PublicBcb),0);
 350         g_assert(!a->lsn_valid || a->lsn.QuadPart!=(LONGLONG)G_MAXINT64);       /* Forbid defined LSN as G_MAXINT64 */
 351         g_return_val_if_fail(b!=NULL,0);
 352         g_return_val_if_fail(validate_Bcb(b->PublicBcb),0);
 353         g_assert(!b->lsn_valid || b->lsn.QuadPart!=(LONGLONG)G_MAXINT64);       /* Forbid defined LSN as G_MAXINT64 */
 354
 355         if (a==b) {     /* LSN would be apparently the same in such case :-) */
 356 #ifdef DEBUG_PRIVATE_BCB_LSN_TREE_KEY_COMPARE_FUNC
 357                 g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: return 0 (a==b)",G_STRLOC);
 358 #endif
 359                 return 0;
 360                 }
 361
 362         a_lsn=(!a->lsn_valid ? (LONGLONG)G_MAXINT64 : a->lsn.QuadPart);
 363         b_lsn=(!b->lsn_valid ? (LONGLONG)G_MAXINT64 : b->lsn.QuadPart);
 364
 365         /* Forbid the same LSNs if both defined */
 366         g_assert(a_lsn==(LONGLONG)G_MAXINT64 || a_lsn!=b_lsn);
 367
 368         if ((r=(a_lsn>b_lsn)-(a_lsn<b_lsn))) {
 369 #ifdef DEBUG_PRIVATE_BCB_LSN_TREE_KEY_COMPARE_FUNC
 370                 g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: return %d (lsn !=)",G_STRLOC,r);
 371 #endif
 372                 return r;
 373                 }
 374
 375 #ifdef DEBUG_PRIVATE_BCB_LSN_TREE_KEY_COMPARE_FUNC
 376         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: return (ptr !=)",G_STRLOC);
 377 #endif
 378         return (a>b)-(a<b);
 379 }
 380
 381 static void private_bcb_lsn_tree_init(void)
 382 {
 383         if (private_bcb_lsn_tree)
 384                 return;
 385         private_bcb_lsn_tree=g_tree_new(
 386                         (GCompareFunc)private_bcb_lsn_tree_key_compare_func);   /* key_compare_func */
 387 }
 388
 389 enum privbcb_item {
 390         PRIVBCB_ITEM_NOP,       /* for sanity checks */
 391         PRIVBCB_ITEM_DIRTY,
 392         PRIVBCB_ITEM_LSN_VALID,
 393         PRIVBCB_ITEM_LEAVE_FUNC_PENDING,
 394         PRIVBCB_ITEM_REF_COUNT,
 395         PRIVBCB_ITEM_REF_COUNT_DESTRUCTOR,      /* no protections against 'leave_func_pending' */
 396         };
 397
 398 static void privbcb_set(struct private_bcb *privbcb,enum privbcb_item item,gint value)
 399 {
 400         g_return_if_fail(privbcb!=NULL);
 401
 402         private_bcb_lsn_tree_init();
 403
 404         g_assert((privbcb->lsn_valid ? privbcb : NULL)==g_tree_lookup(private_bcb_lsn_tree,privbcb));
 405         switch (item) {
 406                 case PRIVBCB_ITEM_NOP:
 407                         break;
 408                 case PRIVBCB_ITEM_DIRTY:
 409                         g_assert(TRUE==value || FALSE==value);
 410                         privbcb->dirty=value;
 411                         break;
 412                 case PRIVBCB_ITEM_LSN_VALID:
 413                         /* Never change 'privbcb->lsn_valid' while it is linked in 'private_bcb_lsn_tree'
 414                          * as it could become unreachable due to private_bcb_lsn_tree_key_compare_func()
 415                          * behaviour wrt 'privbcb->lsn_valid'!
 416                          */
 417                         g_tree_remove(private_bcb_lsn_tree,privbcb);
 418                         g_assert(TRUE==value || FALSE==value);
 419                         privbcb->lsn_valid=value;
 420                         if (privbcb->lsn_valid)
 421                                 g_tree_insert(private_bcb_lsn_tree,
 422                                                 privbcb,        /* key */
 423                                                 privbcb);       /* value */
 424                         break;
 425                 case PRIVBCB_ITEM_LEAVE_FUNC_PENDING:
 426                         g_assert(TRUE==value || FALSE==value);
 427                         privbcb->leave_func_pending=value;
 428                         if (value)
 429                                 g_assert(privbcb->ref_count==1);
 430                         break;
 431                 case PRIVBCB_ITEM_REF_COUNT:
 432                         /* Forbid reincarnation of 'leave_func_pending' privbcb. */
 433                         g_assert(!privbcb->leave_func_pending);
 434                         g_assert(privbcb->ref_count>=1);
 435                         privbcb->ref_count+=value;
 436                         g_assert(privbcb->ref_count>=1);
 437                         break;
 438                 case PRIVBCB_ITEM_REF_COUNT_DESTRUCTOR:
 439                         g_assert(privbcb->ref_count>=0);
 440                         privbcb->ref_count+=value;
 441                         g_assert(privbcb->ref_count>=0);
 442                         break;
 443                 default: g_assert_not_reached();
 444                 }
 445         g_assert((privbcb->lsn_valid ? privbcb : NULL)==g_tree_lookup(private_bcb_lsn_tree,privbcb));
 446 }
 447
 448
 449 /* map: (PUBLIC_BCB *)PublicBcb -> (struct private_bcb *)privbcb */
 450 static GHashTable *private_bcb_hash;
 451
 452 static void private_bcb_hash_key_destroy_func(PUBLIC_BCB *key)
 453 {
 454         g_return_if_fail(validate_Bcb(key));
 455
 456         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: g_free: PublicBcb=%p",G_STRLOC,key);
 457
 458         g_free(key);
 459 }
 460
 461 static void private_bcb_hash_value_destroy_func(struct private_bcb *value)
 462 {
 463 struct page_position pagepos_local;
 464 gboolean errbool;
 465 int errint;
 466 size_t offset;
 467 gpointer base_aligned;
 468
 469         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: g_free: privbcb=%p (->PublicBcb=%p)",G_STRLOC,value,value->PublicBcb);
 470
 471         g_return_if_fail(value!=NULL);
 472         /* We cannot do 'validate_Bcb(value->PublicBcb)' here as 'value->PublicBcb'
 473          * may got already destroyed by 'private_bcb_hash_key_destroy_func(key)'
 474          */
 475         g_return_if_fail(value->PublicBcb!=NULL);
 476         g_return_if_fail(value->FileObject!=NULL);
 477         g_return_if_fail(value->ref_count==0);
 478         g_return_if_fail(value->MappedLength>0);
 479         g_return_if_fail(value->MappedFileOffset.QuadPart>=0);
 480         g_return_if_fail(value->base!=NULL);
 481         g_return_if_fail(value->dirty==FALSE);
 482         /* Ensure we are not registered in 'private_bcb_lsn_tree'. */
 483         g_return_if_fail(value->lsn_valid==FALSE);
 484
 485         page_position_hash_init();
 486
 487         base_aligned=((char *)value->base)-CAPTIVE_ROUND_DOWN_EXCEEDING64(value->MappedFileOffset.QuadPart,PAGE_SIZE);
 488
 489         pagepos_local.FileObject=value->FileObject;
 490         pagepos_local.privbcb_list=NULL;
 491         pagepos_local.shmid=-1;
 492         for (
 493                         offset=0;
 494                         offset<value->MappedLength;
 495                         offset+=PAGE_SIZE) {
 496 struct page_position *pagepos;
 497
 498                 pagepos_local.FileOffset.QuadPart=CAPTIVE_ROUND_DOWN64(value->MappedFileOffset.QuadPart+offset,PAGE_SIZE);
 499                 pagepos=g_hash_table_lookup(page_position_hash,&pagepos_local);
 500                 g_assert(validate_page_position(pagepos));
 501                 g_assert(pagepos->privbcb_list!=NULL);
 502                 if (pagepos->privbcb_list->next==NULL) {        /* single mapping by mmap(), no shm */
 503                         g_assert(pagepos->shmid==-1);
 504                         errint=munmap(((char *)base_aligned)+offset,PAGE_SIZE);
 505                         g_assert(errint==0);
 506                         }
 507                 else if (pagepos->privbcb_list->next->next==NULL) {     /* mapping 2 -> 1, convert shm to mmap() */
 508 struct private_bcb *privbcb_other;
 509 gint64 privbcb_other_offset_relative;
 510 gpointer mapped_other,errptr;
 511
 512                         g_assert(pagepos->shmid!=-1);
 513                         if (value==pagepos->privbcb_list->data)
 514                                 privbcb_other=pagepos->privbcb_list->next->data;
 515                         else {
 516                                 privbcb_other=pagepos->privbcb_list->data;
 517                                 g_assert(value==pagepos->privbcb_list->next->data);
 518                                 }
 519                         privbcb_other_offset_relative=pagepos->FileOffset.QuadPart-privbcb_other->MappedFileOffset.QuadPart;
 520                         /* privbcb_other_offset_relative may be negative up to -PAGE_SIZE
 521                          * as 'MappedFileOffset' and 'base' are not page-aligned.
 522                          */
 523                         mapped_other=privbcb_other->base+privbcb_other_offset_relative;
 524                         /* TODO:thread; shmdt()..mmap() window */
 525                         errint=shmdt(mapped_other);
 526                         g_assert(errint==0);
 527                         errptr=mmap(
 528                                         mapped_other,   /* start */
 529                                         PAGE_SIZE,      /* length */
 530                                         PROT_READ|PROT_WRITE,   /* prot */
 531                                         MAP_PRIVATE|MAP_ANONYMOUS,      /* flags */
 532                                         -1,     /* fd; ignored due to MAP_ANONYMOUS */
 533                                         0);     /* offset; ignored due to MAP_ANONYMOUS */
 534                         g_assert(errptr==mapped_other);
 535                         memcpy(mapped_other,((char *)base_aligned)+offset,PAGE_SIZE);
 536                         errint=shmdt(((char *)base_aligned)+offset);    /* destroys shm */
 537                         g_assert(errint==0);
 538                         /* It should be destroyed automatically as IPC_RMID should be pending from its foundation. */
 539                         pagepos->shmid=-1;
 540                         }
 541                 else {  /* mappings (>=3) -> (>=2) */
 542                         g_assert(pagepos->shmid!=-1);
 543                         errint=shmdt(((char *)base_aligned)+offset);
 544                         g_assert(errint==0);
 545                         }
 546
 547                 g_assert(g_list_find(pagepos->privbcb_list,value)!=NULL);
 548                 pagepos->privbcb_list=g_list_remove(pagepos->privbcb_list,value);
 549                 g_assert(g_list_find(pagepos->privbcb_list,value)==NULL);
 550
 551                 if (pagepos->privbcb_list==NULL) {      /* last mapping by mmap() removed */
 552                         g_assert(pagepos->shmid==-1);
 553                         errbool=g_hash_table_remove(page_position_hash,&pagepos_local);
 554                         g_assert(errbool==TRUE);
 555                         }
 556                 else    /* mapping is now >=1, either by mmap() or shm */
 557                         g_assert(validate_page_position(pagepos));
 558                 }
 559
 560         g_free(value);
 561 }
 562
 563 static void private_bcb_hash_init(void)
 564 {
 565         if (private_bcb_hash)
 566                 return;
 567         private_bcb_hash=g_hash_table_new_full(
 568                         g_direct_hash,  /* hash_func */
 569                         g_direct_equal, /* key_equal_func */
 570                         (GDestroyNotify)private_bcb_hash_key_destroy_func,      /* key_destroy_func */
 571                         (GDestroyNotify)private_bcb_hash_value_destroy_func);   /* value_destroy_func */
 572 }
 573
 574
 575 static gboolean captive_cc_FileObject_delete_private_bcb_hash_foreach(
 576                 PUBLIC_BCB *PublicBcb,  /* key */
 577                 struct private_bcb *privbcb,  /* value */
 578                 FILE_OBJECT *FileObject)  /* user_data */
 579 {
 580         g_return_val_if_fail(validate_Bcb(PublicBcb),FALSE);    /* meaning: do not remove this 'privbcb' */
 581         g_return_val_if_fail(privbcb!=NULL,FALSE);      /* meaning: do not remove this 'privbcb' */
 582         g_return_val_if_fail(PublicBcb==privbcb->PublicBcb,FALSE);      /* meaning: do not remove this 'privbcb' */
 583         g_return_val_if_fail(FileObject!=NULL,FALSE);   /* meaning: do not remove this 'privbcb' */
 584
 585         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: PublicBcb=%p,privbcb=%p,privbcb->ref_count=%d,privbcb->leave_func_pending=%d"
 586                         ",FileObject=%p",G_STRLOC,
 587                         PublicBcb,privbcb,privbcb->ref_count,privbcb->leave_func_pending,FileObject);
 588
 589         if (FileObject) {
 590                 if (privbcb->FileObject!=FileObject)
 591                         return FALSE;   /* do not remove this 'privbcb' */
 592
 593                 /* It is OK to leave it in 'private_bcb_hash' as it is protected
 594                  * against reincarnation.
 595                  * Such check is here to allow it to keep 'dirty' data.
 596                  */
 597                 if (privbcb->leave_func_pending)
 598                         return FALSE;   /* do not remove this 'privbcb' */
 599                 }
 600
 601         /* Do not reuse captive_privbcb_flush_ordered() destructor here as we cannot
 602          * call g_hash_table_remove() from inside g_hash_table_foreach_remove() callback.
 603          */
 604
 605         g_assert(privbcb->dirty==FALSE);        /* it would be fatal */
 606
 607         g_assert(privbcb->leave_func_pending==FALSE);
 608         /* Force 'ref_count' drop to 0 to pass private_bcb_hash_value_destroy_func(). */
 609         privbcb_set(privbcb,PRIVBCB_ITEM_REF_COUNT_DESTRUCTOR,-privbcb->ref_count);
 610         /* Unset LSN to unlink from 'private_bcb_lsn_tree'. */
 611         privbcb_set(privbcb,PRIVBCB_ITEM_LSN_VALID,FALSE);
 612
 613         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: WARNING: Deleting file with pending (fortunately non-dirty) BCBs"
 614                         "; privbcb=%p,PublicBcb=%p,FileObject=%p,FileOffset=0x%llX,Length=0x%lX",G_STRLOC,
 615                         privbcb,PublicBcb,privbcb->FileObject,(guint64)privbcb->MappedFileOffset.QuadPart,(gulong)privbcb->MappedLength);
 616
 617         return TRUE;    /* remove this 'privbcb' */
 618 }
 619
 620 BOOLEAN captive_cc_FileObject_delete(FILE_OBJECT *FileObject)
 621 {
 622 struct fileobject_cached *fileobject_cached;
 623 BOOLEAN r=TRUE;
 624
 625         /* 'FileObject' may be NULL to check/clear the whole cache. */
 626
 627         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: FileObject=%p",G_STRLOC,FileObject);
 628
 629         fileobject_cached_hash_init();
 630         private_bcb_hash_init();
 631
 632         if (!FileObject || !(fileobject_cached=g_hash_table_lookup(fileobject_cached_hash,FileObject)))
 633                 r=FALSE;
 634         else {
 635 #ifdef CAPTIVE_FILE_INITIALIZED_CACHE_IS_LINEAR
 636                 CcUnpinData(fileobject_cached->Bcb);
 637 #endif
 638                 g_hash_table_remove(fileobject_cached_hash,FileObject);
 639                 }
 640
 641         g_hash_table_foreach_remove(
 642                         private_bcb_hash,       /* hash_table */
 643                         (GHRFunc)captive_cc_FileObject_delete_private_bcb_hash_foreach, /* func */
 644                         FileObject);    /* user_data */
 645
 646         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: returning r=%d",G_STRLOC,r);
 647
 648         return r;
 649 }
 650
 651
 652 static void captive_privbcb_flush_unordered(struct private_bcb *privbcb);
 653
 654 static void captive_cc_flush_private_bcb_hash_foreach(
 655                 PUBLIC_BCB *PublicBcb,  /* key */
 656                 struct private_bcb *privbcb,  /* value */
 657                 gboolean *flushedp)     /* user_data */
 658 {
 659         g_return_if_fail(validate_Bcb(PublicBcb));
 660         g_return_if_fail(privbcb!=NULL);
 661         g_return_if_fail(PublicBcb==privbcb->PublicBcb);
 662
 663         if (!privbcb->dirty)    /* OK */
 664                 return;
 665
 666         /* Such privbcb should have been flushed by captive_privbcb_flush_ordered(NULL) before
 667          * to ensure its LSN ordering.
 668          */
 669         g_assert(!privbcb->lsn_valid);
 670
 671         *flushedp=TRUE;
 672         captive_privbcb_flush_unordered(privbcb);
 673 }
 674
 675 static void captive_privbcb_flush_ordered(struct private_bcb *privbcb_req);
 676
 677 void captive_cc_flush(void)
 678 {
 679 gboolean flushed;
 680
 681         fileobject_cached_hash_init();
 682         private_bcb_hash_init();
 683
 684         do {
 685                 /* Trace it by g_tree first to attempt to keep LSN ordering */
 686                 captive_privbcb_flush_ordered(NULL);
 687                 flushed=FALSE;
 688                 g_hash_table_foreach(
 689                                 private_bcb_hash,       /* hash_table */
 690                                 (GHFunc)captive_cc_flush_private_bcb_hash_foreach,      /* func */
 691                                 &flushed);      /* user_data */
 692                 captive_leave();
 693                 } while (flushed);
 694
 695         /* We must not call: captive_cc_FileObject_delete(NULL);
 696          * here as it would destroy all the Bcbs needed for the forthcoming
 697          * IoShutdownRegisteredFileSystems().
 698          */
 699 }
 700
 701
 702 static ULONG captive_Cc_IoPageRead(FILE_OBJECT *FileObject,gpointer address,ULONG length,LARGE_INTEGER *FileOffset)
 703 {
 704 MDL *Mdl;
 705 KEVENT Event;
 706 IO_STATUS_BLOCK IoStatus;
 707 NTSTATUS err;
 708
 709         g_return_val_if_fail(FileObject!=NULL,0);
 710         g_return_val_if_fail(address!=0,0);
 711         g_return_val_if_fail(length!=0,0);
 712         g_return_val_if_fail(FileOffset!=NULL,0);
 713
 714         /* VolumeRead on ext2fsd.sys will return IoStatus.Information==0 although it
 715          * successfuly read the data. Workaround it - preclear (not postclear) the
 716          * buffer and do not make any other assumptions about the data read.
 717          */
 718         memset(address,0,PAGE_SIZE);    /* pre-clear the buffer */
 719         Mdl=MmCreateMdl(NULL,address,PAGE_SIZE);        /* FIXME: Deprecated in favor of IoAllocateMdl() */
 720         g_assert(Mdl!=NULL);
 721         MmBuildMdlForNonPagedPool(Mdl);
 722         KeInitializeEvent(&Event,NotificationEvent,FALSE);
 723         IoStatus.Information=0; /* preventive pre-clear for buggy filesystems */
 724         err=IoPageRead(FileObject,Mdl,FileOffset,&Event,&IoStatus);
 725         g_assert(NT_SUCCESS(err));
 726         g_assert(NT_SUCCESS(IoStatus.Status));
 727         /* It is not == as the file may be shorter than requested */
 728         g_assert(IoStatus.Information<=length);
 729         IoFreeMdl(Mdl);
 730
 731         /* Forbidden, see the comment above about ext2fsd.sys.
 732          * memset(((char *)address)+IoStatus.Information,0,(length-IoStatus.Information));
 733          */
 734
 735         return IoStatus.Information;    /* may be shorter than real! */
 736 }
 737
 738
 739 static struct private_bcb *captive_privbcb_find(IN PFILE_OBJECT FileObject,IN PLARGE_INTEGER FileOffset,IN ULONG Length,
 740                 PUBLIC_BCB *Bcb_find)
 741 {
 742 struct page_position pagepos_local,*pagepos;
 743 struct private_bcb *privbcb,*privbcb_listitem;
 744 GList *privbcb_list;
 745
 746         g_return_val_if_fail(FileObject!=NULL,NULL);
 747         g_return_val_if_fail(FileOffset!=NULL,NULL);
 748         /* 'Bcb_find' may be NULL */
 749
 750         page_position_hash_init();
 751
 752         pagepos_local.FileObject=FileObject;
 753         pagepos_local.FileOffset.QuadPart=CAPTIVE_ROUND_DOWN64(FileOffset->QuadPart,PAGE_SIZE);
 754         pagepos_local.privbcb_list=NULL;
 755         pagepos_local.shmid=-1;
 756         if (!(pagepos=g_hash_table_lookup(page_position_hash,&pagepos_local)))
 757                 return NULL;
 758         g_assert(validate_page_position(pagepos));
 759         g_assert(pagepos->privbcb_list!=NULL);
 760
 761         privbcb=NULL;
 762         for (privbcb_list=pagepos->privbcb_list;privbcb_list;privbcb_list=privbcb_list->next) {
 763                 privbcb_listitem=privbcb_list->data;
 764                 if (1
 765                                 && privbcb_listitem->MappedFileOffset.QuadPart==FileOffset->QuadPart
 766                                 && privbcb_listitem->MappedLength==Length
 767                                 && (!Bcb_find || Bcb_find==privbcb_listitem->PublicBcb)) {
 768                         g_assert(privbcb==NULL);        /* appropriate 'Bcb_find'-matching privbcb found twice */
 769                         privbcb=privbcb_listitem;
 770                         if (!Bcb_find)
 771                                 break;
 772                         }
 773                 }
 774         if (!privbcb)
 775                 return NULL;
 776
 777         /* Sanity check 'privbcb': */
 778         g_return_val_if_fail(FileObject==privbcb->FileObject,FALSE);
 779
 780         return privbcb;
 781 }
 782
 783
 784 /**
 785  * CcMapData:
 786  * @FileObject: Initialized open #FileObject to map.
 787  * %NULL value is forbidden.
 788  * @FileOffset: The @FileObject file offset from where to map the region from.
 789  * Negative value is forbidden.
 790  * @Length: Requested length of the region to map from @FileObject.
 791  * FIXME: Value %0 is currently forbidden by libcaptive; it should be allowed.
 792  * @Flags: %MAP_WAIT means whether disk waiting is permitted for this function.
 793  * Value without %MAP_WAIT is currently forbidden by libcaptive as we have no on-demand loading implemented.
 794  * %MAP_NO_READ will leave the pages unread (libcaptive: unread pages zeroed,
 795  * already mapped pages shared with existing content) - needed by ntfs.sys of NT-5.1sp1
 796  * as during file write it will %MAP_NO_READ and consequently push the data there;
 797  * any request for the same file range read in the meantime will destroy the prepared data!
 798  * @Bcb: Returns initialized #PUBLIC_BCB to refer to the mapped region.
 799  * The memory region can be larger than requested as it is %PAGE_SIZE aligned.
 800  * %NULL pointer is forbidden.
 801  * @Buffer: Returns the mapped memory region start address.
 802  * This address may not be %PAGE_SIZE aligned.
 803  * %NULL pointer is forbidden.
 804  *
 805  * Maps the specified region of @FileObject to automatically chosen address space.
 806  * FIXME: No on-demand loading implemented yet - the whole region is read at the time of this function call.
 807  *
 808  * WARNING: If you modify the data in the returned @Buffer you must call some CcPinMappedData()
 809  * or CcPinRead() afterwards. W32 docs say you should never modify the data in any way from this function
 810  * but W32 filesystems apparently do not conform to it. :-)  If you do not take care of the
 811  * modified data by some dirty-marking facility such data will be carelessly dropped without
 812  * their commit to the disk.
 813  *
 814  * Every call to this function must be matched by a one corresponding CcUnpinData() call.
 815  *
 816  * We can be called as full CcMapData() (e.g. CcPinRead() from fastfat.sys)
 817  * even if such mapping for such file already exists.
 818  * We should probably create a new #Bcb for the same space,
 819  * at least ntfs.sys of NT-5.1sp1 appears to expect it. Bleech.
 820  *
 821  * Returns: %TRUE if the region was successfuly mapped.
 822  * @Bcb with the initialized new memory region.
 823  * @Buffer with the address of the exact byte specified by @FileOffset.
 824  */
 825 BOOLEAN CcMapData(IN PFILE_OBJECT FileObject,
 826                 IN PLARGE_INTEGER FileOffset,IN ULONG Length,IN ULONG Flags,OUT PVOID *Bcb,OUT PVOID *Buffer)
 827 {
 828 PUBLIC_BCB **PublicBcbp,*PublicBcb;
 829 struct page_position pagepos_local;
 830 LARGE_INTEGER FileOffset_bottom,FileOffset_top;
 831 gpointer base_aligned;
 832 size_t length_mapped_aligned;
 833 gint length_pages_aligned;
 834 struct page_position **pagepos_array;
 835 int errint;
 836 gpointer errptr;
 837 struct private_bcb *privbcb;
 838 gboolean after_eof=FALSE;       /* Did we reached the end of file already? */
 839
 840         g_return_val_if_fail(FileObject!=NULL,FALSE);
 841         g_return_val_if_fail(FileOffset!=NULL,FALSE);
 842         g_return_val_if_fail(FileOffset->QuadPart>=0,FALSE);
 843         g_return_val_if_fail(Length>0,FALSE);   /* FIXME: not handled below; 0 should be allowed */
 844         g_return_val_if_fail(Flags&MAP_WAIT,FALSE);     /* FIXME: on-demand loading not yet implemented */
 845         g_return_val_if_fail(!(Flags&~(MAP_WAIT|MAP_NO_READ)),FALSE);   /* unknown flags? */
 846         g_return_val_if_fail(Bcb!=NULL,FALSE);
 847         g_return_val_if_fail(Buffer!=NULL,FALSE);
 848
 849         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: FileObject=%p,FileOffset=0x%llX,Length=0x%lX,Flags=0x%lX",G_STRLOC,
 850                         FileObject,(guint64)FileOffset->QuadPart,(gulong)Length,(gulong)Flags);
 851
 852         if (Flags&MAP_NO_READ) {
 853                 g_assert(0==CAPTIVE_ROUND_DOWN_EXCEEDING64(FileOffset->QuadPart,PAGE_SIZE));    /* NOT IMPLEMENTED YET */
 854                 /* It may not be aligned as this function is prepared by 'after_eof' for incomplete tails.
 855                  * It is being used at least by ntfs.sys of NT-5.1sp1 CcCopyWrite().
 856                  */
 857 #if 0
 858                 g_assert(0==CAPTIVE_ROUND_DOWN_EXCEEDING64(FileOffset->QuadPart+Length,PAGE_SIZE));     /* NOT IMPLEMENTED YET */
 859 #endif
 860                 }
 861
 862         g_return_val_if_fail(FileObject->SectionObjectPointers!=NULL,FALSE);
 863         g_return_val_if_fail(FileObject->DeviceObject!=NULL,FALSE);
 864 #if 0   /* SectorSize can be really weird but we do not use it anyway */
 865         /* Is PAGE_SIZE aligned with 'FileObject->DeviceObject->SectorSize'?
 866          * 'SectorSize' may not yet be initialized during mount operation
 867          * and 'FileObject->DeviceObject->Vpb' may exist in such case.
 868          */
 869         g_return_val_if_fail(0
 870                                         || FileObject->DeviceObject->SectorSize==0      /* prevent division by 0 */
 871                                         || 0==CAPTIVE_ROUND_DOWN_EXCEEDING(PAGE_SIZE,FileObject->DeviceObject->SectorSize),
 872                         FALSE);
 873 #endif
 874
 875         page_position_hash_init();
 876         private_bcb_hash_init();
 877
 878         PublicBcbp=(PUBLIC_BCB **)Bcb;
 879         /* extend 'FileOffset' and 'Length' to page boundaries */
 880         FileOffset_bottom.QuadPart=CAPTIVE_ROUND_DOWN64(FileOffset->QuadPart,PAGE_SIZE);
 881         FileOffset_top.QuadPart=CAPTIVE_ROUND_UP64(FileOffset->QuadPart+Length,PAGE_SIZE);
 882         length_mapped_aligned=(FileOffset_top.QuadPart-FileOffset_bottom.QuadPart);
 883         g_assert(0==CAPTIVE_ROUND_DOWN_EXCEEDING(length_mapped_aligned,PAGE_SIZE));
 884         length_pages_aligned=length_mapped_aligned/PAGE_SIZE;
 885
 886         /* We can be called as full CcMapData() (e.g. CcPinRead() from fastfat.sys)
 887          * even if such mapping for such file already exists.
 888          * We should probably create a new Bcb for the same space,
 889          * at least ntfs.sys of NT-5.1sp1 appears to expect it. Bleech.
 890          */
 891         if ((privbcb=captive_privbcb_find(FileObject,FileOffset,Length,NULL)))
 892                 g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: FileObject=%p,FileOffset=0x%llX,Length=0x%lX already mapped by privbcb %p",
 893                                 G_STRLOC,FileObject,(guint64)FileOffset->QuadPart,(gulong)Length,privbcb);
 894
 895         /* Create 'base_aligned'; referenced as unaligned by 'privbcb'. */
 896         /* TODO: on-demand loading */
 897         /* Although we do zeroed-page mapping here we just reserve the linear
 898          * space by it.
 899          */
 900         base_aligned=mmap(
 901                         NULL,   /* start */
 902                         PAGE_SIZE+length_mapped_aligned+PAGE_SIZE,      /* length; leading and trailing boundary check pages */
 903                         PROT_READ|PROT_WRITE,   /* prot; read/write must be possible although write is not guaranteed to be flushed yet */
 904                         MAP_PRIVATE|MAP_ANONYMOUS,      /* flags */
 905                         -1,     /* fd; ignored due to MAP_ANONYMOUS */
 906                         0);     /* offset; ignored due to MAP_ANONYMOUS */
 907         g_assert(base_aligned!=NULL);
 908
 909         base_aligned+=PAGE_SIZE;
 910         errint=munmap(base_aligned-PAGE_SIZE,PAGE_SIZE);        /* unmap leading boundary check page */
 911         g_assert(errint==0);
 912         errint=munmap(base_aligned+length_mapped_aligned,PAGE_SIZE);    /* unmap trailing boundary check page */
 913         g_assert(errint==0);
 914
 915         /* Create 'PublicBcb'; referenced by 'privbcb'. */
 916         captive_new(PublicBcb);
 917         PublicBcb->NodeTypeCode=CAPTIVE_PUBLIC_BCB_NODETYPECODE;
 918         PublicBcb->NodeByteSize=sizeof(*PublicBcb);     /* we have no extensions there */
 919         PublicBcb->MappedLength=Length;
 920         PublicBcb->MappedFileOffset=*FileOffset;
 921
 922         /* Create 'privbcb'; referenced by created 'pagepos'es. */
 923         captive_new(privbcb);
 924         privbcb->PublicBcb=PublicBcb;
 925         privbcb->FileObject=FileObject;
 926         privbcb->ref_count=1;
 927         privbcb->leave_func_pending=FALSE;
 928         privbcb->MappedLength=PublicBcb->MappedLength;
 929         privbcb->MappedFileOffset=PublicBcb->MappedFileOffset;
 930         privbcb->base=base_aligned+CAPTIVE_ROUND_DOWN_EXCEEDING64(FileOffset->QuadPart,PAGE_SIZE);
 931         privbcb->dirty=FALSE;
 932         privbcb->lsn_valid=FALSE;
 933         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: g_hash_table_insert: PublicBcb=%p,privbcb=%p",G_STRLOC,
 934                         PublicBcb,privbcb);
 935         g_hash_table_insert(private_bcb_hash,
 936                         PublicBcb,      /* key */
 937                         privbcb);       /* value */
 938
 939         privbcb_set(privbcb,PRIVBCB_ITEM_NOP,0);        /* just for the assertions */
 940
 941         /* We MUST NOT call captive_Cc_IoPageRead() inside our pagepos filling loop
 942          * below as captive_Cc_IoPageRead() has very big consequences as it calls
 943          * the filesystem code and we may get reentrancy.
 944          * Therefore we store all missing page read requests to 'pagepos_array' and we
 945          * fill them when all the memory structures are in consistent state.
 946          * We can also coalescence the requests more easily this way.
 947          */
 948         captive_newn_alloca(pagepos_array,length_pages_aligned);
 949
 950         pagepos_local.FileObject=FileObject;
 951         pagepos_local.shmid=-1;
 952         pagepos_local.privbcb_list=NULL;
 953         {
 954 size_t offset;
 955
 956                 for (
 957                                 offset=0;
 958                                 offset<length_mapped_aligned;
 959                                 offset+=PAGE_SIZE) {
 960 gpointer pageaddr;
 961 struct page_position *pagepos;
 962
 963                         pagepos_local.FileOffset.QuadPart=FileOffset_bottom.QuadPart+offset;
 964                         pageaddr=(gpointer)(((char *)base_aligned)+offset);
 965                         if (!(pagepos=g_hash_table_lookup(page_position_hash,&pagepos_local))) {
 966                                 captive_new(pagepos);
 967                                 *pagepos=pagepos_local;
 968                                 pagepos->shmid=-1;
 969                                 pagepos->privbcb_list=NULL;
 970                                 pagepos->building=TRUE;
 971                                 g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: read of offset %llu to new pagepos %p of pure mmap() to address %p",
 972                                                 G_STRLOC,(unsigned long long)offset,pagepos,pageaddr);
 973                                 }
 974                         else if (pagepos->privbcb_list->next==NULL) {  /* exactly one item (no IPC shm yet) */
 975                                 g_assert(pagepos->shmid==-1);
 976                                 if (-1==(pagepos->shmid=shmget(IPC_PRIVATE,PAGE_SIZE,IPC_CREAT|IPC_CREAT|0600)))
 977                                         g_error("%s: Failed shmget(2), you may be out of maximum system IPC shared pages",G_STRLOC);
 978                                 g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: created shmid %d out of mmap() for offset %llu to existing pagepos %p to address %p",
 979                                                 G_STRLOC,pagepos->shmid,(unsigned long long)offset,pagepos,pageaddr);
 980                                 /* Reentrancy occured? */
 981                                 g_assert(Flags&MAP_NO_READ || !pagepos->building);
 982                                 }
 983                         else {  /* already >=2 mappings, already IPC shared mem */
 984                                 g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: already shared shmid of offset %llu by existing pagepos %p shmid %d to address %p",
 985                                                 G_STRLOC,(unsigned long long)offset,pagepos,pagepos->shmid,pageaddr);
 986                                 g_assert(pagepos->shmid!=-1);
 987                                 g_assert(pagepos->privbcb_list!=NULL);
 988                                 /* Reentrancy occured? */
 989                                 g_assert(Flags&MAP_NO_READ || !pagepos->building);
 990                                 }
 991                         pagepos_array[offset/PAGE_SIZE]=pagepos;
 992                         if (pagepos->privbcb_list) {    /* Not the first one - some shm in use now? */
 993                                 /* It appears as shmat(2) cannot override previously mmap(2)ed memory;
 994                                  * mmap(2) is still needed to get linear block of memory assignment.
 995                                  */
 996                                 /* TODO:thread; munmap()..shmat() window */
 997                                 errint=munmap(pageaddr,PAGE_SIZE);
 998                                 g_assert(errint==0);
 999                                 errptr=shmat(pagepos->shmid,
1000                                                 pageaddr,       /* shmaddr */
1001                                                 0);     /* shmflg; !SHM_RDONLY==r/w */
1002                                 g_assert(errptr==pageaddr);
1003                                 }
1004
1005                         g_assert(g_list_find(pagepos->privbcb_list,privbcb)==NULL);
1006                         pagepos->privbcb_list=g_list_prepend(pagepos->privbcb_list,privbcb);    /* order not important */
1007                         g_assert(g_list_find(pagepos->privbcb_list,privbcb)!=NULL);
1008                         if (pagepos->privbcb_list->next==NULL) {        /* exactly one item (we just added it now) */
1009
1010                                 g_assert(pagepos->shmid==-1);
1011                                 g_hash_table_insert(page_position_hash,
1012                                                 pagepos,        /* key */
1013                                                 pagepos);       /* value */
1014                                 }
1015                         else if (pagepos->privbcb_list->next->next==NULL) {     /* second mapping - new shm */
1016 struct private_bcb *privbcb_orig;
1017 gint64 privbcb_orig_offset_relative;
1018 gpointer mapped_orig;
1019
1020                                 g_assert(pagepos->shmid!=-1);
1021                                 errint=shmctl(pagepos->shmid,
1022                                                 IPC_RMID,       /* cmd */
1023                                                 NULL);  /* buf */
1024                                 g_assert(errint==0);
1025                                 g_assert(pagepos->privbcb_list->data==privbcb); /* our privbcb should be the first */
1026                                 g_assert(pagepos->privbcb_list->next!=NULL);    /* we have exactly two items in the list */
1027                                 g_assert(pagepos->privbcb_list->next->next==NULL);      /* we have exactly two items in the list */
1028                                 privbcb_orig=pagepos->privbcb_list->next->data;
1029                                 privbcb_orig_offset_relative=pagepos->FileOffset.QuadPart-privbcb_orig->MappedFileOffset.QuadPart;
1030                                 /* privbcb_orig_offset_relative may be negative up to -PAGE_SIZE
1031                                  * as 'MappedFileOffset' and 'base' are not page-aligned.
1032                                  */
1033                                 mapped_orig=privbcb_orig->base+privbcb_orig_offset_relative;
1034                                 memcpy(pageaddr,mapped_orig,PAGE_SIZE);
1035                                 /* TODO:thread; munmap()..shmat() window */
1036                                 errint=munmap(mapped_orig,PAGE_SIZE);
1037                                 g_assert(errint==0);
1038                                 errptr=shmat(pagepos->shmid,
1039                                                 mapped_orig,    /* shmaddr */
1040                                                 0);     /* shmflg; !SHM_RDONLY==r/w */
1041                                 g_assert(errptr==mapped_orig);
1042                                 }
1043                         g_assert(validate_page_position(pagepos));
1044                         }
1045                 }
1046
1047         /* Fill in the missing pages content todo-list by stored 'pagepos_array' '->building' flags: */
1048         if (!(Flags&MAP_NO_READ)) {
1049 size_t offset_start,offset_end;
1050
1051                 for (
1052                                 offset_start=0;
1053                                 offset_start<length_mapped_aligned;
1054                                 offset_start=offset_end) {
1055 struct page_position *pagepos_start;
1056 size_t offset_built;
1057 gpointer pageaddr;
1058 ULONG got;
1059
1060                         offset_end=offset_start+PAGE_SIZE;
1061                         pagepos_start=pagepos_array[offset_start/PAGE_SIZE];
1062                         if (!pagepos_start->building)
1063                                 continue;
1064                         g_assert(offset_start==pagepos_start->FileOffset.QuadPart-FileOffset_bottom.QuadPart);
1065                         pageaddr=(gpointer)(((char *)base_aligned)+offset_start);
1066                         /* Coalescence of the requests. */
1067                         for (
1068                                         offset_end=offset_start+PAGE_SIZE;
1069                                         offset_end<length_mapped_aligned;
1070                                         offset_end+=PAGE_SIZE) {
1071 struct page_position *pagepos_end;
1072
1073                                 pagepos_end=pagepos_array[offset_end/PAGE_SIZE];
1074                                 g_assert(offset_end==pagepos_end->FileOffset.QuadPart-FileOffset_bottom.QuadPart);
1075                                 if (!pagepos_end->building)
1076                                         break;
1077                                 }
1078                         /* Read the range content: */
1079                         got=captive_Cc_IoPageRead(FileObject,pageaddr,offset_end-offset_start,&pagepos_start->FileOffset);
1080                         if (after_eof)
1081                                 g_assert(got==0);
1082                         else
1083                                 g_assert(got<=PAGE_SIZE);
1084                         after_eof=(got<PAGE_SIZE);
1085                         /* Unmark 'building' flags. */
1086                         for (
1087                                         offset_built=offset_start;
1088                                         offset_built<offset_end;
1089                                         offset_built+=PAGE_SIZE) {
1090 struct page_position *pagepos_built;
1091
1092                                 pagepos_built=pagepos_array[offset_built/PAGE_SIZE];
1093                                 g_assert(offset_built==pagepos_built->FileOffset.QuadPart-FileOffset_bottom.QuadPart);
1094                                 g_assert(pagepos_built->building==TRUE);
1095                                 pagepos_built->building=FALSE;
1096                                 }
1097                         }
1098                 }
1099
1100         /* offset _into_ page, may not be PAGE_SIZE aligned: */
1101         *Buffer=privbcb->base;
1102         *PublicBcbp=PublicBcb;
1103         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,
1104                         "%s: result: privbcb=%p,privbcb->base=%p,privbcb->base+privbcb->MappedLength=%p,privbcb->MappedLength=0x%lX",
1105                         G_STRLOC,privbcb,privbcb->base,((char *)privbcb->base)+privbcb->MappedLength,(unsigned long)privbcb->MappedLength);
1106         g_assert(validate_Bcb(PublicBcb)==TRUE);
1107         if (!FileObject->SectionObjectPointers->SharedCacheMap)
1108                 FileObject->SectionObjectPointers->SharedCacheMap=PublicBcb;
1109         else {
1110                 /* FIXME: (NOTE*1) Weird but it appears as fastfat.sys during make_directory()
1111                  * can pass us an already cached 'FileObject' (with different offset/size).
1112                  * We must not CcUnpinData() it as its BCB is still referenced (CcUnpinData()ed) by fastfat.sys.
1113                  */
1114                 FileObject->SectionObjectPointers->SharedCacheMap=NULL;
1115                 }
1116         FileObject->SectionObjectPointers->SharedCacheMap=PublicBcb;
1117
1118         return TRUE;
1119 }
1120
1121
1122 /**
1123  * CcPinMappedData:
1124  * @FileObject: Initialized open #FileObject to map.
1125  * %NULL value is forbidden.
1126  * @MappedFileOffset: The @FileObject file offset from where to map the region from.
1127  * Negative value is forbidden.
1128  * @MappedLength: Requested length of the region to map from @FileObject.
1129  * FIXME: Value %0 is currently forbidden by libcaptive; it should be allowed.
1130  * @Wait: Whether disk waiting is permitted for this function.
1131  * Value currently ignored by libcaptive as the data must have been mapped by CcMapData() already anyway.
1132  * @Flags: %PIN_WAIT means whether disk waiting is permitted for this function.
1133  * Value without %PIN_WAIT is currently permtted by libcaptive as the data must have been mapped by CcMapData() already anyway.
1134  * %PIN_NO_READ is the same as %MAP_NO_READ - see CcMapData().
1135  * FIXME: %PIN_EXCLUSIVE for exclusive @Bcb access is now ignored by libcaptive.
1136  * %PIN_IF_BCB if @Bcb should never be created; function is successful only if @Bcb already exists.
1137  * @Bcb: Returns initialized #PUBLIC_BCB to refer to the mapped region.
1138  * The memory region can be larger than requested as it is %PAGE_SIZE aligned.
1139  * %NULL pointer is forbidden.
1140  * @Buffer: Returns the mapped memory region start address.
1141  * This address may not be %PAGE_SIZE aligned.
1142  * %NULL pointer is forbidden.
1143  *
1144  * This function will allow you to modify the data mapped by CcMapData().
1145  * libcaptive does not differentiate this function with CcMapData().
1146  *
1147  * NEVER re-read any memory from FileObject here!
1148  * at least fastfat.sys directory create relies on the fact of CcPinRead()
1149  * with already modified buffers to be left intact.
1150  *
1151  * This call will proceed as CcPinRead() if such #Bcb does not yet exist.
1152  * This is IMO just a bug workaround for a peruse by fastfat.sys FatLocateVolumeLabel().
1153  *
1154  * Every call to this function must be matched by a one corresponding CcUnpinData() call.
1155  *
1156  * Returns: %TRUE if the region was successfuly mapped.
1157  * @Bcb with the initialized new memory region.
1158  * @Buffer with the address of the exact byte specified by @FileOffset.
1159  */
1160 BOOLEAN CcPinMappedData
1161                 (IN PFILE_OBJECT FileObject,IN PLARGE_INTEGER FileOffset,IN ULONG Length,IN ULONG Flags,OUT PVOID *Bcb)
1162 {
1163 struct private_bcb *privbcb;
1164
1165         g_return_val_if_fail(FileObject!=NULL,FALSE);
1166         g_return_val_if_fail(FileOffset!=NULL,FALSE);
1167         g_return_val_if_fail(FileOffset->QuadPart>=0,FALSE);
1168         g_return_val_if_fail(Length>0,FALSE);   /* FIXME: not handled below; 0 should be allowed */
1169         /* 'Flags&PIN_WAIT' ignored as we already must have the data mapped */
1170         g_return_val_if_fail(!(Flags&~(PIN_WAIT|PIN_EXCLUSIVE|PIN_NO_READ|PIN_IF_BCB)),FALSE);  /* unknown flags? */
1171         g_return_val_if_fail(Bcb!=NULL,FALSE);
1172
1173         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: FileObject=%p,FileOffset=0x%llX,Length=0x%lX,Flags=0x%lX",G_STRLOC,
1174                         FileObject,(guint64)FileOffset->QuadPart,(gulong)Length,(gulong)Flags);
1175
1176         privbcb=captive_privbcb_find(FileObject,FileOffset,Length,NULL);
1177         if (!privbcb && (Flags & PIN_IF_BCB))   /* BCB does not exist */
1178                 return FALSE;
1179         /* Appropriate privbcb not found.
1180          * This IMO should not happen and it is a bug in the client.
1181          * Unfortuantely fastfat.sys FatLocateVolumeLabel() will CcPinMappedData()
1182          * the volume label dirent without any previous CcMapData() or CcPinRead() !
1183          */
1184         if (!privbcb) {
1185 PVOID Buffer;
1186
1187                 return CcPinRead(
1188                                 FileObject,
1189                                 FileOffset,
1190                                 Length,
1191                                 0               /* Flags */
1192                                                 | (Flags&PIN_NO_READ ? MAP_NO_READ : 0)
1193                                                 | (Flags&PIN_WAIT    ? MAP_WAIT    : 0),
1194                                 Bcb,
1195                                 &Buffer);
1196                 }
1197
1198         /* NEVER re-read any memory from FileObject here! */
1199
1200         privbcb_set(privbcb,PRIVBCB_ITEM_REF_COUNT,+1);
1201
1202         /* Memory already mapped by CcMapData(). */
1203         *Bcb=privbcb->PublicBcb;
1204         return TRUE;
1205 }
1206
1207
1208 /**
1209  * CcPinRead:
1210  * @FileObject: Initialized open #FileObject to map.
1211  * %NULL value is forbidden.
1212  * @FileOffset: The @FileObject file offset from where to map the region from.
1213  * Negative value is forbidden.
1214  * @Length: Requested length of the region to map from @FileObject.
1215  * FIXME: Value %0 is currently forbidden by libcaptive; it should be allowed.
1216  * @Flags: %PIN_WAIT means whether disk waiting is permitted for this function.
1217  * Value without %PIN_WAIT is currently permtted by libcaptive as the data must have been mapped by CcMapData() already anyway.
1218  * %PIN_NO_READ is the same as %MAP_NO_READ - see CcMapData().
1219  * FIXME: %PIN_EXCLUSIVE for exclusive @Bcb access is now ignored by libcaptive.
1220  * %PIN_IF_BCB if @Bcb should never be created; function is successful only if @Bcb already exists.
1221  * @Bcb: Returns initialized #PUBLIC_BCB to refer to the mapped region.
1222  * The memory region can be larger than requested as it is %PAGE_SIZE aligned.
1223  * %NULL pointer is forbidden.
1224  * @Buffer: Returns the mapped memory region start address.
1225  * This address may not be %PAGE_SIZE aligned.
1226  * %NULL pointer is forbidden.
1227  *
1228  * Merely a shortcut call for CcMapData() and CcPinMappedData() afterwards.
1229  * See these two functions for the details. It has a difference to subsequent
1230  * calling of CcMapData() and CcPinMappedData() instead as this call counts
1231  * only as one function for a corresponding CcUnpinData() call.
1232  *
1233  * Every call to this function must be matched by a one corresponding CcUnpinData() call.
1234  *
1235  * Returns: %TRUE if the region was successfuly mapped.
1236  * @Bcb with the initialized new memory region.
1237  * @Buffer with the address of the exact byte specified by @FileOffset.
1238  */
1239 BOOLEAN CcPinRead(IN PFILE_OBJECT FileObject,
1240                 IN PLARGE_INTEGER FileOffset,IN ULONG Length,IN ULONG Flags,OUT PVOID *Bcb,OUT PVOID *Buffer)
1241 {
1242 PVOID Bcb_CcPinMappedData;
1243 gboolean errbool;
1244 gboolean count_CcMapData;
1245 struct private_bcb *privbcb;
1246
1247         g_return_val_if_fail(FileObject!=NULL,FALSE);
1248         g_return_val_if_fail(FileOffset!=NULL,FALSE);
1249         g_return_val_if_fail(FileOffset->QuadPart>=0,FALSE);
1250         g_return_val_if_fail(Length>0,FALSE);   /* FIXME: not handled below; 0 should be allowed */
1251         /* 'Flags&PIN_WAIT' ignored as we already must have the data mapped */
1252         g_return_val_if_fail(!(Flags&~(PIN_WAIT|PIN_EXCLUSIVE|PIN_NO_READ|PIN_IF_BCB)),FALSE);  /* unknown flags? */
1253         g_return_val_if_fail(Bcb!=NULL,FALSE);
1254         g_return_val_if_fail(Buffer!=NULL,FALSE);
1255
1256         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: FileObject=%p,FileOffset=0x%llX,Length=0x%lX,Flags=0x%lX",G_STRLOC,
1257                         FileObject,(guint64)FileOffset->QuadPart,(gulong)Length,(gulong)Flags);
1258
1259         if (!(Flags&PIN_IF_BCB)) {
1260                 errbool=CcMapData(FileObject,FileOffset,Length,
1261                                 0               /* Flags */
1262                                                 | (Flags&PIN_NO_READ ? MAP_NO_READ : 0)
1263                                                 | (Flags&PIN_WAIT    ? MAP_WAIT    : 0),
1264                                 Bcb,Buffer);
1265                 g_return_val_if_fail(errbool==TRUE,FALSE);
1266                 count_CcMapData=TRUE;
1267                 }
1268         else
1269                 count_CcMapData=FALSE;
1270
1271         errbool=CcPinMappedData(FileObject,FileOffset,Length,Flags,&Bcb_CcPinMappedData);
1272         if (!(Flags&PIN_IF_BCB)) {
1273                 g_return_val_if_fail(errbool==TRUE,FALSE);
1274                 g_return_val_if_fail(Bcb_CcPinMappedData==*Bcb,FALSE);
1275                 }
1276         else {
1277                 if (errbool==FALSE)     /* FALSE permitted; We may fail if Bcb does not exist yet. */
1278                         return FALSE;
1279                 *Bcb=Bcb_CcPinMappedData;
1280                 }
1281
1282         privbcb=captive_privbcb_find(FileObject,FileOffset,Length,*Bcb);
1283         g_assert(privbcb!=NULL);
1284         g_assert(privbcb->ref_count>=1);
1285         g_assert(privbcb->PublicBcb==*Bcb);
1286         if (count_CcMapData) {
1287                 /* CcPinRead() must always reference-count only by 1 despite any sub-called functions! */
1288                 g_assert(privbcb->ref_count>=2);
1289                 privbcb_set(privbcb,PRIVBCB_ITEM_REF_COUNT,-1);
1290                 }
1291
1292         return TRUE;
1293 }
1294
1295
1296 static void logging_notify_privbcb_flush(struct private_bcb *privbcb);
1297
1298 static void captive_privbcb_flush_unordered(struct private_bcb *privbcb)
1299 {
1300 MDL *Mdl;
1301 KEVENT Event;
1302 IO_STATUS_BLOCK IoStatus;
1303 NTSTATUS err;
1304 gpointer base_sectoraligned;
1305 gsize length_sectoraligned;
1306 LARGE_INTEGER FileOffset_sectoraligned;
1307 gsize sectorsize;
1308 struct fileobject_cached *fileobject_cached;
1309 IRP *saved_TopLevelIrp;
1310 static gint64 last_written_lsn=G_MININT64;
1311
1312         g_assert(privbcb->ref_count>0);
1313
1314         if (!privbcb->dirty)
1315                 return;
1316
1317         privbcb_set(privbcb,PRIVBCB_ITEM_REF_COUNT_DESTRUCTOR,+1);
1318         logging_notify_privbcb_flush(privbcb);
1319         g_assert(privbcb->ref_count>=2);
1320         privbcb_set(privbcb,PRIVBCB_ITEM_REF_COUNT_DESTRUCTOR,-1);
1321
1322         if (privbcb->lsn_valid) {
1323                 if (!(last_written_lsn<privbcb->lsn.QuadPart))
1324                         g_error("%s: last_written_lsn=%" G_GINT64_FORMAT " !< privbcb->lsn=%" G_GINT64_FORMAT,G_STRLOC,
1325                                         last_written_lsn,(gint64)privbcb->lsn.QuadPart);
1326                 g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: LSN write: last_written_lsn was %" G_GINT64_FORMAT ", is %" G_GINT64_FORMAT,
1327                                 G_STRLOC,last_written_lsn,(gint64)privbcb->lsn.QuadPart);
1328                 last_written_lsn=privbcb->lsn.QuadPart;
1329                 }
1330
1331         /* Prepare NULL TopLevelIrp for fileobject_cached->CallBacks.{AcquireForLazyWrite,ReleaseFromLazyWrite}
1332          */
1333         saved_TopLevelIrp=IoGetTopLevelIrp();
1334         IoSetTopLevelIrp(NULL);
1335
1336         fileobject_cached_hash_init();
1337         if ((fileobject_cached=g_hash_table_lookup(fileobject_cached_hash,privbcb->FileObject)))
1338                 (*fileobject_cached->CallBacks.AcquireForLazyWrite)(
1339                                 fileobject_cached->LazyWriterContext,   /* Context */
1340                                 TRUE);  /* Wait */
1341
1342         g_assert(privbcb->FileObject->DeviceObject!=NULL);
1343
1344         /* We can get 0=='privbcb->FileObject->DeviceObject->SectorSize' during mount of ext2fsd.sys.
1345          * FIXME: We are unable to find the correct sectorsize for a filesystem as
1346          * even the 'CommonFcb' below contains invalid information.
1347          * As we need to have 'sectorsize' <=filesystem_blocksize at least for ext2fsd.sys
1348          * we choose PAGE_SIZE - the maximum libcaptive can with its design and also the maximum
1349          * size ever needed for ext2fsd.sys (PAGE_SIZE is the maximum ext2 block size).
1350          */
1351         sectorsize=PAGE_SIZE;
1352 #if 0
1353         sectorsize=privbcb->FileObject->DeviceObject->SectorSize;
1354         if (privbcb->FileObject->FsContext) {
1355 REACTOS_COMMON_FCB_HEADER *CommonFcb=(REACTOS_COMMON_FCB_HEADER *)privbcb->FileObject->FsContext;
1356
1357                 /* FIXME: Check CommonFcb->Type */
1358                 /* 'AllocationSize' can be less than 'sectorsize' if the total file length is smaller.
1359                  * Observed with ext2fsd.sys volume-file.
1360                  */
1361                 if (sectorsize<CommonFcb->AllocationSize.QuadPart)
1362                         sectorsize=CommonFcb->AllocationSize.QuadPart;
1363                 }
1364 #endif
1365
1366         /* Is PAGE_SIZE aligned with 'privbcb->FileObject->DeviceObject->SectorSize'? */
1367         g_assert(sectorsize>0);
1368         g_assert(0==CAPTIVE_ROUND_DOWN_EXCEEDING(PAGE_SIZE,sectorsize));
1369         /* We align here directly the 'privbcb->base' which is not correct.
1370          * We should rather aligned according to 'privbcb->MappedOffset' but
1371          * as 'privbcb->base' with PAGE_SIZE alignment is just a possibly
1372          * better alignment than 'privbcb->FileObject->DeviceObject->SectorSize' it must the same operation.
1373          */
1374         g_assert(CAPTIVE_ROUND_DOWN_EXCEEDING(privbcb->base,sectorsize)
1375                                  ==CAPTIVE_ROUND_DOWN_EXCEEDING64(privbcb->MappedFileOffset.QuadPart,sectorsize));
1376         base_sectoraligned  =CAPTIVE_ROUND_DOWN(privbcb->base,sectorsize);
1377         length_sectoraligned=CAPTIVE_ROUND_UP(((char *)privbcb->base)+privbcb->MappedLength,sectorsize)
1378                         -((char *)base_sectoraligned);
1379         g_assert(0==CAPTIVE_ROUND_DOWN_EXCEEDING(length_sectoraligned,sectorsize));
1380         FileOffset_sectoraligned.QuadPart=CAPTIVE_ROUND_DOWN64(privbcb->MappedFileOffset.QuadPart,sectorsize);
1381
1382         Mdl=MmCreateMdl(NULL,base_sectoraligned,length_sectoraligned);
1383         g_assert(Mdl!=NULL);
1384         MmBuildMdlForNonPagedPool(Mdl);
1385
1386         KeInitializeEvent(&Event,NotificationEvent,FALSE);
1387
1388         /* Use rather IoSynchronousPageWrite() than IoPageWrite() to prevent STATUS_PENDING. */
1389         err=IoSynchronousPageWrite(privbcb->FileObject,Mdl,&FileOffset_sectoraligned,&Event,&IoStatus);
1390         g_assert(NT_SUCCESS(err));
1391         g_assert(NT_SUCCESS(IoStatus.Status));
1392         /* We should write at least the unaligned mapped data although we
1393          * do not need to successfuly write the whole aligned amount.
1394          * FIXME: Also we can get just value 0 if the write is considered 'not dirty'
1395          * during FAT write by fastfat.sys.
1396          */
1397         g_assert(IoStatus.Information==0 || IoStatus.Information>=CAPTIVE_ROUND_DOWN_EXCEEDING(privbcb->base,sectorsize)
1398                         +privbcb->MappedLength);
1399         g_assert(IoStatus.Information<=length_sectoraligned);
1400
1401         if (fileobject_cached)
1402                 (*fileobject_cached->CallBacks.ReleaseFromLazyWrite)(
1403                                 fileobject_cached->LazyWriterContext);  /* Context */
1404
1405         /* Restore TopLevelIrp for fileobject_cached->CallBacks.{AcquireForLazyWrite,ReleaseFromLazyWrite}
1406          */
1407         g_assert(NULL==IoGetTopLevelIrp());
1408         IoSetTopLevelIrp(saved_TopLevelIrp);
1409
1410         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: 'dirty' flush: FileObject=%p,MappedFileOffset=0x%llX,MappedLength=0x%lX,base=%p"
1411                         "; base_sectoraligned=%p,FileOffset_sectoraligned=0x%llX,length_sectoraligned=0x%lX; ->Information=0x%lX",G_STRLOC,
1412                         privbcb->FileObject,(guint64)privbcb->MappedFileOffset.QuadPart,(gulong)privbcb->MappedLength,privbcb->base,
1413                         base_sectoraligned,(guint64)FileOffset_sectoraligned.QuadPart,(gulong)length_sectoraligned,
1414                         (gulong)IoStatus.Information);
1415
1416         privbcb_set(privbcb,PRIVBCB_ITEM_DIRTY,FALSE);
1417 }
1418
1419 struct captive_privbcb_flush_ordered_param {
1420         struct private_bcb *privbcb_req;
1421         struct private_bcb *found;      /* return */
1422         };
1423
1424 static gboolean captive_privbcb_flush_ordered_foreach_get_first(struct private_bcb *key,struct private_bcb *value,
1425                 struct captive_privbcb_flush_ordered_param *captive_privbcb_flush_ordered_param /* data */)
1426 {
1427         g_return_val_if_fail(key!=NULL,TRUE);   /* meaning: stop the traversal */
1428         g_return_val_if_fail(value!=NULL,TRUE); /* meaning: stop the traversal */
1429         g_return_val_if_fail(key==value,TRUE);  /* meaning: stop the traversal */
1430         g_return_val_if_fail(validate_Bcb(key->PublicBcb),TRUE);        /* meaning: stop the traversal */
1431         g_return_val_if_fail(captive_privbcb_flush_ordered_param!=NULL,TRUE);   /* meaning: stop the traversal */
1432         g_return_val_if_fail(captive_privbcb_flush_ordered_param->found==NULL,TRUE);    /* meaning: stop the traversal */
1433
1434         g_assert(key->lsn_valid==TRUE);
1435
1436         if (key==captive_privbcb_flush_ordered_param->privbcb_req) {
1437                 captive_privbcb_flush_ordered_param->found=key;
1438                 return TRUE;    /* stop the traversal */
1439                 }
1440
1441         if (!key->dirty)
1442                 return FALSE;   /* continue the traversal */
1443
1444         captive_privbcb_flush_ordered_param->found=key; /* first dirty LSNed buffer */
1445         return TRUE;    /* stop the traversal */
1446 }
1447
1448 /* Use 'privbcb==NULL' to flush all LSNed entries of cache.
1449  * WARNING: Non-LSNed entries will NOT be flushed!
1450  */
1451 static void captive_privbcb_flush_ordered(struct private_bcb *privbcb_req)
1452 {
1453 struct private_bcb *privbcb;
1454 struct captive_privbcb_flush_ordered_param captive_privbcb_flush_ordered_param;
1455
1456         if ((privbcb=privbcb_req) && !privbcb->dirty)
1457                 return;
1458
1459         if ((privbcb=privbcb_req) && !privbcb->lsn_valid) {
1460                 captive_privbcb_flush_unordered(privbcb);
1461                 return;
1462                 }
1463
1464         private_bcb_lsn_tree_init();
1465
1466         for (;;) {
1467                 captive_privbcb_flush_ordered_param.privbcb_req=privbcb_req;
1468                 captive_privbcb_flush_ordered_param.found=NULL;
1469                 g_tree_foreach(private_bcb_lsn_tree,
1470                                 (GTraverseFunc)captive_privbcb_flush_ordered_foreach_get_first, /* func */
1471                                 &captive_privbcb_flush_ordered_param);  /* user_data */
1472                 if (captive_privbcb_flush_ordered_param.found==NULL) {
1473                         g_assert(privbcb_req==NULL);    /* Global LSN-ordered flush has no more entries. */
1474                         break;
1475                         }
1476                 privbcb=captive_privbcb_flush_ordered_param.found;
1477
1478                 g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,
1479                                 "%s: privbcb->FileObject=%p,privbcb->MappedFileOffset=0x%llX,privbcb->MappedLength=0x%lX,privbcb->ref_count=%d"
1480                                 ",privbcb->leave_func_pending=%d",G_STRLOC,
1481                                 privbcb->FileObject,(guint64)privbcb->MappedFileOffset.QuadPart,(gulong)privbcb->MappedLength,(int)privbcb->ref_count,
1482                                 (int)privbcb->leave_func_pending);
1483
1484                 if (privbcb->dirty) {
1485                         captive_privbcb_flush_unordered(privbcb);
1486                         continue;       /* Restart as anything could change by calling W32 hassle. */
1487                         }
1488
1489                 if (privbcb!=privbcb_req)
1490                         continue;       /* We just flushed a LSNed buffer not yet requested to be destroyed. */
1491
1492                 g_assert(privbcb==g_tree_lookup(private_bcb_lsn_tree,privbcb));
1493                 break;
1494                 }
1495
1496         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: return",G_STRLOC);
1497 }
1498
1499
1500 static void CcUnpinData_leave_func_finalize(struct private_bcb *privbcb)
1501 {
1502 gboolean errbool;
1503
1504         g_assert(privbcb->dirty==FALSE);
1505         g_assert(privbcb->lsn_valid==FALSE);
1506         g_assert(NULL==g_tree_lookup(private_bcb_lsn_tree,privbcb));
1507         g_assert(privbcb->leave_func_pending==TRUE);
1508         g_assert(privbcb->ref_count==1);
1509         privbcb_set(privbcb,PRIVBCB_ITEM_LEAVE_FUNC_PENDING,FALSE);
1510         privbcb_set(privbcb,PRIVBCB_ITEM_REF_COUNT_DESTRUCTOR,-1);
1511         errbool=g_hash_table_remove(private_bcb_hash,privbcb->PublicBcb);
1512         g_assert(errbool==TRUE);
1513 }
1514
1515 static void CcUnpinData_leave_func(struct private_bcb *privbcb) /* NULL to traverse the whole tree */
1516 {
1517         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: privbcb=%p,privbcb->ref_count=%d,privbcb->leave_func_pending=%d"
1518                         ",privbcb->lsn_valid=%d",G_STRLOC,
1519                         privbcb,(!privbcb ? -1 : privbcb->ref_count),(!privbcb ? -1 : privbcb->leave_func_pending),
1520                         (!privbcb ? -1 : privbcb->lsn_valid));
1521
1522         g_assert(privbcb->leave_func_pending==TRUE);
1523         g_assert(privbcb->ref_count==1);
1524         captive_privbcb_flush_ordered(privbcb);
1525         privbcb_set(privbcb,PRIVBCB_ITEM_LSN_VALID,FALSE);
1526         CcUnpinData_leave_func_finalize(privbcb);
1527         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: return",G_STRLOC);
1528 }
1529
1530 /**
1531  * CcUnpinData:
1532  * @Bcb: Initialized #PUBLIC_BCB structure.
1533  * %NULL value is forbidden.
1534  *
1535  * Dereferences @Bcb with the possible cleanup operations if you were the last owner.
1536  */
1537 VOID CcUnpinData(IN PVOID Bcb)
1538 {
1539 PUBLIC_BCB *PublicBcb;
1540 struct private_bcb *privbcb;
1541
1542         g_return_if_fail(validate_Bcb(Bcb));
1543
1544         private_bcb_hash_init();
1545
1546         PublicBcb=(PUBLIC_BCB *)Bcb;
1547         privbcb=g_hash_table_lookup(private_bcb_hash,PublicBcb);
1548         g_return_if_fail(privbcb!=NULL);
1549         g_assert(!privbcb->leave_func_pending);
1550
1551         g_assert(privbcb->FileObject->SectionObjectPointers!=NULL);
1552         /* It may not 'privbcb->FileObject->SectionObjectPointers->SharedCacheMap==PublicBcb'; see (NOTE*1) */
1553
1554         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,
1555                         "%s: privbcb->FileObject=%p,privbcb->MappedFileOffset=0x%llX,privbcb->MappedLength=0x%lX,privbcb->ref_count=%d"
1556                         ",privbcb->leave_func_pending=%d",G_STRLOC,
1557                         privbcb->FileObject,(guint64)privbcb->MappedFileOffset.QuadPart,(gulong)privbcb->MappedLength,(int)privbcb->ref_count,
1558                         (int)privbcb->leave_func_pending);
1559
1560         privbcb_set(privbcb,PRIVBCB_ITEM_REF_COUNT_DESTRUCTOR,-1);
1561         if (privbcb->ref_count>0)
1562                 return;
1563
1564         g_assert(privbcb->FileObject->SectionObjectPointers!=NULL);
1565         /* It may not 'privbcb->FileObject->SectionObjectPointers->SharedCacheMap==PublicBcb'; see (NOTE*1) */
1566         if (privbcb->FileObject->SectionObjectPointers->SharedCacheMap==PublicBcb)
1567                 privbcb->FileObject->SectionObjectPointers->SharedCacheMap=NULL;
1568
1569         /* Caboom: lfs (log file system) of ntfs.sys-NT5.1sp1 will do:
1570          * CcPinRead(); CcUnpinData(); access Buffer (wanna-crash);
1571          * Therefore we must postpone the buffer unmapping to some idle function...
1572          * I expect it a bug in ntfs.sys.
1573          */
1574         if (!privbcb->leave_func_pending) {
1575                 privbcb_set(privbcb,PRIVBCB_ITEM_REF_COUNT_DESTRUCTOR,+1);      /* '+1' gets decreased by 'leave_func_pending'. */
1576                 privbcb_set(privbcb,PRIVBCB_ITEM_LEAVE_FUNC_PENDING,TRUE);
1577                 captive_leave_register(
1578                                 (captive_leave_func)CcUnpinData_leave_func,     /* func */
1579                                 privbcb);       /* data; privbcb */
1580                 }
1581
1582         if (captive_cc_unmounting)
1583                 captive_leave();
1584 }
1585
1586
1587 VOID CcRepinBcb(IN PVOID Bcb)
1588 {
1589 PUBLIC_BCB *PublicBcb;
1590 struct private_bcb *privbcb;
1591
1592         g_return_if_fail(validate_Bcb(Bcb));
1593
1594         private_bcb_hash_init();
1595
1596         PublicBcb=(PUBLIC_BCB *)Bcb;
1597         privbcb=g_hash_table_lookup(private_bcb_hash,PublicBcb);
1598         g_return_if_fail(privbcb!=NULL);
1599
1600         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: Bcb=%p; privbcb->FileObject=%p",G_STRLOC,
1601                         Bcb,privbcb->FileObject);
1602
1603         privbcb_set(privbcb,PRIVBCB_ITEM_REF_COUNT,+1);
1604 }
1605
1606
1607 VOID CcUnpinRepinnedBcb(IN PVOID Bcb,IN BOOLEAN WriteThrough,IN PIO_STATUS_BLOCK IoStatus)
1608 {
1609 PUBLIC_BCB *PublicBcb;
1610 struct private_bcb *privbcb;
1611
1612         g_return_if_fail(validate_Bcb(Bcb));
1613         g_return_if_fail(IoStatus!=NULL);
1614
1615         private_bcb_hash_init();
1616
1617         PublicBcb=(PUBLIC_BCB *)Bcb;
1618         privbcb=g_hash_table_lookup(private_bcb_hash,PublicBcb);
1619         g_return_if_fail(privbcb!=NULL);
1620
1621         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: Bcb=%p,WriteThrough=%d,IoStatus=%p; privbcb->FileObject=%p",G_STRLOC,
1622                         Bcb,(gint)WriteThrough,IoStatus,privbcb->FileObject);
1623
1624         /* FIXME: Should we really flush the whole 'Bcb'?
1625          * Or maybe just some writes between CcRepinBcb(Bcb) and now? Who knows?
1626          */
1627         if (WriteThrough)
1628                 captive_privbcb_flush_ordered(privbcb);
1629
1630         IoStatus->Status=STATUS_SUCCESS;
1631         IoStatus->Information=privbcb->MappedLength;
1632
1633         CcUnpinData(Bcb);
1634 }
1635
1636
1637 VOID CcSetDirtyPinnedData(IN PVOID Bcb,IN PLARGE_INTEGER Lsn OPTIONAL)
1638 {
1639 PUBLIC_BCB *PublicBcb;
1640 struct private_bcb *privbcb;
1641
1642         g_return_if_fail(validate_Bcb(Bcb));
1643
1644         private_bcb_hash_init();
1645
1646         PublicBcb=(PUBLIC_BCB *)Bcb;
1647         privbcb=g_hash_table_lookup(private_bcb_hash,PublicBcb);
1648         g_return_if_fail(privbcb!=NULL);
1649
1650         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: Bcb=%p,Lsn=0x%llX; privbcb->FileObject=%p",G_STRLOC,
1651                         Bcb,(guint64)(!Lsn ? -1 : Lsn->QuadPart),privbcb->FileObject);
1652
1653         /* 'privbcb->ref_count' not to be increased by this function. */
1654
1655         if (Lsn) {
1656                 /* Unset it first to not to get into unreachable privbcb in 'private_bcb_lsn_tree'. */
1657                 privbcb_set(privbcb,PRIVBCB_ITEM_LSN_VALID,FALSE);
1658                 privbcb->lsn=*Lsn;
1659                 privbcb_set(privbcb,PRIVBCB_ITEM_LSN_VALID,TRUE);
1660                 }
1661         else {
1662                 /* FIXME: Unset 'lsn_valid' if !Lsn ? Undocumented by W32. */
1663                 g_assert(privbcb->lsn_valid==FALSE);    /* NOT IMPLEMENTED YET */
1664                 }
1665
1666         privbcb_set(privbcb,PRIVBCB_ITEM_DIRTY,TRUE);
1667 }
1668
1669
1670 struct CcSetFileSizes_param {
1671         PFILE_OBJECT FileObject;
1672         PCC_FILE_SIZES FileSizes;
1673         };
1674
1675 /* map: (PUBLIC_BCB *)PublicBcb -> (struct private_bcb *)privbcb */
1676 static void CcSetFileSizes_private_bcb_hash_foreach(
1677                 PUBLIC_BCB *PublicBcb,  /* key */
1678                 struct private_bcb *privbcb,    /* value */
1679                 struct CcSetFileSizes_param *CcSetFileSizes_param)      /* user_data */
1680 {
1681         g_return_if_fail(PublicBcb!=NULL);
1682         g_return_if_fail(privbcb!=NULL);
1683         g_return_if_fail(CcSetFileSizes_param!=NULL);
1684
1685         if (privbcb->FileObject!=CcSetFileSizes_param->FileObject)
1686                 return;
1687
1688         /* size changes behind our cached range? */
1689         if (1
1690                         && CcSetFileSizes_param->FileSizes->AllocationSize .QuadPart>=privbcb->MappedFileOffset.QuadPart+privbcb->MappedLength
1691                         && CcSetFileSizes_param->FileSizes->FileSize       .QuadPart>=privbcb->MappedFileOffset.QuadPart+privbcb->MappedLength
1692                         && CcSetFileSizes_param->FileSizes->ValidDataLength.QuadPart>=privbcb->MappedFileOffset.QuadPart+privbcb->MappedLength)
1693                 return;
1694
1695         /* FIXME: check BCB && 'struct page_position' invalidities */
1696         g_assert_not_reached(); /* NOT IMPLEMENTED YET */
1697 }
1698
1699 /**
1700  * CcSetFileSizes:
1701  * @FileObject: Initialized open #FileObject to update file sizes of.
1702  * %NULL value is forbidden.
1703  * @FileSizes: New file sizes to update cache to.
1704  * %NULL value is forbidden.
1705  *
1706  * Update cache properties after file sizes were updated.
1707  * Probably only the exceeding pages need to be unmapped and BCBs updated
1708  * if FileSizes->AllocationSize gets shrunk.
1709  *
1710  * FIXME: Currently a NOP with no effect by libcaptive.
1711  */
1712 VOID CcSetFileSizes(IN PFILE_OBJECT FileObject,IN PCC_FILE_SIZES FileSizes)
1713 {
1714 struct CcSetFileSizes_param CcSetFileSizes_param;
1715
1716         g_return_if_fail(FileObject!=NULL);
1717         g_return_if_fail(FileSizes!=NULL);
1718
1719         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: FileObject=%p,"
1720                         "FileSizes->AllocationSize=0x%llX,FileSizes->FileSize=0x%llX,FileSizes->ValidDataLength=0x%llX",G_STRLOC,
1721                         FileObject,(guint64)FileSizes->AllocationSize.QuadPart,(guint64)FileSizes->FileSize.QuadPart,
1722                         (guint64)FileSizes->ValidDataLength.QuadPart);
1723
1724         CcSetFileSizes_param.FileObject=FileObject;
1725         CcSetFileSizes_param.FileSizes=FileSizes;
1726         g_hash_table_foreach(
1727                         private_bcb_hash,       /* hash_table */
1728                         (GHFunc)CcSetFileSizes_private_bcb_hash_foreach,        /* func */
1729                         &CcSetFileSizes_param); /* user_data */
1730 }
1731
1732
1733 /**
1734  * CcPurgeCacheSection:
1735  * @SectionObjectPointer: Pointer specifying file to purge;
1736  * %NULL value is forbidden.
1737  * libcaptive interprets only #SharedCacheMap field as #PUBLIC_BCB pointer.
1738  * Field #SharedCacheMap value %NULL is permitted; libcaptive does a NOP with %TRUE return code in such case.
1739  * @FileOffset: Starting offset of the ranger to purge.
1740  * %NULL pointer is permitted and it means to purge the whole whole.
1741  * FIXME: Non %NULL pointer is NOT IMPLEMENTED YET by libcaptive.
1742  * @Length: Length of the range to purge. Ignored if @FileOffset==NULL.
1743  * @UninitializeCacheMaps: Purge also private cache maps (FIXME: ???).
1744  *
1745  * Drop any caching for shrunken file which is not being deleted.
1746  * libcaptive will no longer consider such #BCB as dirty.
1747  *
1748  * Undocumented: It is required during %FSCTL_LOCK_VOLUME by ntfs.sys of NT-5.1sp1
1749  * to return %TRUE value if #SharedCacheMap value is %NULL.
1750  *
1751  * Returns: %TRUE if the range was purged successfuly.
1752  */
1753 BOOLEAN CcPurgeCacheSection(IN PSECTION_OBJECT_POINTERS SectionObjectPointer,
1754                 IN PLARGE_INTEGER FileOffset OPTIONAL,IN ULONG Length,IN BOOLEAN UninitializeCacheMaps)
1755 {
1756 PUBLIC_BCB *PublicBcb;
1757 struct private_bcb *privbcb;
1758
1759         g_return_val_if_fail(SectionObjectPointer!=NULL,FALSE);
1760         if (SectionObjectPointer->SharedCacheMap==NULL)
1761                 return TRUE;    /* nothing to purge; never return FALSE for ntfs.sys of NT-5.1sp1! */
1762         g_return_val_if_fail(FileOffset==NULL,FALSE);   /* NOT IMPLEMENTED YET */
1763
1764         PublicBcb=SectionObjectPointer->SharedCacheMap;
1765         g_return_val_if_fail(validate_Bcb(PublicBcb),FALSE);
1766
1767         private_bcb_hash_init();
1768
1769         privbcb=g_hash_table_lookup(private_bcb_hash,PublicBcb);
1770         g_return_val_if_fail(privbcb!=NULL,FALSE);
1771
1772         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: SectionObjectPointer=%p(Bcb=%p,privbcb=%p,privbcb->FileObject=%p),"
1773                         "FileOffset=0x%llX,Length=0x%lX,UninitializeCacheMaps=%d",G_STRLOC,
1774                         SectionObjectPointer,PublicBcb,privbcb,privbcb->FileObject,
1775                         (guint64)(!FileOffset ? -1 : FileOffset->QuadPart),(gulong)Length,(gint)UninitializeCacheMaps);
1776
1777         g_assert_not_reached();
1778
1779         privbcb_set(privbcb,PRIVBCB_ITEM_DIRTY,FALSE);  /* purge it */
1780
1781         return TRUE;
1782 }
1783
1784
1785 /**
1786  * CcCopyRead:
1787  * @FileObject: Initialized open #FileObject to map.
1788  * %NULL value is forbidden.
1789  * @FileOffset: The @FileObject file offset from where to map the region from.
1790  * Negative value is forbidden.
1791  * @Length: Requested length of the region to map from @FileObject.
1792  * Value %0 is permitted (no effect of this function call).
1793  * @Wait: Whether disk waiting is permitted for this function.
1794  * Value %FALSE is currently forbidden by libcaptive as we have no on-demand loading implemented.
1795  * @Buffer: Address of memory region with already allocated memory of size @Length.
1796  * This address may not be %PAGE_SIZE aligned.
1797  * %NULL pointer is forbidden.
1798  * @IoStatus: #PIO_STATUS_BLOCK to return status of this operation.
1799  * %NULL pointer is forbidden.
1800  *
1801  * Reads the specified region of @FileObject to the given @Buffer.
1802  * No on-demand loading is in effect.
1803  *
1804  * Returns: %TRUE if the region was successfuly filled with @Length bytes.
1805  * @IoStatus.Status initialized by %STATUS_SUCCESS if successful.
1806  * @IoStatus.Information initialized by @Length if successful.
1807  */
1808 BOOLEAN CcCopyRead(IN PFILE_OBJECT FileObject,
1809                 IN PLARGE_INTEGER FileOffset,IN ULONG Length,IN BOOLEAN Wait,OUT PVOID Buffer,OUT PIO_STATUS_BLOCK IoStatus)
1810 {
1811 PVOID MappedBcb;
1812 PVOID MappedBuffer;
1813 gboolean errbool;
1814
1815         g_return_val_if_fail(FileObject!=NULL,FALSE);
1816         g_return_val_if_fail(FileOffset!=NULL,FALSE);
1817         g_return_val_if_fail(Wait==TRUE || Wait==FALSE,FALSE);  /* Prevent 'Wait' upgrade to 'Flags'. */
1818         g_return_val_if_fail(Buffer!=NULL,FALSE);
1819         g_return_val_if_fail(IoStatus!=NULL,FALSE);
1820
1821         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: FileObject=%p,FileOffset=0x%llX,Length=0x%lX,Wait=%d",G_STRLOC,
1822                         FileObject,(guint64)FileOffset->QuadPart,(gulong)Length,(gint)Wait);
1823
1824         IoStatus->Status=STATUS_UNSUCCESSFUL;
1825         IoStatus->Information=0;
1826
1827         if (Length) {
1828                 errbool=CcPinRead(
1829                                 FileObject,     /* FileObject */
1830                                 FileOffset,     /* FileOffset */
1831                                 Length, /* Length */
1832                                 0               /* Flags; !PIN_NO_READ */
1833                                                 | (Wait ? PIN_WAIT : 0),
1834                                 &MappedBcb,     /* Bcb */
1835                                 &MappedBuffer); /* Buffer */
1836                 g_return_val_if_fail(errbool==TRUE,FALSE);
1837
1838                 memcpy(Buffer,MappedBuffer,Length);
1839
1840                 CcUnpinData(MappedBcb); /* no error code */
1841                 }
1842
1843         IoStatus->Status=STATUS_SUCCESS;
1844         IoStatus->Information=Length;
1845
1846         return TRUE;
1847 }
1848
1849
1850 /**
1851  * CcCopyWrite:
1852  * @FileObject: Initialized open #FileObject to map.
1853  * %NULL value is forbidden.
1854  * @FileOffset: The @FileObject file offset from where to map the region from.
1855  * Negative value is forbidden.
1856  * @Length: Requested length of the region to map from @FileObject.
1857  * Value %0 is permitted (no effect of this function call).
1858  * @Wait: Whether disk waiting is permitted for this function.
1859  * Value %FALSE is currently forbidden by libcaptive as we have no on-demand loading implemented.
1860  * @Buffer: Address of memory region with already allocated memory of size @Length.
1861  * This address may not be %PAGE_SIZE aligned.
1862  * %NULL pointer is forbidden.
1863  *
1864  * Writes the specified region of the given @Buffer to @FileObject.
1865  *
1866  * Returns: %TRUE if the region was successfuly written with @Length bytes.
1867  */
1868 BOOLEAN CcCopyWrite(IN PFILE_OBJECT FileObject,
1869                 IN PLARGE_INTEGER FileOffset,IN ULONG Length,IN BOOLEAN Wait,IN PVOID Buffer)
1870 {
1871 PVOID MappedBcb;
1872 PVOID MappedBuffer;
1873 gboolean errbool;
1874
1875         g_return_val_if_fail(FileObject!=NULL,FALSE);
1876         g_return_val_if_fail(FileOffset!=NULL,FALSE);
1877         g_return_val_if_fail(Wait==TRUE || Wait==FALSE,FALSE);  /* Prevent 'Wait' upgrade to 'Flags'. */
1878         g_return_val_if_fail(Buffer!=NULL,FALSE);
1879
1880         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: FileObject=%p,FileOffset=0x%llX,Length=0x%lX,Wait=%d",G_STRLOC,
1881                         FileObject,(guint64)FileOffset->QuadPart,(gulong)Length,(gint)Wait);
1882
1883         if (Length) {
1884                 errbool=CcPinRead(
1885                                 FileObject,     /* FileObject */
1886                                 FileOffset,     /* FileOffset */
1887                                 Length, /* Length */
1888                                 PIN_NO_READ             /* Flags */
1889                                                 | (Wait ? PIN_WAIT : 0),
1890                                 &MappedBcb,     /* Bcb */
1891                                 &MappedBuffer); /* Buffer */
1892                 g_return_val_if_fail(errbool==TRUE,FALSE);
1893
1894                 memcpy(MappedBuffer,Buffer,Length);
1895
1896                 CcSetDirtyPinnedData(
1897                                 MappedBcb,      /* Bcb */
1898                                 NULL);  /* Lsn */
1899                 CcUnpinData(MappedBcb); /* no error code */
1900                 }
1901
1902         return TRUE;
1903 }
1904
1905
1906 /**
1907  * CcCanIWrite:
1908  * @FileObject: Initialized open #FileObject to map.
1909  * %NULL value is forbidden.
1910  * @BytesToWrite: Amount of data to be asked whether it will be accepted.
1911  * Value %0 is permitted.
1912  * @Wait: Whether disk waiting would be permitted during the forthcoming write call.
1913  * @Retrying: Use %TRUE iff calling this function for the second and further times for one request.
1914  *
1915  * Asks cache manager if it would currently accept write request to @FileObject
1916  * of @BytesToWrite bytes with @Wait condition.
1917  * libcaptive will always accept any writes. This function is a NOP.
1918  *
1919  * Returns: libcaptive always returns %TRUE.
1920  */
1921 BOOLEAN CcCanIWrite(IN PFILE_OBJECT FileObject,IN ULONG BytesToWrite,IN BOOLEAN Wait,IN BOOLEAN Retrying)
1922 {
1923         g_return_val_if_fail(FileObject!=NULL,FALSE);
1924         g_return_val_if_fail(Wait==TRUE || Wait==FALSE,FALSE);  /* Prevent 'Wait' upgrade to 'Flags'. */
1925         g_return_val_if_fail(Retrying==TRUE || Retrying==FALSE,FALSE);
1926
1927         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: FileObject=%p,BytesToWrite=0x%lX,Wait=%d,Retrying=%d",G_STRLOC,
1928                         FileObject,(gulong)BytesToWrite,(gint)Wait,(gint)Retrying);
1929
1930         return TRUE;
1931 }
1932
1933
1934 /**
1935  * CcSetReadAheadGranularity:
1936  * @FileObject: Initialized open #FileObject to map.
1937  * %NULL value is forbidden.
1938  * @Granularity: Suggested size of the cache element.
1939  * Value must be larger or requal to %PAGE_SIZE and it must be even power of two.
1940  *
1941  * libcaptive does not implement any caching and therefore this function
1942  * is a NOP there.
1943  */
1944 VOID CcSetReadAheadGranularity(IN PFILE_OBJECT FileObject,IN ULONG Granularity)
1945 {
1946         g_return_if_fail(FileObject!=NULL);
1947         g_return_if_fail(Granularity>=PAGE_SIZE);
1948         g_return_if_fail((Granularity&(Granularity-1))==0);     /* Power of two */
1949
1950         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: FileObject=%p,Granularity=0x%lX",G_STRLOC,
1951                         FileObject,(gulong)Granularity);
1952
1953         /* NOP; no caching by libcaptive */
1954 }
1955
1956
1957 /**
1958  * CcFlushCache:
1959  * @SectionObjectPointer: Pointer specifying file to flush;
1960  * %NULL value is forbidden.
1961  * libcaptive interprets only #SharedCacheMap field as #PUBLIC_BCB pointer.
1962  * Field #SharedCacheMap value %NULL is permitted; libcaptive does a NOP in such case.
1963  * @FileOffset: Optional starting point of the range to flush.
1964  * %NULL value is permitted.
1965  * @Length: Length of the range to flush. Ignored if @FileOffset is %NULL.
1966  * @IoStatus: Optionally returns the resulting operation status.
1967  * #Information field will contain the number of bytes flushed.
1968  * %NULL value is permitted.
1969  *
1970  * Flushes out any pending dirty data in cache manager BCB mapping.
1971  * FIXME: libcaptive currently always flushes the full file ignoring any @FileOffset or @Length.
1972  */
1973 VOID CcFlushCache(IN PSECTION_OBJECT_POINTERS SectionObjectPointer,
1974                 IN PLARGE_INTEGER FileOffset OPTIONAL,IN ULONG Length,OUT PIO_STATUS_BLOCK IoStatus OPTIONAL)
1975 {
1976 PUBLIC_BCB *PublicBcb;
1977 struct private_bcb *privbcb;
1978 IO_STATUS_BLOCK IoStatus_CcUnpinRepinnedBcb_local;
1979
1980         g_return_if_fail(SectionObjectPointer!=NULL);
1981
1982         if (SectionObjectPointer->SharedCacheMap==NULL) {
1983 success:
1984                 if (IoStatus) {
1985                         IoStatus->Status=STATUS_SUCCESS;
1986                         IoStatus->Information=0;
1987                         }
1988                 return;
1989                 }
1990
1991         PublicBcb=SectionObjectPointer->SharedCacheMap;
1992         g_return_if_fail(validate_Bcb(PublicBcb));
1993
1994         private_bcb_hash_init();
1995
1996         privbcb=g_hash_table_lookup(private_bcb_hash,PublicBcb);
1997         g_return_if_fail(privbcb!=NULL);
1998
1999         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: SectionObjectPointer=%p(Bcb=%p,privbcb=%p,privbcb->FileObject=%p),"
2000                         "FileOffset=0x%llX,Length=0x%lX,IoStatus=%p",G_STRLOC,
2001                         SectionObjectPointer,PublicBcb,privbcb,privbcb->FileObject,
2002                         (guint64)(!FileOffset ? -1 : FileOffset->QuadPart),(gulong)Length,IoStatus);
2003
2004         if (FileOffset) {
2005                 if (FileOffset->QuadPart       >=privbcb->MappedFileOffset.QuadPart+privbcb->MappedLength)
2006                         goto success;
2007                 if (FileOffset->QuadPart+Length<=privbcb->MappedFileOffset.QuadPart)
2008                         goto success;
2009                 }
2010
2011         /* We may find some 'privbcb' being already sheduled to be destroyed.
2012          * We need to reference it to not to loose it in the middle of our flush operation.
2013          */
2014         CcRepinBcb(PublicBcb);
2015
2016         /* FIXME: Flush just FileOffset..FileOfset+Length part */
2017         captive_privbcb_flush_ordered(privbcb);
2018
2019         CcUnpinRepinnedBcb(
2020                         PublicBcb,      /* Bcb */
2021                         TRUE,   /* WriteThrough; ignored by libcaptive */
2022                         &IoStatus_CcUnpinRepinnedBcb_local);    /* IoStatus; ignored here */
2023
2024         if (IoStatus) {
2025                 IoStatus->Status=STATUS_SUCCESS;
2026                 IoStatus->Information=(FileOffset && Length ? MIN(privbcb->MappedLength,Length) : privbcb->MappedLength);
2027                 }
2028 }
2029
2030
2031 BOOLEAN CcZeroData(IN PFILE_OBJECT FileObject,IN PLARGE_INTEGER StartOffset,IN PLARGE_INTEGER EndOffset,IN BOOLEAN Wait)
2032 {
2033 SECTION_OBJECT_POINTERS *SectionObjectPointers_orig;
2034 PVOID Bcb;
2035 PVOID Buffer;
2036 BOOLEAN errboolean;
2037
2038         g_return_val_if_fail(FileObject!=NULL,FALSE);
2039         g_return_val_if_fail(StartOffset!=NULL,FALSE);
2040         g_return_val_if_fail(EndOffset!=NULL,FALSE);
2041         g_return_val_if_fail(StartOffset->QuadPart<=EndOffset->QuadPart,FALSE);
2042         g_return_val_if_fail((EndOffset->QuadPart-StartOffset->QuadPart)
2043                     ==(ULONG)(EndOffset->QuadPart-StartOffset->QuadPart),FALSE);
2044         g_return_val_if_fail(Wait==TRUE || Wait==FALSE,FALSE);  /* Prevent 'Wait' upgrade to 'Flags'. */
2045
2046         SectionObjectPointers_orig=FileObject->SectionObjectPointers;
2047
2048         errboolean=CcPreparePinWrite(
2049                         FileObject,     /* FileObject */
2050                         StartOffset,    /* FileOffset */
2051                         EndOffset->QuadPart-StartOffset->QuadPart,      /* Length */
2052                         TRUE,   /* Zero */
2053                         PIN_WAIT|PIN_NO_READ,   /* Flags */
2054                         &Bcb,   /* Bcb */
2055                         &Buffer);       /* Buffer */
2056         g_assert(errboolean==TRUE);
2057
2058         CcUnpinData(Bcb);
2059
2060         FileObject->SectionObjectPointers=SectionObjectPointers_orig;
2061
2062         return TRUE;
2063 }
2064
2065
2066 /* map (PVOID LogHandle) -> (GList (of FILE_OBJECT *) *FileObject_list) */
2067 static GHashTable *log_handle_hash;
2068
2069 static void log_handle_hash_init(void)
2070 {
2071         if (log_handle_hash)
2072                 return;
2073         log_handle_hash=g_hash_table_new(
2074                         g_direct_hash,  /* hash_func */
2075                         g_direct_equal);        /* key_equal_func */
2076 }
2077
2078 /* map (FILE_OBJECT *FileObject) -> (struct FileObject_logging *) */
2079 struct FileObject_logging {
2080         PVOID LogHandle;
2081         PFLUSH_TO_LSN FlushToLsnRoutine;
2082         };
2083
2084 static GHashTable *FileObject_logging_hash;
2085
2086 static void FileObject_logging_hash_init(void)
2087 {
2088         if (FileObject_logging_hash)
2089                 return;
2090         FileObject_logging_hash=g_hash_table_new(
2091                         g_direct_hash,  /* hash_func */
2092                         g_direct_equal);        /* key_equal_func */
2093 }
2094
2095 static void logging_notify_privbcb_flush(struct private_bcb *privbcb)
2096 {
2097 struct FileObject_logging *FileObject_logging;
2098
2099         g_return_if_fail(privbcb!=NULL);
2100
2101         if (!privbcb->lsn_valid)        /* nothing to report anyway */
2102                 return;
2103
2104         FileObject_logging_hash_init();
2105
2106         if (!(FileObject_logging=g_hash_table_lookup(FileObject_logging_hash,privbcb->FileObject)))
2107                 return;
2108
2109         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: privbcb=%p,privbcb->FileObject=%p,privbcb->lsn=0x%llX: call",G_STRLOC,
2110                         privbcb,privbcb->FileObject,(guint64)privbcb->lsn.QuadPart);
2111
2112         (*FileObject_logging->FlushToLsnRoutine)(FileObject_logging->LogHandle,privbcb->lsn);
2113
2114         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: privbcb=%p,privbcb->FileObject=%p,privbcb->lsn=0x%llX: finish",G_STRLOC,
2115                         privbcb,privbcb->FileObject,(guint64)privbcb->lsn.QuadPart);
2116 }
2117
2118 VOID CcSetLogHandleForFile(IN PFILE_OBJECT FileObject,IN PVOID LogHandle,IN PFLUSH_TO_LSN FlushToLsnRoutine)
2119 {
2120 GList *LogHandle_list;
2121 struct FileObject_logging *FileObject_logging;
2122
2123         g_return_if_fail(FileObject!=NULL);
2124         /* 'LogHandle' may be NULL */
2125         g_return_if_fail(FlushToLsnRoutine!=NULL);
2126
2127         log_handle_hash_init();
2128         FileObject_logging_hash_init();
2129
2130         if (!(FileObject_logging=g_hash_table_lookup(
2131                         FileObject_logging_hash,FileObject))) {
2132                 captive_new(FileObject_logging);
2133                 g_hash_table_insert(FileObject_logging_hash,
2134                                 FileObject,FileObject_logging);
2135                 }
2136         else {
2137                 LogHandle_list=g_hash_table_lookup(log_handle_hash,FileObject_logging->LogHandle);
2138                 g_assert(NULL!=g_list_find(LogHandle_list,FileObject));
2139                 LogHandle_list=g_list_remove(LogHandle_list,FileObject);
2140                 g_assert(NULL==g_list_find(LogHandle_list,FileObject));
2141                 g_hash_table_insert(log_handle_hash,FileObject_logging->LogHandle,LogHandle_list);
2142                 }
2143
2144         FileObject_logging->LogHandle=LogHandle;
2145         FileObject_logging->FlushToLsnRoutine=FlushToLsnRoutine;
2146
2147         LogHandle_list=g_hash_table_lookup(log_handle_hash,LogHandle);
2148         LogHandle_list=g_list_prepend(LogHandle_list,FileObject);
2149         g_hash_table_insert(log_handle_hash,LogHandle,LogHandle_list);
2150 }
2151
2152
2153 struct CcGetDirtyPages_param {
2154         PDIRTY_PAGE_ROUTINE DirtyPageRoutine;   /* arg of CcGetDirtyPages() */
2155         IN PVOID Context1;      /* arg of CcGetDirtyPages() */
2156         IN PVOID Context2;      /* arg of CcGetDirtyPages() */
2157         FILE_OBJECT *FileObject;        /* search through 'page_position_hash' for 'FileObject' */
2158         LARGE_INTEGER OldestLsn; gboolean OldestLsn_found;      /* intermediate return value of CcGetDirtyPages() */
2159         };
2160
2161 static void CcGetDirtyPages_page_position_hash_foreach(
2162                 struct page_position *pagepos,  /* key */
2163                 struct page_position *pagepos2, /* value */
2164                 struct CcGetDirtyPages_param *CcGetDirtyPages_param)    /* user_data */
2165 {
2166 LARGE_INTEGER FileOffset_local;
2167 LARGE_INTEGER OldestLsn,NewestLsn;
2168 LARGE_INTEGER OldestLsn_check,NewestLsn_check;
2169 gboolean lsn_found=FALSE;
2170 GList *privbcb_list;
2171
2172         g_return_if_fail(pagepos!=NULL);
2173         g_return_if_fail(pagepos==pagepos2);
2174         g_return_if_fail(CcGetDirtyPages_param!=NULL);
2175
2176         FileOffset_local=pagepos->FileOffset;
2177
2178         for (
2179                         privbcb_list=pagepos->privbcb_list;
2180                         privbcb_list;
2181                         privbcb_list=privbcb_list->next) {
2182 struct private_bcb *privbcb=privbcb_list->data;
2183
2184                 if (!privbcb->lsn_valid)
2185                         return;
2186                 if (!lsn_found) {
2187                         OldestLsn=NewestLsn=privbcb->lsn;
2188                         continue;
2189                         }
2190                 OldestLsn.QuadPart=MIN(OldestLsn.QuadPart,privbcb->lsn.QuadPart);
2191                 NewestLsn.QuadPart=MAX(NewestLsn.QuadPart,privbcb->lsn.QuadPart);
2192                 }
2193
2194         if (!lsn_found)
2195                 return;
2196
2197         if (!CcGetDirtyPages_param->OldestLsn_found) {
2198                 CcGetDirtyPages_param->OldestLsn=OldestLsn;
2199                 CcGetDirtyPages_param->OldestLsn_found=TRUE;
2200                 }
2201         else
2202                 CcGetDirtyPages_param->OldestLsn.QuadPart=MIN(CcGetDirtyPages_param->OldestLsn.QuadPart,OldestLsn.QuadPart);
2203
2204         OldestLsn_check=OldestLsn;
2205         NewestLsn_check=NewestLsn;
2206
2207         (*CcGetDirtyPages_param->DirtyPageRoutine)(
2208                         pagepos->FileObject,    /* FileObject */
2209                         &FileOffset_local,      /* FileOffset */
2210                         PAGE_SIZE,      /* Length */
2211                         &OldestLsn,     /* OldestLsn */
2212                         &NewestLsn,     /* NewestLsn */
2213                         CcGetDirtyPages_param->Context1,        /* Context1 */
2214                         CcGetDirtyPages_param->Context2);       /* Context2 */
2215
2216         /* just unconfirmed sanity: */
2217         g_assert(FileOffset_local.QuadPart==pagepos->FileOffset.QuadPart);      /* check for possible corruption */
2218         g_assert(OldestLsn_check.QuadPart==OldestLsn.QuadPart);
2219         g_assert(NewestLsn_check.QuadPart==NewestLsn.QuadPart);
2220 }
2221
2222 /* libcaptive must return #gint64 instead of the official #LARGE_INTEGER
2223  * as W32 expects it as value in EAX:EDX but GCC returns the structure address in EAX.
2224  */
2225 gint64 /* instead of LARGE_INTEGER */ CcGetDirtyPages(IN PVOID LogHandle,
2226                 IN PDIRTY_PAGE_ROUTINE DirtyPageRoutine,IN PVOID Context1,IN PVOID Context2)
2227 {
2228 GList *LogHandle_list;
2229 struct CcGetDirtyPages_param CcGetDirtyPages_param;
2230
2231         /* 'LogHandle' may be NULL */
2232         g_return_val_if_fail(DirtyPageRoutine!=NULL,0);
2233
2234         log_handle_hash_init();
2235         page_position_hash_init();
2236
2237         CcGetDirtyPages_param.DirtyPageRoutine=DirtyPageRoutine;
2238         CcGetDirtyPages_param.Context1=Context1;
2239         CcGetDirtyPages_param.Context2=Context2;
2240         CcGetDirtyPages_param.OldestLsn_found=FALSE;
2241
2242         for (
2243                         LogHandle_list=g_hash_table_lookup(log_handle_hash,LogHandle);
2244                         LogHandle_list;
2245                         LogHandle_list=LogHandle_list->next) {
2246                 CcGetDirtyPages_param.FileObject=LogHandle_list->data;
2247                 g_hash_table_foreach(
2248                                 page_position_hash,     /* hash_table */
2249                                 (GHFunc)CcGetDirtyPages_page_position_hash_foreach,     /* func */
2250                                 &CcGetDirtyPages_param);        /* user_data */
2251                 }
2252
2253         if (!CcGetDirtyPages_param.OldestLsn_found)
2254                 return 0;
2255         return CcGetDirtyPages_param.OldestLsn.QuadPart;
2256 }
2257
2258
2259 /**
2260  * CcSetAdditionalCacheAttributes:
2261  * @FileObject: Initialized open #FileObject to map.
2262  * %NULL value is forbidden.
2263  * @DisableReadAhead: Read-ahead should not be done by Cache Manager.
2264  * @DisableWriteBehind: Write-behind should not be done by Cache Manager.
2265  *
2266  * libcaptive does not implement any caching and therefore this function
2267  * is a NOP there.
2268  */
2269 VOID CcSetAdditionalCacheAttributes(IN PFILE_OBJECT FileObject,IN BOOLEAN DisableReadAhead,IN BOOLEAN DisableWriteBehind)
2270 {
2271         g_return_if_fail(FileObject!=NULL);
2272
2273         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,"%s: FileObject=%p,DisableReadAhead=%s,DisableWriteBehind=%s",G_STRLOC,
2274                         FileObject,(DisableReadAhead ? "TRUE" : "FALSE"),(DisableWriteBehind ? "TRUE" : "FALSE"));
2275
2276         /* NOP; no caching by libcaptive */
2277 }
2278
2279
2280 /**
2281  * CcSetBcbOwnerPointer:
2282  * @Bcb: Initialized #PUBLIC_BCB structure.
2283  * %NULL value is forbidden.
2284  * @Owner: Thread-specific pointer (FIXME: Is it KeGetCurrentThread()?).
2285  * %NULL value is forbidden (FIXME: Is it W32 compliant?).
2286  *
2287  * Set thread-specific pointer for a pinned @Bcb. Use CcUnpinDataForThread()
2288  * when @Bcb is no longer needed. CcUnpinDataForThread() is NOT a reverse
2289  * operation for this single call CcSetBcbOwnerPointer(), see CcUnpinDataForThread().
2290  *
2291  * libcaptive implements this function as no-operation as it does not yet
2292  * support any threading.
2293  */
2294 VOID CcSetBcbOwnerPointer(IN PVOID Bcb,IN PVOID Owner)
2295 {
2296         g_return_if_fail(Bcb!=NULL);
2297         g_return_if_fail(Owner!=NULL);
2298
2299         /* FIXME:thread; NOP if no threads present */
2300 }
2301
2302
2303 /**
2304  * CcUnpinDataForThread:
2305  * @Bcb: Initialized #PUBLIC_BCB structure.
2306  * %NULL value is forbidden.
2307  * @ResourceThreadId: Thread-specific pointer (FIXME: Is it KeGetCurrentThread()?).
2308  * This pointer had to be passed to CcSetBcbOwnerPointer() #Owner parameter previously.
2309  * %NULL value is forbidden (FIXME: is it W32 compliant?).
2310  *
2311  * CcUnpinData() for a thread specified by @ResourceThreadId.
2312  * Reverse operation for a pair of CcMapData() and CcSetBcbOwnerPointer().
2313  *
2314  * libcaptive implements this function as a simple pass to CcUnpinData() as it does not yet
2315  * support any threading.
2316  */
2317 VOID CcUnpinDataForThread(IN PVOID Bcb,IN ERESOURCE_THREAD ResourceThreadId)
2318 {
2319         g_return_if_fail(Bcb!=NULL);
2320         g_return_if_fail(ResourceThreadId!=0);
2321
2322         /* FIXME:thread */
2323
2324         CcUnpinData(Bcb);
2325 }
2326
2327
2328 /**
2329  * CcRemapBcb:
2330  * @Bcb: Initialized #PUBLIC_BCB structure.
2331  * %NULL value is forbidden.
2332  *
2333  * Create a copy of @Bcb for the exactly same file contents as is @Bcb.
2334  * The returned copy has the same attributes as the result of CcMapData()
2335  * notwithstanding the current state of input @Bcb, therefore it is only
2336  * for read/only access etc.
2337  *
2338  * libcaptive calls CcMapData() internally with @Bcb parameters.
2339  *
2340  * Returns: Copy of @Bcb. This _pointer_ never equals to @Bcb.
2341  * It should be some different
2342  * #PUBLIC_BCB structure according to W32 doc.
2343  */
2344 PVOID CcRemapBcb(IN PVOID Bcb)
2345 {
2346 PVOID r;
2347 PVOID Buffer_unused;
2348 BOOLEAN errbool;
2349 PUBLIC_BCB *PublicBcb;
2350 struct private_bcb *privbcb;
2351
2352         g_return_val_if_fail(validate_Bcb(Bcb),NULL);
2353
2354         private_bcb_hash_init();
2355
2356         PublicBcb=(PUBLIC_BCB *)Bcb;
2357         privbcb=g_hash_table_lookup(private_bcb_hash,PublicBcb);
2358         g_return_val_if_fail(privbcb!=NULL,NULL);
2359
2360         g_log(G_LOG_DOMAIN,G_LOG_LEVEL_DEBUG,
2361                         "%s: privbcb->FileObject=%p,privbcb->MappedFileOffset=0x%llX,privbcb->MappedLength=0x%lX,privbcb->ref_count=%d",G_STRLOC,
2362                         privbcb->FileObject,(guint64)privbcb->MappedFileOffset.QuadPart,(gulong)privbcb->MappedLength,(int)privbcb->ref_count);
2363
2364         errbool=CcMapData(
2365                         privbcb->FileObject,    /* FileObject */
2366                         &privbcb->MappedFileOffset,     /* FileOffset */
2367                         privbcb->MappedLength,  /* Length */
2368                         MAP_WAIT,       /* Flags; && !MAP_NO_READ */
2369                         &r,     /* Bcb */
2370                         &Buffer_unused); /* Buffer */
2371         g_return_val_if_fail(errbool==TRUE,NULL);
2372         g_return_val_if_fail(r!=NULL,NULL);
2373         g_return_val_if_fail(Buffer_unused!=NULL,NULL);
2374
2375         g_assert(r!=Bcb);
2376         return r;
2377 }
2378
2379
2380 /**
2381  * CcPreparePinWrite:
2382  * @FileObject: Initialized open #FileObject to map.
2383  * %NULL value is forbidden.
2384  * @FileOffset: The @FileObject file offset from where to map the region from.
2385  * Negative value is forbidden.
2386  * @Length: Requested length of the region to map from @FileObject.
2387  * FIXME: Value %0 is currently forbidden by libcaptive; it should be allowed.
2388  * @Zero: %TRUE if the area of @FileOffset...@FileOffset+@Length should be cleared.
2389  * @Flags: %PIN_WAIT means whether disk waiting is permitted for this function.
2390  * Value without %PIN_WAIT is currently permtted by libcaptive as the data must have been mapped by CcMapData() already anyway.
2391  * %PIN_NO_READ is the same as %MAP_NO_READ - see CcMapData().
2392  * FIXME: %PIN_EXCLUSIVE for exclusive @Bcb access is now ignored by libcaptive.
2393  * %PIN_IF_BCB if @Bcb should never be created; function is successful only if @Bcb already exists.
2394  * @Bcb: Returns initialized #PUBLIC_BCB to refer to the mapped region.
2395  * The memory region can be larger than requested as it is %PAGE_SIZE aligned.
2396  * %NULL pointer is forbidden.
2397  * @Buffer: Returns the mapped memory region start address.
2398  * This address may not be %PAGE_SIZE aligned.
2399  * %NULL pointer is forbidden.
2400  *
2401  * Wrapper for a pair of CcPinRead() and CcSetDirtyPinnedData().
2402  * The mapped range can be also optionally cleared if @Zero is specified.
2403  * See CcPinRead() for a more detailed documentation.
2404  *
2405  * FIXME: libcaptive will read even the file pages completely not need
2406  * in the case @Zero was specified.
2407  *
2408  * Returns: %TRUE if the mapping was successful.
2409  */
2410 BOOLEAN CcPreparePinWrite(IN PFILE_OBJECT FileObject,
2411                 IN PLARGE_INTEGER FileOffset,IN ULONG Length,IN BOOLEAN Zero,IN ULONG Flags,OUT PVOID *Bcb,OUT PVOID *Buffer)
2412 {
2413 BOOLEAN errbool;
2414
2415         g_return_val_if_fail(FileObject!=NULL,FALSE);
2416         g_return_val_if_fail(FileOffset!=NULL,FALSE);
2417         g_return_val_if_fail(FileOffset->QuadPart>=0,FALSE);
2418         g_return_val_if_fail(Length>0,FALSE);   /* FIXME: not handled below; 0 should be allowed */
2419         /* 'Flags' passed to CcPinRead() */
2420         g_return_val_if_fail(Bcb!=NULL,FALSE);
2421         g_return_val_if_fail(Buffer!=NULL,FALSE);
2422
2423         errbool=CcPinRead(FileObject,FileOffset,Length,Flags|(Zero ? PIN_NO_READ : 0),Bcb,Buffer);
2424         g_return_val_if_fail(errbool==TRUE,FALSE);
2425
2426         CcSetDirtyPinnedData(
2427                         *Bcb,   /* Bcb */
2428                         NULL);  /* Lsn; OPTIONAL */
2429
2430         if (Zero) {
2431                 memset(*Buffer,0,Length);
2432                 }
2433
2434         return TRUE;
2435 }
2436
2437
2438 VOID FsRtlIncrementCcFastReadNoWait(VOID)
2439 {
2440         /* FIXME: {{%fs:[0]}+0x4E0}:LONG++ */
2441 }
2442
2443
2444 NTSTATUS CcWaitForCurrentLazyWriterActivity(VOID)
2445 {
2446         return STATUS_SUCCESS;
2447 }