133 lines
6.2 KiB
C
133 lines
6.2 KiB
C
// Public nt-lite DDK filesystem declarations.
|
|
|
|
#pragma once
|
|
|
|
#include <stdint.h>
|
|
#include <stddef.h>
|
|
#include <stdbool.h>
|
|
#include <ntlite/status.h>
|
|
#include <ntlite/string_view.h>
|
|
#include <ntlite/dirent.h>
|
|
#include <ntlite/file_stat.h>
|
|
#include <ntlite/ddk/async.h>
|
|
#include <ntlite/ddk/object.h>
|
|
#include <ntlite/ddk/sync.h>
|
|
|
|
typedef SYS_DIR_ENTRY KDIR_ENTRY;
|
|
#define KDIR_NAME_MAX SYS_DIR_NAME_MAX
|
|
|
|
typedef void (*IO_FS_ASYNC_COMPLETE)(void* completeContext,
|
|
KSTATUS status,
|
|
size_t information);
|
|
|
|
typedef struct IO_FILESYSTEM_STATS {
|
|
uint64_t PathLookups;
|
|
uint64_t PathCacheHits;
|
|
uint64_t PathCacheMisses;
|
|
uint64_t PathCacheStores;
|
|
uint64_t PathCacheInvalidations;
|
|
uint64_t PathCacheGeneration;
|
|
uint64_t DirectorySearches;
|
|
uint64_t DirectoryBlocksRead;
|
|
uint64_t DirectoryEntriesScanned;
|
|
uint64_t DataReadRuns;
|
|
uint64_t DataReadSectors;
|
|
uint64_t DataReadRunMerges;
|
|
uint64_t MaxDataReadSpanSectors;
|
|
} IO_FILESYSTEM_STATS;
|
|
|
|
typedef struct IO_FILE_IDENTITY {
|
|
uint64_t VolumeId;
|
|
uint64_t FileId;
|
|
uint64_t Generation;
|
|
uint64_t Size;
|
|
} IO_FILE_IDENTITY;
|
|
|
|
typedef struct IO_FILESYSTEM {
|
|
KSTATUS (*Open)(struct IO_FILESYSTEM* fs, SYS_STRING_VIEW path, void** fileCtx);
|
|
KSTATUS (*Read)(struct IO_FILESYSTEM* fs, void* fileCtx, uint64_t offset, void* buf, size_t size, size_t* bytesRead);
|
|
KSTATUS (*Write)(struct IO_FILESYSTEM* fs, void* fileCtx, uint64_t offset, const void* buf, size_t size, size_t* bytesWritten);
|
|
KSTATUS (*ReadAsync)(struct IO_FILESYSTEM* fs, void* fileCtx, uint64_t offset, void* buf, size_t size, IO_FS_ASYNC_COMPLETE complete, void* completeContext);
|
|
KSTATUS (*WriteAsync)(struct IO_FILESYSTEM* fs, void* fileCtx, uint64_t offset, const void* buf, size_t size, IO_FS_ASYNC_COMPLETE complete, void* completeContext);
|
|
KSTATUS (*Create)(struct IO_FILESYSTEM* fs, SYS_STRING_VIEW path, void** fileCtx);
|
|
KSTATUS (*Delete)(struct IO_FILESYSTEM* fs, SYS_STRING_VIEW path);
|
|
KSTATUS (*Rename)(struct IO_FILESYSTEM* fs, SYS_STRING_VIEW oldPath, SYS_STRING_VIEW newPath);
|
|
KSTATUS (*CreateDir)(struct IO_FILESYSTEM* fs, SYS_STRING_VIEW path);
|
|
KSTATUS (*RemoveDir)(struct IO_FILESYSTEM* fs, SYS_STRING_VIEW path);
|
|
KSTATUS (*Truncate)(struct IO_FILESYSTEM* fs, void* fileCtx, uint64_t newSize, uint32_t fileFlags);
|
|
uint64_t (*GetSize)(struct IO_FILESYSTEM* fs, void* fileCtx);
|
|
KSTATUS (*QueryInfo)(struct IO_FILESYSTEM* fs, void* fileCtx, SYS_FILE_STAT* out);
|
|
KSTATUS (*Stat)(struct IO_FILESYSTEM* fs, SYS_STRING_VIEW path, SYS_FILE_STAT* out);
|
|
KSTATUS (*QueryIdentity)(struct IO_FILESYSTEM* fs, void* fileCtx, IO_FILE_IDENTITY* out);
|
|
void (*Close)(struct IO_FILESYSTEM* fs, void* fileCtx);
|
|
void (*QueryStats)(struct IO_FILESYSTEM* fs, IO_FILESYSTEM_STATS* out);
|
|
void* DriverCtx;
|
|
KSTATUS (*OpenDir)(struct IO_FILESYSTEM* fs, SYS_STRING_VIEW dirPath, void** dirCtx);
|
|
KSTATUS (*ReadDir)(struct IO_FILESYSTEM* fs, void* dirCtx, KDIR_ENTRY* out);
|
|
void (*CloseDir)(struct IO_FILESYSTEM* fs, void* dirCtx);
|
|
} IO_FILESYSTEM;
|
|
|
|
struct EVENT;
|
|
struct KAPC;
|
|
typedef struct MM_LOCKED_USER_BUFFER MM_LOCKED_USER_BUFFER;
|
|
typedef struct IO_ASYNC_FILE_REQUEST_OBJECT IO_ASYNC_FILE_REQUEST_OBJECT;
|
|
|
|
#define IO_FILE_FLAG_NO_CACHE 0x00000001u
|
|
#define IO_FILE_FLAG_SKIP_ZERO_EXTEND 0x00000002u
|
|
#define IO_FILE_FLAG_APPEND 0x00000004u
|
|
|
|
typedef struct FILE_OBJECT {
|
|
OBJECT Header;
|
|
IO_FILESYSTEM* Fs;
|
|
void* FileCtx;
|
|
SPINLOCK Lock;
|
|
uint64_t Size;
|
|
uint64_t Offset;
|
|
uint32_t Flags;
|
|
uint32_t ReadaheadScore;
|
|
uint64_t ReadaheadNextOffset;
|
|
uint64_t ReadaheadIssuedUntil;
|
|
uint64_t ReadaheadSuppressedUntil;
|
|
} FILE_OBJECT;
|
|
|
|
typedef struct DIR_OBJECT {
|
|
OBJECT Header;
|
|
IO_FILESYSTEM* Fs;
|
|
void* DirCtx;
|
|
} DIR_OBJECT;
|
|
|
|
typedef struct IO_VOLUME_PARAMS {
|
|
uint8_t DiskIndex;
|
|
uint64_t PartitionLba;
|
|
uint64_t PartitionSize;
|
|
} IO_VOLUME_PARAMS;
|
|
|
|
__declspec(dllexport) KSTATUS IoRegisterFilesystem(uint8_t driveIndex, IO_FILESYSTEM* fs, const IO_VOLUME_PARAMS* vol);
|
|
__declspec(dllexport) KSTATUS IoUnregisterFilesystem(uint8_t driveIndex);
|
|
__declspec(dllexport) KSTATUS IoUnregisterFilesystemsForDisk(uint8_t diskIndex);
|
|
__declspec(dllexport) bool IoFilesystemPresent(uint8_t driveIndex);
|
|
__declspec(dllexport) void IoQueryFilesystemStats(IO_FILESYSTEM_STATS* out);
|
|
__declspec(dllexport) KSTATUS IoOpenFile(SYS_STRING_VIEW path, FILE_OBJECT** out);
|
|
__declspec(dllexport) KSTATUS IoReadFile(FILE_OBJECT* file, void* buf, size_t size, size_t* bytesRead);
|
|
__declspec(dllexport) KSTATUS IoReadFileAt(FILE_OBJECT* file, uint64_t offset, void* buf, size_t size, size_t* bytesRead);
|
|
__declspec(dllexport) KSTATUS IoWriteFile(FILE_OBJECT* file, const void* buf, size_t size, size_t* bytesWritten);
|
|
__declspec(dllexport) KSTATUS IoWriteFileAt(FILE_OBJECT* file, uint64_t offset, const void* buf, size_t size, size_t* bytesWritten);
|
|
__declspec(dllexport) KSTATUS IoFlushFile(FILE_OBJECT* file);
|
|
__declspec(dllexport) KSTATUS IoCreateFile(SYS_STRING_VIEW path, FILE_OBJECT** out);
|
|
__declspec(dllexport) KSTATUS IoDeleteFile(SYS_STRING_VIEW path);
|
|
__declspec(dllexport) KSTATUS IoRenameFile(SYS_STRING_VIEW oldPath, SYS_STRING_VIEW newPath);
|
|
__declspec(dllexport) KSTATUS IoCreateDir(SYS_STRING_VIEW path);
|
|
__declspec(dllexport) KSTATUS IoRemoveDir(SYS_STRING_VIEW path);
|
|
__declspec(dllexport) KSTATUS IoTruncateFile(FILE_OBJECT* file, uint64_t newSize);
|
|
__declspec(dllexport) KSTATUS IoSeekFile(FILE_OBJECT* file, uint64_t offset);
|
|
__declspec(dllexport) uint64_t IoGetFileSize(FILE_OBJECT* file);
|
|
__declspec(dllexport) KSTATUS IoGetFileStat(FILE_OBJECT* file, SYS_FILE_STAT* out);
|
|
__declspec(dllexport) KSTATUS IoStatFile(SYS_STRING_VIEW path, SYS_FILE_STAT* out);
|
|
__declspec(dllexport) KSTATUS IoQueryFileIdentity(FILE_OBJECT* file, IO_FILE_IDENTITY* out);
|
|
__declspec(dllexport) void IoCloseFile(FILE_OBJECT* file);
|
|
__declspec(dllexport) KSTATUS IoOpenDir(SYS_STRING_VIEW dirPath, DIR_OBJECT** out);
|
|
__declspec(dllexport) KSTATUS IoReadDir(DIR_OBJECT* dir, KDIR_ENTRY* entryOut);
|
|
__declspec(dllexport) void IoCloseDir(DIR_OBJECT* dir);
|
|
__declspec(dllexport) KSTATUS IoSetCwd(SYS_STRING_VIEW path);
|
|
__declspec(dllexport) KSTATUS IoRealPath(SYS_STRING_VIEW path, char* buffer, size_t bufferSize, size_t* requiredSizeOut);
|