Due to CcRos's abusive usage and dependency on our broken Fast Mutex implementation...

[reactos.git] / reactos / ntoskrnl / include / internal / cc.h

diff --git a/reactos/ntoskrnl/include/internal/cc.h b/reactos/ntoskrnl/include/internal/cc.h
index 8c23f28..4f42b8b 100644 (file)
--- a/reactos/ntoskrnl/include/internal/cc.h
+++ b/reactos/ntoskrnl/include/internal/cc.h
@@ -1,40 +1,216 @@
 #ifndef __INCLUDE_INTERNAL_CC_H
 #define __INCLUDE_INTERNAL_CC_H
-/* $Id: cc.h,v 1.5 2001/05/04 01:21:44 rex Exp $ */
-#include <ddk/ntifs.h>
+
+VOID 
+FASTCALL
+CcAcquireBrokenMutex(PFAST_MUTEX FastMutex);
+
+VOID
+FASTCALL
+CcReleaseBrokenMutex(PFAST_MUTEX FastMutex);
+
+BOOLEAN
+FASTCALL
+CcTryToAcquireBrokenMutex(PFAST_MUTEX FastMutex);
 
 typedef struct _BCB
 {
-  LIST_ENTRY CacheSegmentListHead;
-  PFILE_OBJECT FileObject;
-  KSPIN_LOCK BcbLock;
-  ULONG CacheSegmentSize;
-} BCB;
+    LIST_ENTRY BcbSegmentListHead;
+    LIST_ENTRY BcbRemoveListEntry;
+    BOOLEAN RemoveOnClose;
+    ULONG TimeStamp;
+    PFILE_OBJECT FileObject;
+    ULONG CacheSegmentSize;
+    LARGE_INTEGER AllocationSize;
+    LARGE_INTEGER FileSize;
+    KSPIN_LOCK BcbLock;
+    ULONG RefCount;
+#if defined(DBG) || defined(KDBG)
+       BOOLEAN Trace; /* enable extra trace output for this BCB and it's cache segments */
+#endif
+} BCB, *PBCB;
 
 typedef struct _CACHE_SEGMENT
 {
-  PVOID BaseAddress;
-  struct _MEMORY_AREA* MemoryArea;
-  BOOLEAN Valid;
-  LIST_ENTRY BcbListEntry;
-  LIST_ENTRY DirtySegmentListEntry;
-  ULONG FileOffset;
-  KEVENT Lock;
-  ULONG ReferenceCount;
-  PBCB Bcb;
-} CACHE_SEGMENT;
-
-VOID STDCALL
-CcMdlReadCompleteDev (IN       PMDL            MdlChain,
-                     IN        PDEVICE_OBJECT  DeviceObject);
-NTSTATUS
-CcRosGetCacheSegment(PBCB Bcb,
-                 ULONG FileOffset,
-                 PULONG BaseOffset,
-                 PVOID* BaseAddress,
-                 PBOOLEAN UptoDate,
-                 PCACHE_SEGMENT* CacheSeg);
+    /* Base address of the region where the cache segment data is mapped. */
+    PVOID BaseAddress;
+    /*
+     * Memory area representing the region where the cache segment data is
+     * mapped.
+     */
+    struct _MEMORY_AREA* MemoryArea;
+    /* Are the contents of the cache segment data valid. */
+    BOOLEAN Valid;
+    /* Are the contents of the cache segment data newer than those on disk. */
+    BOOLEAN Dirty;
+    /* Page out in progress */
+    BOOLEAN PageOut;
+    ULONG MappedCount;
+    /* Entry in the list of segments for this BCB. */
+    LIST_ENTRY BcbSegmentListEntry;
+    /* Entry in the list of segments which are dirty. */
+    LIST_ENTRY DirtySegmentListEntry;
+    /* Entry in the list of segments. */
+    LIST_ENTRY CacheSegmentListEntry;
+    LIST_ENTRY CacheSegmentLRUListEntry;
+    /* Offset in the file which this cache segment maps. */
+    ULONG FileOffset;
+    /* Lock. */
+    FAST_MUTEX Lock;
+    /* Number of references. */
+    ULONG ReferenceCount;
+    /* Pointer to the BCB for the file which this cache segment maps data for. */
+    PBCB Bcb;
+    /* Pointer to the next cache segment in a chain. */
+    struct _CACHE_SEGMENT* NextInChain;
+} CACHE_SEGMENT, *PCACHE_SEGMENT;
+
+typedef struct _INTERNAL_BCB
+{
+    PUBLIC_BCB PFCB;
+    PCACHE_SEGMENT CacheSegment;
+    BOOLEAN Dirty;
+    CSHORT RefCount; /* (At offset 0x34 on WinNT4) */
+} INTERNAL_BCB, *PINTERNAL_BCB;
+
+VOID
+STDCALL
+CcMdlReadCompleteDev(
+    IN PMDL MdlChain,
+    IN PFILE_OBJECT FileObject
+);
+
+VOID
+STDCALL
+CcMdlWriteCompleteDev(
+    IN PLARGE_INTEGER FileOffset,
+    IN PMDL MdlChain,
+    IN PFILE_OBJECT FileObject
+);
+
+NTSTATUS
+NTAPI
+CcRosFlushCacheSegment(PCACHE_SEGMENT CacheSegment);
+
+NTSTATUS
+NTAPI
+CcRosGetCacheSegment(
+    PBCB Bcb,
+    ULONG FileOffset,
+    PULONG BaseOffset,
+    PVOID *BaseAddress,
+    PBOOLEAN UptoDate,
+    PCACHE_SEGMENT *CacheSeg
+);
+
 VOID
