summaryrefslogtreecommitdiffstatshomepage
path: root/src/lib/formats/fsmgr.h
blob: 305dd0fe92eb359d5bad410a4c6b09eaf7b2973b (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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
// license:BSD-3-Clause
// copyright-holders:Olivier Galibert

// Filesystem management code for floppy, hd and cdrom images

#ifndef MAME_FORMATS_FSMGR_H
#define MAME_FORMATS_FSMGR_H

#pragma once

#include "flopimg.h"

#include <variant>
#include <unordered_map>

enum class fs_meta_name {
	creation_date,
	length,
	loading_address,
	locked,
	sequential,
	modification_date,
	name,
	size_in_blocks,
};

enum class fs_meta_type {
	string,
	number,
	date,
	flag,
};

enum class fs_dir_entry_type {
	dir,
	file,
	system_file,
};

using fs_meta = std::variant<std::string, uint64_t, bool>;
using fs_meta_data = std::unordered_map<fs_meta_name, fs_meta>;

const char *fs_meta_get_name(fs_meta_name name);
std::string fs_meta_to_string(fs_meta_type type, const fs_meta &m);
fs_meta fs_meta_from_string(fs_meta_type type, std::string value);

template<typename T> class fs_refcounted_outer {
public:
	fs_refcounted_outer(bool weak = false) :  m_object(nullptr), m_is_weak_ref(weak) {}
	fs_refcounted_outer(T *object, bool weak = false) : m_object(object), m_is_weak_ref(weak) {
		ref();
	}

	fs_refcounted_outer(const fs_refcounted_outer &cref) {
		m_object = cref.m_object;
		m_is_weak_ref = cref.m_is_weak_ref;
		ref();
	}

	fs_refcounted_outer(fs_refcounted_outer &&cref) {
		m_object = cref.m_object;
		m_is_weak_ref = cref.m_is_weak_ref;
		cref.m_object = nullptr;
	}

	~fs_refcounted_outer() {
		unref();
	}

	fs_refcounted_outer<T> &operator =(T *dir) {
		unref();
		m_object = dir;
		ref();
		return *this;
	}

	fs_refcounted_outer<T> &operator =(const fs_refcounted_outer<T> &cref) {
		unref();
		m_object = cref.m_object;
		m_is_weak_ref = cref.m_is_weak_ref;
		ref();
		return *this;
	}

	fs_refcounted_outer<T> &operator =(fs_refcounted_outer<T> &&cref) {
		m_object = cref.m_object;
		m_is_weak_ref = cref.m_is_weak_ref;
		cref.m_object = nullptr;
		return *this;
	}

	operator bool() const { return m_object != nullptr; }

protected:
	T *m_object;
	bool m_is_weak_ref;

private:
	void ref() {
		if(m_object) {
			if(m_is_weak_ref)
				m_object->ref_weak();
			else
				m_object->ref();
		}
	}
	
	void unref() {
		if(m_object) {
			if(m_is_weak_ref)
				m_object->unref_weak();
			else
				m_object->unref();
		}
	}
};


struct fs_meta_description {
	fs_meta_name m_name;
	fs_meta_type m_type;
	fs_meta m_default;
	bool m_ro;
	std::function<void (const fs_meta &)> m_validator;
	const char *m_tooltip;

	fs_meta_description(fs_meta_name name, fs_meta_type type, int def, bool ro, std::function<void (fs_meta)> validator, const char *tooltip) :
		m_name(name), m_type(type), m_default(uint64_t(def)), m_ro(ro), m_validator(validator), m_tooltip(tooltip)
	{}

	template<typename T> fs_meta_description(fs_meta_name name, fs_meta_type type, T def, bool ro, std::function<void (fs_meta)> validator, const char *tooltip) :
		m_name(name), m_type(type), m_default(def), m_ro(ro), m_validator(validator), m_tooltip(tooltip)
	{}
};

class fs_refcounted_inner {
public:
	fs_refcounted_inner() : m_ref(0), m_weak_ref(0) {}
	virtual ~fs_refcounted_inner() = default;

	void ref();
	void ref_weak();
	void unref();
	void unref_weak();

	virtual void drop_weak_references() = 0;

private:
	uint32_t m_ref, m_weak_ref;
};

struct fs_dir_entry {
	std::string m_name;
	fs_dir_entry_type m_type;
	uint64_t m_key;

	fs_dir_entry(const std::string &name, fs_dir_entry_type type, uint64_t key) : m_name(name), m_type(type), m_key(key) {}
};

class fsblk_t {
protected:
	class iblock_t : public fs_refcounted_inner {
	public:
		iblock_t(uint32_t size) : fs_refcounted_inner(), m_size(size) {}
		virtual ~iblock_t() = default;

		uint32_t size() const { return m_size; }

		virtual const uint8_t *rodata() = 0;
		virtual uint8_t *data() = 0;
		uint8_t *offset(const char *function, uint32_t off, uint32_t size);
		const uint8_t *rooffset(const char *function, uint32_t off, uint32_t size);

	protected:
		uint32_t m_size;
	};


public:
	class block_t : public fs_refcounted_outer<iblock_t> {
	public:
		block_t(bool weak = false) :  fs_refcounted_outer<iblock_t>(weak) {}
		block_t(iblock_t *block, bool weak = false) : fs_refcounted_outer(block, weak) {}
		virtual ~block_t() = default;

		block_t strong() { return block_t(m_object, false); }
		block_t weak() { return block_t(m_object, true); }

		const uint8_t *rodata() { return m_object->rodata(); }
		uint8_t *data() { return m_object->data(); }

		void copy(uint32_t offset, const uint8_t *src, uint32_t size);
		void fill(                 uint8_t data);
		void fill(uint32_t offset, uint8_t data, uint32_t size);
		void wstr(uint32_t offset, const std::string &str);
		void w8(  uint32_t offset, uint8_t data);
		void w16b(uint32_t offset, uint16_t data);
		void w24b(uint32_t offset, uint32_t data);
		void w32b(uint32_t offset, uint32_t data);
		void w16l(uint32_t offset, uint16_t data);
		void w24l(uint32_t offset, uint32_t data);
		void w32l(uint32_t offset, uint32_t data);

		std::string rstr(uint32_t offset, uint32_t size);
		uint8_t  r8(  uint32_t offset);
		uint16_t r16b(uint32_t offset);
		uint32_t r24b(uint32_t offset);
		uint32_t r32b(uint32_t offset);
		uint16_t r16l(uint32_t offset);
		uint32_t r24l(uint32_t offset);
		uint32_t r32l(uint32_t offset);
	};

	fsblk_t() : m_block_size(0) {}
	virtual ~fsblk_t() = default;
	
	virtual void set_block_size(uint32_t block_size);
	virtual uint32_t block_count() const = 0;
	virtual block_t get(uint32_t id) = 0;
	virtual void fill(uint8_t data) = 0;

protected:
	uint32_t m_block_size;
};


class filesystem_t {
public:
	class dir_t;
	class file_t;

protected:
	class idir_t : public fs_refcounted_inner {
	public:
		idir_t() : fs_refcounted_inner() {}
		virtual ~idir_t() = default;

		virtual fs_meta_data metadata() = 0;
		virtual std::vector<fs_dir_entry> contents() = 0;
		virtual file_t file_get(uint64_t key) = 0;
		virtual dir_t dir_get(uint64_t key) = 0;
	};

	class ifile_t : public fs_refcounted_inner {
	public:
		ifile_t() : fs_refcounted_inner() {}
		virtual ~ifile_t() = default;

		virtual fs_meta_data metadata() = 0;
		virtual std::vector<u8> read_all() = 0;
		virtual std::vector<u8> read(u64 start, u64 length) = 0;
	};

public:
	class dir_t : public fs_refcounted_outer<idir_t> {
	public:
		dir_t(bool weak = false) :  fs_refcounted_outer<idir_t>(weak) {}
		dir_t(idir_t *dir, bool weak = false) : fs_refcounted_outer(dir, weak) {}
		virtual ~dir_t() = default;

		dir_t strong() { return dir_t(m_object, false); }
		dir_t weak() { return dir_t(m_object, true); }

		fs_meta_data metadata() { return m_object->metadata(); }
		std::vector<fs_dir_entry> contents() { return m_object->contents(); }
		file_t file_get(uint64_t key) { return m_object->file_get(key); }
		dir_t dir_get(uint64_t key)  { return m_object->dir_get(key); }
	};

	class file_t : public fs_refcounted_outer<ifile_t> {
	public:
		file_t(bool weak = false) : fs_refcounted_outer<ifile_t>(weak) {}
		file_t(ifile_t *file, bool weak = false) : fs_refcounted_outer(file, weak) {}
		virtual ~file_t() = default;

		file_t strong() { return file_t(m_object, false); }
		file_t weak() { return file_t(m_object, true); }

		fs_meta_data metadata() { return m_object->metadata(); }

		std::vector<u8> read_all() { return m_object->read_all(); }
		std::vector<u8> read(u32 start, u32 length) { return m_object->read(start, length); }
	};

	filesystem_t(fsblk_t &blockdev, u32 size) : m_blockdev(blockdev) {
		m_blockdev.set_block_size(size);
	}

	virtual ~filesystem_t() = default;

	virtual void format(const fs_meta_data &meta);
	virtual fs_meta_data metadata();
	virtual dir_t root();

protected:
	fsblk_t &m_blockdev;
};

class unformatted_floppy_creator;
	
class filesystem_manager_t {
public:
	struct floppy_enumerator {
		virtual ~floppy_enumerator() = default;

		virtual void add(const filesystem_manager_t *manager, floppy_format_type type, uint32_t image_size, const char *name, const char *description) = 0;
		virtual void add_raw(const char *name, uint32_t key, const char *description) = 0;
	};

	struct hd_enumerator {
		virtual ~hd_enumerator() = default;

		virtual void add(const filesystem_manager_t *manager, const char *name, const char *description) = 0;
	};

	struct cdrom_enumerator {
		virtual ~cdrom_enumerator() = default;

		virtual void add(const filesystem_manager_t *manager, const char *name, const char *description) = 0;
	};


	virtual ~filesystem_manager_t() = default;

	virtual void enumerate_f(floppy_enumerator &fe, uint32_t form_factor, const std::vector<uint32_t> &variants) const;
	virtual void enumerate_h(hd_enumerator &he) const;
	virtual void enumerate_c(cdrom_enumerator &ce) const;

	virtual bool can_format() const = 0;
	virtual bool can_read() const = 0;
	virtual bool can_write() const = 0;
	virtual char directory_separator() const;

	bool has_subdirectories() const { return directory_separator() != 0; }

	virtual std::vector<fs_meta_description> volume_meta_description() const;
	virtual std::vector<fs_meta_description> file_meta_description() const;
	virtual std::vector<fs_meta_description> directory_meta_description() const;

	// Create a filesystem object from a block device
	virtual std::unique_ptr<filesystem_t> mount(fsblk_t &blockdev) const = 0;

protected:
	filesystem_manager_t() = default;

	static bool has(uint32_t form_factor, const std::vector<uint32_t> &variants, uint32_t ff, uint32_t variant);
	static bool has_variant(const std::vector<uint32_t> &variants, uint32_t variant);
};


typedef filesystem_manager_t *(*filesystem_manager_type)();

// this template function creates a stub which constructs a filesystem manager
template<class _FormatClass>
filesystem_manager_t *filesystem_manager_creator()
{
	return new _FormatClass();
}

#endif