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
|
// license:BSD-3-Clause
// copyright-holders:Aaron Giles
/***************************************************************************
audit.h
ROM, disk, and sample auditing functions.
***************************************************************************/
#pragma once
#ifndef MAME_FRONTEND_AUDIT_H
#define MAME_FRONTEND_AUDIT_H
#include "hash.h"
#include <iosfwd>
#include <list>
#include <utility>
//**************************************************************************
// CONSTANTS
//**************************************************************************
// hashes to use for validation
#define AUDIT_VALIDATE_FAST "R" /* CRC only */
#define AUDIT_VALIDATE_FULL "RS" /* CRC + SHA1 */
//**************************************************************************
// TYPE DEFINITIONS
//**************************************************************************
// forward declarations
class driver_enumerator;
// ======================> media_auditor
// class which manages auditing of items
class media_auditor
{
public:
enum class media_type
{
ROM = 0,
DISK,
SAMPLE
};
// status values
enum class audit_status
{
GOOD = 0,
FOUND_INVALID,
NOT_FOUND,
UNVERIFIED = 100
};
// substatus values
enum class audit_substatus
{
GOOD = 0,
GOOD_NEEDS_REDUMP,
FOUND_NODUMP,
FOUND_BAD_CHECKSUM,
FOUND_WRONG_LENGTH,
NOT_FOUND,
NOT_FOUND_NODUMP,
NOT_FOUND_OPTIONAL,
UNVERIFIED = 100
};
// summary values
enum summary
{
CORRECT = 0,
NONE_NEEDED,
BEST_AVAILABLE,
INCORRECT,
NOTFOUND
};
// holds the result of auditing a single item
class audit_record
{
public:
// media types
// construction/destruction
audit_record(const rom_entry &media, media_type type);
audit_record(const char *name, media_type type);
audit_record(const audit_record &) = default;
audit_record(audit_record &&) = default;
audit_record &operator=(const audit_record &) = default;
audit_record &operator=(audit_record &&) = default;
// getters
media_type type() const { return m_type; }
audit_status status() const { return m_status; }
audit_substatus substatus() const { return m_substatus; }
const char *name() const { return m_name; }
uint64_t expected_length() const { return m_explength; }
uint64_t actual_length() const { return m_length; }
const util::hash_collection &expected_hashes() const { return m_exphashes; }
const util::hash_collection &actual_hashes() const { return m_hashes; }
device_t *shared_device() const { return m_shared_device; }
// setters
void set_status(audit_status status, audit_substatus substatus)
{
m_status = status;
m_substatus = substatus;
}
void set_actual(const util::hash_collection &hashes, uint64_t length = 0)
{
m_hashes = hashes;
m_length = length;
}
void set_actual(util::hash_collection &&hashes, uint64_t length = 0)
{
m_hashes = std::move(hashes);
m_length = length;
}
void set_shared_device(device_t *shared_device)
{
m_shared_device = shared_device;
}
private:
// internal state
media_type m_type; // type of item that was audited
audit_status m_status; // status of audit on this item
audit_substatus m_substatus; // finer-detail status
const char * m_name; // name of item
uint64_t m_explength; // expected length of item
uint64_t m_length; // actual length of item
util::hash_collection m_exphashes; // expected hash data
util::hash_collection m_hashes; // actual hash information
device_t * m_shared_device; // device that shares the rom
};
using record_list = std::list<audit_record>;
// construction/destruction
media_auditor(const driver_enumerator &enumerator);
// getters
const record_list &records() const { return m_record_list; }
// audit operations
summary audit_media(const char *validation = AUDIT_VALIDATE_FULL);
summary audit_device(device_t &device, const char *validation = AUDIT_VALIDATE_FULL);
summary audit_software(const std::string &list_name, const software_info *swinfo, const char *validation = AUDIT_VALIDATE_FULL);
summary audit_samples();
summary summarize(const char *name, std::ostream *output = nullptr) const;
summary winui_summarize(const char *name, std::string *output = nullptr); //WINUI - only report problems that the user can fix
private:
// internal helpers
void audit_regions(const rom_entry *region, const char *locationtag, std::size_t &found, std::size_t &required);
audit_record &audit_one_rom(const rom_entry *rom);
audit_record &audit_one_disk(const rom_entry *rom, const char *locationtag);
void compute_status(audit_record &record, const rom_entry *rom, bool found);
device_t *find_shared_device(device_t &device, const char *name, const util::hash_collection &romhashes, uint64_t romlength);
// internal state
record_list m_record_list;
const driver_enumerator & m_enumerator;
const char * m_validation;
const char * m_searchpath;
};
#endif // MAME_FRONTEND_AUDIT_H
|