dokani.h

/*
  Dokan : user-mode file system library for Windows

  Copyright (C) 2008 Hiroki Asakawa info@dokan-dev.net

  http://dokan-dev.net/en

This program is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the Free
Software Foundation; either version 3 of the License, or (at your option) any
later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along
with this program. If not, see <http://www.gnu.org/licenses/>.
*/


#ifndef _DOKANI_H_
#define _DOKANI_H_

#include <windows.h>
#include <stdio.h>
#include <stdlib.h>

#include "../public.h"
#include "dokanc.h"
#include "list.h"
#include "dokan.h"

#ifdef __cplusplus
extern "C" {
#endif



typedef struct _DOKAN_INSTANCE {
    // to ensure that unmount dispatch is called at once
    CRITICAL_SECTION	CriticalSection;

    // store CurrentDeviceName
    // (when there are many mounts, each mount use
    // other DeviceName)
    WCHAR	DeviceName[64];
    WCHAR	MountPoint[MAX_PATH];

    ULONG	DeviceNumber;
    ULONG	MountId;

    PDOKAN_OPTIONS		DokanOptions;
    PDOKAN_OPERATIONS	DokanOperations;

    LIST_ENTRY	ListEntry;
} DOKAN_INSTANCE, *PDOKAN_INSTANCE;

//
// OPEN_INFO contains information for a opened file.
// When user mode file system receives a CREATE Irp, it allocate the memory and deallocate the memory at CLOSE Irp.
// 1:1 correspondence with CCB(kernel mode driver data structure).
//
typedef struct _DOKAN_OPEN_INFO {
    BOOL			IsDirectory;
    // It is set to 2 when he creates.
    // Everytime we send a I/O result information, it will be increased.
    // Because IRP_MJ_CLOSE decrease it, it should be 2 first.
    ULONG			OpenCount;
    PEVENT_CONTEXT	EventContext;
    PDOKAN_INSTANCE	DokanInstance;
    //
    // It contains a user mode file handle
    //
    ULONG64			UserContext;
    //
    // 이벤트 아이디는 OPEN_INFO 구조체에 대한 시퀀스이다.
    // EventId is a sequence for OPEN_INFO structure.
    // It gives you information how much times the files are opened after your driver loaded.
    //
    ULONG			EventId;
    PLIST_ENTRY		DirListHead;
} DOKAN_OPEN_INFO, *PDOKAN_OPEN_INFO;


BOOL
DokanStart(
    PDOKAN_INSTANCE	Instance
    );

BOOL
SendToDevice(
    LPCWSTR	DeviceName,
    DWORD	IoControlCode,
    PVOID	InputBuffer,
    ULONG	InputLength,
    PVOID	OutputBuffer,
    ULONG	OutputLength,
    PULONG	ReturnedLength);

BOOL GetRawDeviceName(LPCWSTR pDeviceName, LPWSTR pRawDeviceName, size_t cchRawDeviceName);

UINT __stdcall
DokanLoop(
    PVOID Param);


BOOL
DokanMount(
    LPCWSTR	MountPoint,
    LPCWSTR	DeviceName);

VOID
SendEventInformation(
    HANDLE				Handle,
    PEVENT_INFORMATION	EventInfo,
    ULONG				EventLength,
    PDOKAN_INSTANCE		DokanInstance);


PEVENT_INFORMATION
DispatchCommon(
    PEVENT_CONTEXT		EventContext,
    ULONG				SizeOfEventInfo,
    PDOKAN_INSTANCE		DokanInstance,
    PDOKAN_FILE_INFO	DokanFileInfo,
    PDOKAN_OPEN_INFO*	DokanOpenInfo);


VOID
DispatchDirectoryInformation(
    HANDLE				Handle,
    PEVENT_CONTEXT		EventContext,
    PDOKAN_INSTANCE		DokanInstance);


VOID
DispatchQueryInformation(
    HANDLE				Handle,
    PEVENT_CONTEXT		EventContext,
    PDOKAN_INSTANCE		DokanInstance);


VOID
DispatchQueryVolumeInformation(
    HANDLE				Handle,
    PEVENT_CONTEXT		EventContext,
    PDOKAN_INSTANCE		DokanInstance);


VOID
DispatchSetInformation(
    HANDLE				Handle,
    PEVENT_CONTEXT		EventContext,
    PDOKAN_INSTANCE		DokanInstance);


VOID
DispatchRead(
    HANDLE				Handle,
    PEVENT_CONTEXT		EventContext,
    PDOKAN_INSTANCE		DokanInstance);


VOID
DispatchWrite(
    HANDLE				Handle,
    PEVENT_CONTEXT		EventContext,
    PDOKAN_INSTANCE		DokanInstance);


VOID
DispatchCreate(
    HANDLE				Handle,
    PEVENT_CONTEXT		EventContext,
    PDOKAN_INSTANCE		DokanInstance);


VOID
DispatchClose(
    HANDLE				Handle,
    PEVENT_CONTEXT		EventContext,
    PDOKAN_INSTANCE		DokanInstance);


VOID
DispatchCleanup(
    HANDLE				Handle,
    PEVENT_CONTEXT		EventContext,
    PDOKAN_INSTANCE		DokanInstance);


VOID
DispatchFlush(
    HANDLE				Handle,
    PEVENT_CONTEXT		EventContext,
    PDOKAN_INSTANCE		DokanInstance);


VOID
DispatchUnmount(
    HANDLE				Handle,
    PEVENT_CONTEXT		EventContext,
    PDOKAN_INSTANCE		DokanInstance);


VOID
DispatchLock(
    HANDLE				Handle,
    PEVENT_CONTEXT		EventContext,
    PDOKAN_INSTANCE		DokanInstance);


VOID
DispatchQuerySecurity(
    HANDLE				Handle,
    PEVENT_CONTEXT		EventContext,
    PDOKAN_INSTANCE		DokanInstance);


VOID
DispatchSetSecurity(
    HANDLE			Handle,
    PEVENT_CONTEXT	EventContext,
    PDOKAN_INSTANCE	DokanInstance);


BOOLEAN
InstallDriver(
    SC_HANDLE  SchSCManager,
    LPCWSTR    DriverName,
    LPCWSTR    ServiceExe);


BOOLEAN
RemoveDriver(
    SC_HANDLE  SchSCManager,
    LPCWSTR    DriverName);


BOOLEAN
StartDriver(
    SC_HANDLE  SchSCManager,
    LPCWSTR    DriverName);


BOOLEAN
StopDriver(
    SC_HANDLE  SchSCManager,
    LPCWSTR    DriverName);


BOOLEAN
ManageDriver(
    LPCWSTR  DriverName,
    LPCWSTR  ServiceName,
    USHORT   Function);


BOOL
SendReleaseIRP(
    LPCWSTR DeviceName);

VOID
CheckFileName(
    LPWSTR	FileName);

VOID
ClearFindData(
  PLIST_ENTRY	ListHead);

UINT WINAPI
    DokanKeepAlive(
    PVOID pDokanInstance);


NTSTATUS
GetNTStatus(DWORD ErrorCode);

PDOKAN_OPEN_INFO
GetDokanOpenInfo(
    PEVENT_CONTEXT		EventInfomation,
    PDOKAN_INSTANCE		DokanInstance);

VOID
ReleaseDokanOpenInfo(
    PEVENT_INFORMATION	EventInfomation,
    PDOKAN_INSTANCE		DokanInstance);


#ifdef __cplusplus
}
#endif


#endif