7f45d2a56e1f33905616c8f43d4df0865de563a2
[people/sha0/winvblock.git] / src / include / filedisk.h
1 /**
2  * Copyright (C) 2009-2011, Shao Miller <shao.miller@yrdsb.edu.on.ca>.
3  *
4  * This file is part of WinVBlock, derived from WinAoE.
5  *
6  * WinVBlock is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * WinVBlock is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with WinVBlock.  If not, see <http://www.gnu.org/licenses/>.
18  */
19 #ifndef WV_M_FILEDISK_H_
20 #  define WV_M_FILEDISK_H_
21
22 /**
23  * @file
24  *
25  * File-backed disk specifics.
26  */
27
28 typedef struct WV_FILEDISK_T {
29     WV_SP_DISK_T disk;
30     HANDLE file;
31     UINT32 hash;
32     WV_FP_DEV_FREE prev_free;
33     LIST_ENTRY tracking;
34     LARGE_INTEGER offset;
35     /* For threaded instances. */
36     LIST_ENTRY req_list;
37     KSPIN_LOCK req_list_lock;
38     KEVENT signal;
39     WV_FP_DISK_IO sync_io;
40     char *filepath;
41     UNICODE_STRING filepath_unicode;
42   } WV_S_FILEDISK_T, * WV_SP_FILEDISK_T;
43
44 extern WV_F_DEV_DISPATCH WvFilediskAttach;
45
46 extern NTSTATUS WvFilediskModuleInit(void);
47
48 /**
49  * Create a new file-backed disk.
50  *
51  * @ret filedisk_ptr    The address of a new filedisk, or NULL for failure.
52  *
53  * This function should not be confused with a PDO creation routine, which is
54  * actually implemented for each device type.  This routine will allocate a
55  * WV_S_FILEDISK_T, track it in a global list, as well as populate the disk
56  * with default values.
57  */
58 extern WV_SP_FILEDISK_T filedisk__create(void);
59 /**
60  * Create a new threaded, file-backed disk
61  *
62  * @ret filedisk_ptr    The address of a new filedisk, or NULL for failure
63  *
64  * See filedisk__create() above.  This routine uses threaded routines
65  * for disk reads/writes, and frees asynchronously, too.
66  */
67 extern WV_SP_FILEDISK_T WvFilediskCreateThreaded(void);
68
69 /*
70  * Yield a pointer to the file-backed disk
71  */
72 #  define filedisk__get_ptr( dev_ptr ) \
73   ((WV_SP_FILEDISK_T) (disk__get_ptr(dev_ptr))->ext)
74
75 extern VOID STDCALL filedisk__hot_swap_thread(IN PVOID StartContext);
76
77 #endif  /* WV_M_FILEDISK_H_ */