aboutsummaryrefslogtreecommitdiff
path: root/zenstore/basicfile.cpp
blob: fe54184cfd9a6b41c1abd1c6ea6e6f6e368c14d5 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
// Copyright Epic Games, Inc. All Rights Reserved.

#include "zenstore/basicfile.h"

#include <zencore/except.h>
#include <zencore/filesystem.h>
#include <zencore/fmtutils.h>
#include <zencore/testing.h>
#include <zencore/testutils.h>

#include <fmt/format.h>
#include <gsl/gsl-lite.hpp>

namespace zen {

using namespace fmt::literals;

BasicFile::~BasicFile()
{
	Close();
}

void
BasicFile::Open(std::filesystem::path FileName, bool IsCreate)
{
	std::error_code Ec;
	Open(FileName, IsCreate, Ec);

	if (Ec)
	{
		throw std::system_error(Ec, "failed to open file '{}'"_format(FileName));
	}
}

void
BasicFile::Open(std::filesystem::path FileName, bool IsCreate, std::error_code& Ec)
{
	const DWORD dwCreationDisposition = IsCreate ? CREATE_ALWAYS : OPEN_EXISTING;
	const DWORD dwDesiredAccess		  = GENERIC_READ | GENERIC_WRITE;
	const DWORD dwShareMode			  = FILE_SHARE_READ;
	const DWORD dwFlagsAndAttributes  = FILE_ATTRIBUTE_NORMAL;
	HANDLE		hTemplateFile		  = nullptr;

	HANDLE FileHandle = CreateFile(FileName.c_str(),
								   dwDesiredAccess,
								   dwShareMode,
								   /* lpSecurityAttributes */ nullptr,
								   dwCreationDisposition,
								   dwFlagsAndAttributes,
								   hTemplateFile);

	if (FileHandle == INVALID_HANDLE_VALUE)
	{
		Ec = zen::MakeErrorCodeFromLastError();
	}

	m_FileHandle = FileHandle;
}

void
BasicFile::Close()
{
	if (m_FileHandle)
	{
		::CloseHandle(m_FileHandle);
	}
}

void
BasicFile::Read(void* Data, uint64_t Size, uint64_t Offset)
{
	OVERLAPPED Ovl{};

	Ovl.Offset	   = DWORD(Offset & 0xffff'ffffu);
	Ovl.OffsetHigh = DWORD(Offset >> 32);

	DWORD dwNumberOfBytesToRead = gsl::narrow<DWORD>(Size);
	DWORD dwNumberOfBytesRead	= 0;

	BOOL Success = ::ReadFile(m_FileHandle, Data, dwNumberOfBytesToRead, &dwNumberOfBytesRead, &Ovl);

	if (!Success)
	{
		ThrowLastError("Failed to read from file '{}'"_format(zen::PathFromHandle(m_FileHandle)));
	}
}

IoBuffer
BasicFile::ReadAll()
{
	IoBuffer Buffer(FileSize());

	Read((void*)Buffer.Data(), Buffer.Size(), 0);

	return Buffer;
}

void
BasicFile::StreamFile(std::function<void(const void* Data, uint64_t Size)>&& ChunkFun)
{
	StreamByteRange(0, FileSize(), std::move(ChunkFun));
}

void
BasicFile::StreamByteRange(uint64_t FileOffset, uint64_t Size, std::function<void(const void* Data, uint64_t Size)>&& ChunkFun)
{
	const uint64_t ChunkSize = 128 * 1024;
	IoBuffer	   ReadBuffer{ChunkSize};
	void*		   BufferPtr = ReadBuffer.MutableData();

	uint64_t RemainBytes   = Size;
	uint64_t CurrentOffset = FileOffset;

	while (RemainBytes)
	{
		const uint64_t ThisChunkBytes = zen::Min(ChunkSize, RemainBytes);

		Read(BufferPtr, ThisChunkBytes, CurrentOffset);

		ChunkFun(BufferPtr, ThisChunkBytes);

		CurrentOffset += ThisChunkBytes;
		RemainBytes -= ThisChunkBytes;
	}
}

void
BasicFile::Write(const void* Data, uint64_t Size, uint64_t Offset)
{
	OVERLAPPED Ovl{};

	Ovl.Offset	   = DWORD(Offset & 0xffff'ffffu);
	Ovl.OffsetHigh = DWORD(Offset >> 32);

	DWORD dwNumberOfBytesToWrite = gsl::narrow<DWORD>(Size);
	DWORD dwNumberOfBytesWritten = 0;

	BOOL Success = ::WriteFile(m_FileHandle, Data, dwNumberOfBytesToWrite, &dwNumberOfBytesWritten, &Ovl);

	if (!Success)
	{
		ThrowLastError("Failed to write to file '{}'"_format(zen::PathFromHandle(m_FileHandle)));
	}
}

void
BasicFile::Flush()
{
	FlushFileBuffers(m_FileHandle);
}

uint64_t
BasicFile::FileSize()
{
	ULARGE_INTEGER liFileSize;
	liFileSize.LowPart = ::GetFileSize(m_FileHandle, &liFileSize.HighPart);

	return uint64_t(liFileSize.QuadPart);
}

#if ZEN_WITH_TESTS

TEST_CASE("BasicFile")
{
	ScopedCurrentDirectoryChange _;

	BasicFile File1;
	CHECK_THROWS(File1.Open("zonk", false));
	CHECK_NOTHROW(File1.Open("zonk", true));
	CHECK_NOTHROW(File1.Write("abcd", 4, 0));
	CHECK(File1.FileSize() == 4);
}

void
basicfile_forcelink()
{
}

#endif

}  // namespace zen