Intravision/reactos
1
0
Fork 0
mirror of https://github.com/reactos/reactos.git synced 2024-07-01 10:20:03 +00:00
Code Issues Packages Projects Releases Wiki Activity
reactos/drivers/filters/fltmgr/fltmgrint.h
Ged Murphy dfb776380d
[FLTMGR] Latest from my branch (#135) 
[FLTMGR][KMTEST] 
Squash and push my local branch across to master as the patch is getting a bit large. This is still WIP and none of this code is run in ros yet, so don't fret if you see ugly/unfinished code or int3's dotted around.

[FLTMGR] Improve loading/reg of filters and start to implement client connections
- Implement handling of connections from clients
- Implement closing of client ports
- Add a basic message waiter queue using CSQ's (untested)
- Hand off messages for the comms object to be handled by the comms file
- Initialize the connection list
- Add a registry file which will contain lib functions for accessing filter service entries

- [KMTEST] Initial usermode support for testing FS mini-filters
- Add base routines to wrap the win32 'Filter' APis
- Add support routines to be used when testing FS filter drivers
- Move KmtCreateService to a private routine so it can be shared with KmtFltCreateService
- Completely untested at the mo, so likely contains bugs at this point
- Add support for adding altitude and flags registry entries for minifilters
- Allow minifilters to setup without requiring instance attach/detach callbacks
- Add tests for FltRegisterFilter and FltUnregisterFilter and start to add associated tests
2017-11-21 16:36:29 +00:00

473 lines
10 KiB
C
Raw Blame History

#ifndef _FLTMGR_INTERNAL_H
#define _FLTMGR_INTERNAL_H
#define MAX_CONTEXT_TYPES 6
typedef enum _FLT_OBJECT_FLAGS
{
FLT_OBFL_DRAINING = 1,
FLT_OBFL_ZOMBIED = 2,
FLT_OBFL_TYPE_INSTANCE = 0x1000000,
FLT_OBFL_TYPE_FILTER = 0x2000000,
FLT_OBFL_TYPE_VOLUME = 0x4000000
} FLT_OBJECT_FLAGS, *PFLT_OBJECT_FLAGS;
typedef enum _FLT_FILTER_FLAGS
{
FLTFL_MANDATORY_UNLOAD_IN_PROGRESS = 1,
FLTFL_FILTERING_INITIATED = 2
} FLT_FILTER_FLAGS, *PFLT_FILTER_FLAGS;
typedef struct _FLT_OBJECT // size = 0x14
{
volatile FLT_OBJECT_FLAGS Flags;
ULONG PointerCount;
EX_RUNDOWN_REF RundownRef;
LIST_ENTRY PrimaryLink;
} FLT_OBJECT, *PFLT_OBJECT;
typedef struct _ALLOCATE_CONTEXT_HEADER
{
PFLT_FILTER Filter;
PFLT_CONTEXT_CLEANUP_CALLBACK ContextCleanupCallback;
struct _ALLOCATE_CONTEXT_HEADER *Next;
FLT_CONTEXT_TYPE ContextType;
char Flags;
char AllocationType;
} ALLOCATE_CONTEXT_HEADER, *PALLOCATE_CONTEXT_HEADER;
typedef struct _FLT_RESOURCE_LIST_HEAD
{
ERESOURCE rLock;
LIST_ENTRY rList;
ULONG rCount;
} FLT_RESOURCE_LIST_HEAD, *PFLT_RESOURCE_LIST_HEAD;
typedef struct _FLT_MUTEX_LIST_HEAD
{
FAST_MUTEX mLock;
LIST_ENTRY mList;
ULONG mCount;
} FLT_MUTEX_LIST_HEAD, *PFLT_MUTEX_LIST_HEAD;
typedef struct _FLT_TYPE
{
USHORT Signature;
USHORT Size;
} FLT_TYPE, *PFLT_TYPE;
// http://fsfilters.blogspot.co.uk/2010/02/filter-manager-concepts-part-1.html
typedef struct _FLTP_FRAME
{
FLT_TYPE Type;
LIST_ENTRY Links;
unsigned int FrameID;
ERESOURCE AltitudeLock;
UNICODE_STRING AltitudeIntervalLow;
UNICODE_STRING AltitudeIntervalHigh;
char LargeIrpCtrlStackSize;
char SmallIrpCtrlStackSize;
FLT_RESOURCE_LIST_HEAD RegisteredFilters;
FLT_RESOURCE_LIST_HEAD AttachedVolumes;
LIST_ENTRY MountingVolumes;
FLT_MUTEX_LIST_HEAD AttachedFileSystems;
FLT_MUTEX_LIST_HEAD ZombiedFltObjectContexts;
ERESOURCE FilterUnloadLock;
FAST_MUTEX DeviceObjectAttachLock;
//FLT_PRCB *Prcb;
void *PrcbPoolToFree;
void *LookasidePoolToFree;
//FLTP_IRPCTRL_STACK_PROFILER IrpCtrlStackProfiler;
NPAGED_LOOKASIDE_LIST SmallIrpCtrlLookasideList;
NPAGED_LOOKASIDE_LIST LargeIrpCtrlLookasideList;
//STATIC_IRP_CONTROL GlobalSIC;
} FLTP_FRAME, *PFLTP_FRAME;
typedef struct _FLT_FILTER // size = 0x120
{
FLT_OBJECT Base;
PFLTP_FRAME Frame;
UNICODE_STRING Name;
UNICODE_STRING DefaultAltitude;
FLT_FILTER_FLAGS Flags;
PDRIVER_OBJECT DriverObject;
FLT_RESOURCE_LIST_HEAD InstanceList;
PVOID VerifierExtension;
PFLT_FILTER_UNLOAD_CALLBACK FilterUnload;
PFLT_INSTANCE_SETUP_CALLBACK InstanceSetup;
PFLT_INSTANCE_QUERY_TEARDOWN_CALLBACK InstanceQueryTeardown;
PFLT_INSTANCE_TEARDOWN_CALLBACK InstanceTeardownStart;
PFLT_INSTANCE_TEARDOWN_CALLBACK InstanceTeardownComplete;
PALLOCATE_CONTEXT_HEADER SupportedContextsListHead;
PALLOCATE_CONTEXT_HEADER SupportedContexts[MAX_CONTEXT_TYPES];
PVOID PreVolumeMount;
PVOID PostVolumeMount;
PFLT_GENERATE_FILE_NAME GenerateFileName;
PFLT_NORMALIZE_NAME_COMPONENT NormalizeNameComponent;
PFLT_NORMALIZE_CONTEXT_CLEANUP NormalizeContextCleanup;
PFLT_OPERATION_REGISTRATION Operations;
PFLT_FILTER_UNLOAD_CALLBACK OldDriverUnload;
FLT_MUTEX_LIST_HEAD ActiveOpens;
FLT_MUTEX_LIST_HEAD ConnectionList;
FLT_MUTEX_LIST_HEAD PortList;
EX_PUSH_LOCK PortLock;
} FLT_FILTER, *PFLT_FILTER;
typedef enum _FLT_yINSTANCE_FLAGS
{
INSFL_CAN_BE_DETACHED = 0x01,
INSFL_DELETING = 0x02,
INSFL_INITING = 0x04
} FLT_INSTANCE_FLAGS, *PFLT_INSTANCE_FLAGS;
typedef struct _FLT_INSTANCE // size = 0x144 (324)
{
FLT_OBJECT Base;
ULONG OperationRundownRef;
PVOID Volume; //PFLT_VOLUME
PFLT_FILTER Filter;
FLT_INSTANCE_FLAGS Flags;
UNICODE_STRING Altitude;
UNICODE_STRING Name;
LIST_ENTRY FilterLink;
ERESOURCE ContextLock;
PVOID Context; //PCONTEXT_NODE
PVOID TrackCompletionNodes; //PRACK_COMPLETION_NODES
PVOID CallbackNodes[50]; //PCALLBACK_NODE
} FLT_INSTANCE, *PFLT_INSTANCE;
typedef struct _TREE_ROOT
{
RTL_SPLAY_LINKS *Tree;
} TREE_ROOT, *PTREE_ROOT;
typedef struct _CONTEXT_LIST_CTRL
{
TREE_ROOT List;
} CONTEXT_LIST_CTRL, *PCONTEXT_LIST_CTRL;
// http://fsfilters.blogspot.co.uk/2010/02/filter-manager-concepts-part-6.html
typedef struct _STREAM_LIST_CTRL // size = 0xC8 (200)
{
FLT_TYPE Type;
FSRTL_PER_STREAM_CONTEXT ContextCtrl;
LIST_ENTRY VolumeLink;
ULONG Flags; //STREAM_LIST_CTRL_FLAGS Flags;
int UseCount;
ERESOURCE ContextLock;
CONTEXT_LIST_CTRL StreamContexts;
CONTEXT_LIST_CTRL StreamHandleContexts;
ERESOURCE NameCacheLock;
LARGE_INTEGER LastRenameCompleted;
ULONG NormalizedNameCache; //NAME_CACHE_LIST_CTRL NormalizedNameCache;
ULONG ShortNameCache; // NAME_CACHE_LIST_CTRL ShortNameCache;
ULONG OpenedNameCache; // NAME_CACHE_LIST_CTRL OpenedNameCache;
int AllNameContextsTemporary;
} STREAM_LIST_CTRL, *PSTREAM_LIST_CTRL;
typedef struct _FLT_SERVER_PORT_OBJECT
{
LIST_ENTRY FilterLink;
PFLT_CONNECT_NOTIFY ConnectNotify;
PFLT_DISCONNECT_NOTIFY DisconnectNotify;
PFLT_MESSAGE_NOTIFY MessageNotify;
PFLT_FILTER Filter;
PVOID Cookie;
ULONG Flags;
LONG NumberOfConnections;
LONG MaxConnections;
} FLT_SERVER_PORT_OBJECT, *PFLT_SERVER_PORT_OBJECT;
typedef struct _FLT_MESSAGE_WAITER_QUEUE
{
IO_CSQ Csq;
FLT_MUTEX_LIST_HEAD WaiterQ;
ULONG MinimumWaiterLength;
KSEMAPHORE Semaphore;
KEVENT Event;
} FLT_MESSAGE_WAITER_QUEUE, *PFLT_MESSAGE_WAITER_QUEUE;
typedef struct _FLT_PORT_OBJECT
{
LIST_ENTRY FilterLink;
PFLT_SERVER_PORT_OBJECT ServerPort;
PVOID Cookie;
EX_RUNDOWN_REF MsgNotifRundownRef;
FAST_MUTEX Lock;
FLT_MESSAGE_WAITER_QUEUE MsgQ;
ULONGLONG MessageId;
KEVENT DisconnectEvent;
BOOLEAN Disconnected;
} FLT_PORT_OBJECT, *PFLT_PORT_OBJECT;
typedef enum _FLT_VOLUME_FLAGS
{
VOLFL_NETWORK_FILESYSTEM = 0x1,
VOLFL_PENDING_MOUNT_SETUP_NOTIFIES = 0x2,
VOLFL_MOUNT_SETUP_NOTIFIES_CALLED = 0x4,
VOLFL_MOUNTING = 0x8,
VOLFL_SENT_SHUTDOWN_IRP = 0x10,
VOLFL_ENABLE_NAME_CACHING = 0x20,
VOLFL_FILTER_EVER_ATTACHED = 0x40,
VOLFL_STANDARD_LINK_NOT_SUPPORTED = 0x80
} FLT_VOLUME_FLAGS, *PFLT_VOLUME_FLAGS;
typedef enum _CALLBACK_NODE_FLAGS
{
CBNFL_SKIP_PAGING_IO = 0x1,
CBNFL_SKIP_CACHED_IO = 0x2,
CBNFL_USE_NAME_CALLBACK_EX = 0x4,
CBNFL_SKIP_NON_DASD_IO = 0x8
} CALLBACK_NODE_FLAGS, *PCALLBACK_NODE_FLAGS;
typedef struct _CALLBACK_CTRL
{
LIST_ENTRY OperationLists[50];
CALLBACK_NODE_FLAGS OperationFlags[50];
} CALLBACK_CTRL, *PCALLBACK_CTRL;
typedef struct _NAME_CACHE_LIST_CTRL_STATS
{
ULONG Searches;
ULONG Hits;
ULONG Created;
ULONG Temporary;
ULONG Duplicate;
ULONG Removed;
ULONG RemovedDueToCase;
} NAME_CACHE_LIST_CTRL_STATS, *PNAME_CACHE_LIST_CTRL_STATS;
typedef struct _NAME_CACHE_VOLUME_CTRL_STATS
{
ULONG AllContextsTemporary;
ULONG PurgeNameCache;
NAME_CACHE_LIST_CTRL_STATS NormalizedNames;
NAME_CACHE_LIST_CTRL_STATS OpenedNames;
NAME_CACHE_LIST_CTRL_STATS ShortNames;
ULONG AncestorLookup;
ULONG ParentHit;
ULONG NonParentHit;
} NAME_CACHE_VOLUME_CTRL_STATS, *PNAME_CACHE_VOLUME_CTRL_STATS;
typedef struct _NAME_CACHE_VOLUME_CTRL
{
FAST_MUTEX Lock;
ULONG AllContextsTemporary;
LARGE_INTEGER LastRenameCompleted;
NAME_CACHE_VOLUME_CTRL_STATS Stats;
} NAME_CACHE_VOLUME_CTRL, *PNAME_CACHE_VOLUME_CTRL;
typedef struct _FLT_VOLUME
{
FLT_OBJECT Base;
FLT_VOLUME_FLAGS Flags;
FLT_FILESYSTEM_TYPE FileSystemType;
PDEVICE_OBJECT DeviceObject;
PDEVICE_OBJECT DiskDeviceObject;
PFLT_VOLUME FrameZeroVolume;
PFLT_VOLUME VolumeInNextFrame;
PFLTP_FRAME Frame;
UNICODE_STRING DeviceName;
UNICODE_STRING GuidName;
UNICODE_STRING CDODeviceName;
UNICODE_STRING CDODriverName;
FLT_RESOURCE_LIST_HEAD InstanceList;
CALLBACK_CTRL Callbacks;
EX_PUSH_LOCK ContextLock;
CONTEXT_LIST_CTRL VolumeContexts;
FLT_RESOURCE_LIST_HEAD StreamListCtrls;
FLT_RESOURCE_LIST_HEAD FileListCtrls;
NAME_CACHE_VOLUME_CTRL NameCacheCtrl;
ERESOURCE MountNotifyLock;
ULONG TargetedOpenActiveCount;
EX_PUSH_LOCK TxVolContextListLock;
TREE_ROOT TxVolContexts;
} FLT_VOLUME, *PFLT_VOLUME;
typedef struct _MANAGER_CCB
{
PFLTP_FRAME Frame;
unsigned int Iterator;
} MANAGER_CCB, *PMANAGER_CCB;
typedef struct _FILTER_CCB
{
PFLT_FILTER Filter;
unsigned int Iterator;
} FILTER_CCB, *PFILTER_CCB;
typedef struct _INSTANCE_CCB
{
PFLT_INSTANCE Instance;
} INSTANCE_CCB, *PINSTANCE_CCB;
typedef struct _VOLUME_CCB
{
UNICODE_STRING Volume;
unsigned int Iterator;
} VOLUME_CCB, *PVOLUME_CCB;
typedef struct _PORT_CCB
{
PFLT_PORT_OBJECT Port;
FLT_MUTEX_LIST_HEAD ReplyWaiterList;
} PORT_CCB, *PPORT_CCB;
typedef union _CCB_TYPE
{
MANAGER_CCB Manager;
FILTER_CCB Filter;
INSTANCE_CCB Instance;
VOLUME_CCB Volume;
PORT_CCB Port;
} CCB_TYPE, *PCCB_TYPE;
typedef struct _FLT_CCB
{
FLT_TYPE Type;
CCB_TYPE Data;
} FLT_CCB, *PFLT_CCB;
VOID
FltpExInitializeRundownProtection(
_Out_ PEX_RUNDOWN_REF RundownRef
);
BOOLEAN
FltpExAcquireRundownProtection(
_Inout_ PEX_RUNDOWN_REF RundownRef
);
BOOLEAN
FltpExReleaseRundownProtection(
_Inout_ PEX_RUNDOWN_REF RundownRef
);
NTSTATUS
NTAPI
FltpObjectRundownWait(
_Inout_ PEX_RUNDOWN_REF RundownRef
);
BOOLEAN
FltpExRundownCompleted(
_Inout_ PEX_RUNDOWN_REF RundownRef
);
NTSTATUS
FltpGetBaseDeviceObjectName(
_In_ PDEVICE_OBJECT DeviceObject,
_Inout_ PUNICODE_STRING ObjectName
);
NTSTATUS
FltpGetObjectName(
_In_ PVOID Object,
_Inout_ PUNICODE_STRING ObjectName
);
ULONG
FltpObjectPointerReference(
_In_ PFLT_OBJECT Object
);
VOID
FltpObjectPointerDereference(
_In_ PFLT_OBJECT Object
);
NTSTATUS
FltpReallocateUnicodeString(
_In_ PUNICODE_STRING String,
_In_ SIZE_T NewLength,
_In_ BOOLEAN CopyExisting
);
VOID
FltpFreeUnicodeString(
_In_ PUNICODE_STRING String
);
NTSTATUS
FltpDeviceControlHandler(
_In_ PDEVICE_OBJECT DeviceObject,
_Inout_ PIRP Irp
);
NTSTATUS
FltpDispatchHandler(
_In_ PDEVICE_OBJECT DeviceObject,
_Inout_ PIRP Irp
);
NTSTATUS
FltpMsgCreate(
_In_ PDEVICE_OBJECT DeviceObject,
_Inout_ PIRP Irp
);
NTSTATUS
FltpMsgDispatch(
_In_ PDEVICE_OBJECT DeviceObject,
_Inout_ PIRP Irp
);
NTSTATUS
FltpSetupCommunicationObjects(
_In_ PDRIVER_OBJECT DriverObject
);
#endif /* _FLTMGR_INTERNAL_H */
Reference in a new issue View git blame Copy permalink