+NTAPI
 CcInitView(VOID);
 
+NTSTATUS
+NTAPI
+CcRosFreeCacheSegment(
+    PBCB,
+    PCACHE_SEGMENT
+);
+
+NTSTATUS
+NTAPI
+ReadCacheSegment(PCACHE_SEGMENT CacheSeg);
+
+NTSTATUS
+NTAPI
+WriteCacheSegment(PCACHE_SEGMENT CacheSeg);
+
+VOID
+NTAPI
+CcInit(VOID);
+
+NTSTATUS
+NTAPI
+CcRosUnmapCacheSegment(
+    PBCB Bcb,
+    ULONG FileOffset,
+    BOOLEAN NowDirty
+);
+
+PCACHE_SEGMENT
+NTAPI
+CcRosLookupCacheSegment(
+    PBCB Bcb,
+    ULONG FileOffset
+);
+
+NTSTATUS
+NTAPI
+CcRosGetCacheSegmentChain(
+    PBCB Bcb,
+    ULONG FileOffset,
+    ULONG Length,
+    PCACHE_SEGMENT* CacheSeg
+);
+
+VOID
+NTAPI
+CcInitCacheZeroPage(VOID);
+
+NTSTATUS
+NTAPI
+CcRosMarkDirtyCacheSegment(
+    PBCB Bcb,
+    ULONG FileOffset
+);
+
+NTSTATUS
+NTAPI
+CcRosFlushDirtyPages(
+    ULONG Target,
+    PULONG Count
+);
+
+VOID
+NTAPI
+CcRosDereferenceCache(PFILE_OBJECT FileObject);
+
+VOID
+NTAPI
+CcRosReferenceCache(PFILE_OBJECT FileObject);
+
+VOID
+NTAPI
+CcRosSetRemoveOnClose(PSECTION_OBJECT_POINTERS SectionObjectPointer);
+
+NTSTATUS
+NTAPI
+CcRosReleaseCacheSegment(
+    BCB* Bcb,
+    CACHE_SEGMENT *CacheSeg,
+    BOOLEAN Valid,
+    BOOLEAN Dirty,
+    BOOLEAN Mapped
+);
+
+NTSTATUS
+STDCALL
+CcRosRequestCacheSegment(
+    BCB *Bcb,
+    ULONG FileOffset,
+    PVOID* BaseAddress,
+    PBOOLEAN UptoDate,
+    CACHE_SEGMENT **CacheSeg
+);
+
+NTSTATUS
+NTAPI
+CcTryToInitializeFileCache(PFILE_OBJECT FileObject);
+
+/*
+ * Macro for generic cache manage bugchecking. Note that this macro assumes
+ * that the file name including extension is always longer than 4 characters.
+ */
+#define KEBUGCHECKCC \
+    KEBUGCHECKEX(CACHE_MANAGER, \
+    (*(DWORD*)(__FILE__ + sizeof(__FILE__) - 4) << 16) | \
+    (__LINE__ & 0xFFFF), 0, 0, 0)
+
 #endif