From 9b138e7afc434abb605a4af31b501b95158ee18e Mon Sep 17 00:00:00 2001 From: Natalia Portillo Date: Sun, 4 Jan 2026 16:05:30 +0000 Subject: [PATCH] Update doxygen documentation. --- docs/html/annotated.html | 77 +- docs/html/annotated_dup.js | 7 + docs/html/blocks_2dump_8c.html | 4 +- docs/html/blocks_2dump_8c_source.html | 36 +- docs/html/blocks_2metadata_8c.html | 12 +- docs/html/blocks_2metadata_8c_source.html | 74 +- docs/html/checksum_8c.html | 2 +- docs/html/checksum_8c_source.html | 34 +- docs/html/classes.html | 25 +- docs/html/close_8c.html | 461 +++++- docs/html/close_8c.js | 2 + docs/html/close_8c_source.html | 1386 ++++++++++------- docs/html/consts_8h.html | 4 +- docs/html/context_8h.html | 20 +- docs/html/context_8h.js | 1 + docs/html/context_8h_source.html | 902 +++++------ docs/html/crc64_8c.html | 22 +- docs/html/crc64_8c_source.html | 4 +- docs/html/crc64__clmul_8c_source.html | 4 +- docs/html/crc64__vmull_8c_source.html | 6 +- docs/html/create_8c.html | 4 +- docs/html/create_8c_source.html | 142 +- docs/html/cst_8c.html | 4 +- docs/html/cst_8c_source.html | 6 +- docs/html/data_8c.html | 2 +- docs/html/data_8c_source.html | 44 +- docs/html/ddt__v1_8c.html | 4 +- docs/html/ddt__v1_8c_source.html | 24 +- docs/html/ddt__v2_8c.html | 16 +- docs/html/ddt__v2_8c_source.html | 66 +- docs/html/decls_8h.html | 617 ++++++-- docs/html/decls_8h.js | 4 + docs/html/decls_8h_source.html | 517 +++--- .../dir_6387aeb6e475a334d8dc12d69f21999e.html | 2 + .../dir_6387aeb6e475a334d8dc12d69f21999e.js | 1 + .../dir_b2e0cd1ddd0a904cb261e9b68779deb4.html | 1 + .../dir_b2e0cd1ddd0a904cb261e9b68779deb4.js | 1 + docs/html/doxygen_crawl.html | 90 ++ docs/html/dump_8c.html | 4 +- docs/html/dump_8c_source.html | 44 +- docs/html/ecc__cd_8c.html | 24 +- docs/html/ecc__cd_8c_source.html | 26 +- docs/html/enums_8h.html | 31 +- docs/html/enums_8h.js | 8 +- docs/html/enums_8h_source.html | 334 ++-- docs/html/errors_8h.html | 94 +- docs/html/errors_8h.js | 1 + docs/html/errors_8h_source.html | 169 +- docs/html/files.html | 74 +- docs/html/flac_8c.html | 4 +- docs/html/flac_8c_source.html | 4 +- docs/html/flux_8c.html | 1253 +++++++++++++++ docs/html/flux_8c.js | 21 + docs/html/flux_8c_source.html | 1120 +++++++++++++ docs/html/flux_8h.html | 265 ++++ docs/html/flux_8h.js | 15 + docs/html/flux_8h_source.html | 248 +++ docs/html/functions_b.html | 2 +- docs/html/functions_c.html | 9 +- docs/html/functions_d.html | 6 +- docs/html/functions_e.html | 4 +- docs/html/functions_f.html | 4 + docs/html/functions_h.html | 3 +- docs/html/functions_i.html | 8 +- docs/html/functions_k.html | 2 +- docs/html/functions_l.html | 2 +- docs/html/functions_p.html | 1 + docs/html/functions_s.html | 1 + docs/html/functions_t.html | 1 + docs/html/functions_vars_b.html | 2 +- docs/html/functions_vars_c.html | 9 +- docs/html/functions_vars_d.html | 6 +- docs/html/functions_vars_e.html | 4 +- docs/html/functions_vars_f.html | 4 + docs/html/functions_vars_h.html | 3 +- docs/html/functions_vars_i.html | 8 +- docs/html/functions_vars_k.html | 2 +- docs/html/functions_vars_l.html | 2 +- docs/html/functions_vars_p.html | 1 + docs/html/functions_vars_s.html | 1 + docs/html/functions_vars_t.html | 1 + docs/html/globals_a.html | 5 + docs/html/globals_b.html | 1 + docs/html/globals_d.html | 2 + docs/html/globals_defs.html | 1 + docs/html/globals_e.html | 2 + docs/html/globals_eval_b.html | 1 + docs/html/globals_eval_d.html | 1 + docs/html/globals_eval_f.html | 2 + docs/html/globals_f.html | 14 + docs/html/globals_func_a.html | 4 + docs/html/globals_func_e.html | 2 + docs/html/globals_func_f.html | 5 + docs/html/globals_func_p.html | 1 + docs/html/globals_func_r.html | 3 + docs/html/globals_func_v.html | 1 + docs/html/globals_func_w.html | 2 + docs/html/globals_p.html | 1 + docs/html/globals_r.html | 3 + docs/html/globals_type.html | 11 + docs/html/globals_v.html | 1 + docs/html/globals_vars.html | 1 + docs/html/globals_w.html | 2 + docs/html/hash__map_8c.html | 2 +- docs/html/hash__map_8h.html | 2 +- docs/html/helpers_8c.html | 8 +- docs/html/helpers_8c_source.html | 12 +- docs/html/identify_8c.html | 4 +- docs/html/identify_8c_source.html | 4 +- docs/html/index__v1_8c.html | 4 +- docs/html/index__v1_8c_source.html | 10 +- docs/html/index__v2_8c.html | 4 +- docs/html/index__v2_8c_source.html | 10 +- docs/html/index__v3_8c.html | 6 +- docs/html/index__v3_8c_source.html | 10 +- docs/html/internal_8h.html | 236 ++- docs/html/internal_8h.js | 2 + docs/html/internal_8h_source.html | 52 +- docs/html/log_8h.html | 4 +- docs/html/lru_8c.html | 4 +- docs/html/lru_8c_source.html | 2 +- docs/html/lru_8h.html | 2 +- docs/html/lzma_8c.html | 8 +- docs/html/lzma_8c_source.html | 4 +- docs/html/md5_8c.html | 10 +- docs/html/md5_8c_source.html | 6 +- docs/html/menudata.js | 1 + docs/html/metadata_8c.html | 96 +- docs/html/metadata_8c_source.html | 72 +- docs/html/navtreedata.js | 16 +- docs/html/navtreeindex0.js | 260 ++-- docs/html/navtreeindex1.js | 90 +- docs/html/navtreeindex2.js | 80 +- docs/html/navtreeindex3.js | 80 +- docs/html/navtreeindex4.js | 80 +- docs/html/navtreeindex5.js | 192 +-- docs/html/navtreeindex6.js | 136 +- docs/html/navtreeindex7.js | 412 ++--- docs/html/navtreeindex8.js | 314 ++-- docs/html/open_8c.html | 4 +- docs/html/open_8c_source.html | 318 ++-- docs/html/optical_8c.html | 6 +- docs/html/optical_8c_source.html | 28 +- docs/html/read_8c.html | 10 +- docs/html/read_8c_source.html | 108 +- docs/html/search/all_1.js | 463 +++--- docs/html/search/all_10.js | 124 +- docs/html/search/all_12.js | 89 +- docs/html/search/all_13.js | 13 +- docs/html/search/all_14.js | 33 +- docs/html/search/all_16.js | 39 +- docs/html/search/all_17.js | 42 +- docs/html/search/all_2.js | 69 +- docs/html/search/all_3.js | 267 ++-- docs/html/search/all_4.js | 370 ++--- docs/html/search/all_5.js | 64 +- docs/html/search/all_6.js | 76 +- docs/html/search/all_8.js | 37 +- docs/html/search/all_9.js | 54 +- docs/html/search/all_b.js | 2 +- docs/html/search/all_c.js | 2 +- docs/html/search/classes_3.js | 13 +- docs/html/search/classes_4.js | 7 +- docs/html/search/classes_5.js | 2 +- docs/html/search/classes_6.js | 6 +- docs/html/search/classes_7.js | 6 +- docs/html/search/classes_8.js | 2 +- docs/html/search/classes_9.js | 4 +- docs/html/search/classes_a.js | 5 +- docs/html/search/classes_b.js | 3 +- docs/html/search/classes_c.js | 6 +- docs/html/search/classes_d.js | 14 +- docs/html/search/classes_e.js | 12 + docs/html/search/defines_0.js | 57 +- docs/html/search/enumvalues_1.js | 17 +- docs/html/search/enumvalues_3.js | 223 +-- docs/html/search/enumvalues_5.js | 6 +- docs/html/search/files_4.js | 4 +- docs/html/search/functions_1.js | 236 +-- docs/html/search/functions_10.js | 34 +- docs/html/search/functions_5.js | 6 +- docs/html/search/functions_6.js | 23 +- docs/html/search/functions_b.js | 23 +- docs/html/search/functions_c.js | 11 +- docs/html/search/functions_f.js | 7 +- docs/html/search/pages_1.js | 0 docs/html/search/pages_2.js | 0 docs/html/search/pages_3.js | 0 docs/html/search/pages_4.js | 0 docs/html/search/pages_5.js | 0 docs/html/search/pages_6.js | 0 docs/html/search/pages_7.js | 0 docs/html/search/searchdata.js | 4 +- docs/html/search/typedefs_3.js | 13 +- docs/html/search/typedefs_4.js | 7 +- docs/html/search/typedefs_5.js | 6 +- docs/html/search/typedefs_6.js | 7 +- docs/html/search/typedefs_7.js | 4 +- docs/html/search/typedefs_8.js | 3 +- docs/html/search/typedefs_9.js | 10 +- docs/html/search/typedefs_a.js | 12 + docs/html/search/variables_10.js | 11 +- docs/html/search/variables_12.js | 3 +- docs/html/search/variables_13.js | 7 +- docs/html/search/variables_16.js | 0 docs/html/search/variables_2.js | 2 +- docs/html/search/variables_3.js | 53 +- docs/html/search/variables_4.js | 102 +- docs/html/search/variables_5.js | 4 +- docs/html/search/variables_6.js | 7 +- docs/html/search/variables_8.js | 9 +- docs/html/search/variables_9.js | 18 +- docs/html/search/variables_b.js | 2 +- docs/html/search/variables_c.js | 2 +- docs/html/sha1_8c.html | 10 +- docs/html/sha1_8c_source.html | 6 +- docs/html/sha256_8c.html | 10 +- docs/html/sha256_8c_source.html | 6 +- docs/html/spamsum_8c.html | 16 +- docs/html/spamsum_8c_source.html | 6 +- docs/html/static__lru__hash__map_8c.js | 0 docs/html/static__lru__hash__map_8h.js | 0 docs/html/structAaruHeaderV2.html | 2 +- docs/html/structCdEccContext.html | 10 +- docs/html/structChecksums.html | 24 +- docs/html/structDataStreamPayloadHeader.html | 302 ++++ docs/html/structDataStreamPayloadHeader.js | 10 + docs/html/structDdtHeader2.html | 2 +- docs/html/structDumpExtent.html | 6 +- .../structDumpHardwareEntriesWithData.html | 40 +- docs/html/structDumpHardwareHeader.html | 2 +- docs/html/structFluxCaptureKey.html | 223 +++ docs/html/structFluxCaptureKey.js | 7 + docs/html/structFluxCaptureMapEntry.html | 187 +++ docs/html/structFluxCaptureMapEntry.js | 6 + docs/html/structFluxCaptureMeta.html | 267 ++++ docs/html/structFluxCaptureMeta.js | 9 + docs/html/structFluxCaptureRecord.html | 245 +++ docs/html/structFluxCaptureRecord.js | 8 + docs/html/structFluxEntry.html | 313 ++++ docs/html/structFluxEntry.js | 11 + docs/html/structFluxHeader.html | 226 +++ docs/html/structFluxHeader.js | 7 + docs/html/structImageInfo.html | 2 +- docs/html/structIndexEntry.html | 6 +- docs/html/structIndexHeader3.html | 8 +- docs/html/structTapeDdtHashEntry.html | 8 +- docs/html/structTapeFileHashEntry.html | 8 +- docs/html/structTapePartitionHashEntry.html | 8 +- docs/html/structaaruformat__context.html | 498 +++--- docs/html/structaaruformat__context.js | 5 + docs/html/structlru__kv__pair__t.js | 0 docs/html/structmediaTagEntry.html | 12 +- docs/html/structs_8h.html | 1 + docs/html/structs_8h_source.html | 14 +- docs/html/structstatic__lru__hash__map__t.js | 0 docs/html/tape_8c.html | 16 +- docs/html/tape_8c_source.html | 38 +- docs/html/verify_8c.html | 4 +- docs/html/verify_8c_source.html | 28 +- docs/html/write_8c.html | 12 +- docs/html/write_8c_source.html | 172 +- 262 files changed, 11691 insertions(+), 5095 deletions(-) create mode 100644 docs/html/flux_8c.html create mode 100644 docs/html/flux_8c.js create mode 100644 docs/html/flux_8c_source.html create mode 100644 docs/html/flux_8h.html create mode 100644 docs/html/flux_8h.js create mode 100644 docs/html/flux_8h_source.html mode change 100644 => 100755 docs/html/search/classes_d.js create mode 100644 docs/html/search/classes_e.js mode change 100644 => 100755 docs/html/search/pages_1.js mode change 100644 => 100755 docs/html/search/pages_2.js mode change 100644 => 100755 docs/html/search/pages_3.js mode change 100644 => 100755 docs/html/search/pages_4.js mode change 100644 => 100755 docs/html/search/pages_5.js mode change 100644 => 100755 docs/html/search/pages_6.js mode change 100644 => 100755 docs/html/search/pages_7.js create mode 100644 docs/html/search/typedefs_a.js mode change 100644 => 100755 docs/html/search/variables_16.js mode change 100644 => 100755 docs/html/static__lru__hash__map_8c.js mode change 100644 => 100755 docs/html/static__lru__hash__map_8h.js create mode 100644 docs/html/structDataStreamPayloadHeader.html create mode 100644 docs/html/structDataStreamPayloadHeader.js create mode 100644 docs/html/structFluxCaptureKey.html create mode 100644 docs/html/structFluxCaptureKey.js create mode 100644 docs/html/structFluxCaptureMapEntry.html create mode 100644 docs/html/structFluxCaptureMapEntry.js create mode 100644 docs/html/structFluxCaptureMeta.html create mode 100644 docs/html/structFluxCaptureMeta.js create mode 100644 docs/html/structFluxCaptureRecord.html create mode 100644 docs/html/structFluxCaptureRecord.js create mode 100644 docs/html/structFluxEntry.html create mode 100644 docs/html/structFluxEntry.js create mode 100644 docs/html/structFluxHeader.html create mode 100644 docs/html/structFluxHeader.js mode change 100644 => 100755 docs/html/structlru__kv__pair__t.js mode change 100644 => 100755 docs/html/structstatic__lru__hash__map__t.js diff --git a/docs/html/annotated.html b/docs/html/annotated.html index 2e42cb9..9f3edb4 100644 --- a/docs/html/annotated.html +++ b/docs/html/annotated.html @@ -110,41 +110,48 @@ $(function(){initNavTree('annotated.html','',''); });  CChecksumsCollected whole‑image checksums / hashes present in a checksum block  CCicmMetadataBlockHeader for a CICM XML metadata block (identifier == BlockType::CicmBlock)  Ccrc64_ctxMinimal ECMA-182 CRC64 incremental state container (running value only) - CDdtHeaderHeader preceding a version 1 (flat) deduplication table body - CDdtHeader2Header preceding a version 2 hierarchical deduplication table - CDumpExtentInclusive [start,end] logical sector range contributed by a single hardware environment - CDumpHardwareEntriesWithDataIn-memory representation of a dump hardware entry plus decoded variable-length fields & extents - CDumpHardwareEntryPer-environment length table describing subsequent UTF-8 strings and optional extent array - CDumpHardwareHeaderHeader that precedes a sequence of dump hardware entries and their variable-length payload - CGeometryBlockHeaderLegacy CHS style logical geometry metadata (BlockType::GeometryBlock) - Chash_map_tMinimal open-addressing hash map for 64-bit key/value pairs used in deduplication lookup - CImageInfoHigh-level summary of an opened Aaru image containing metadata and media characteristics - CIndexEntrySingle index entry describing a block's type, (optional) data classification, and file offset - CIndexHeaderIndex header (version 1) for legacy images (identifier == IndexBlock) - CIndexHeader2Index header (version 2) with 64‑bit entry counter (identifier == IndexBlock2) - CIndexHeader3Index header (version 3) adding hierarchical chaining (identifier == IndexBlock3) - Ckv_pair_tSingle key/value slot used internally by the open-addressing hash map - Clru_kv_pair_tSingle key/value slot with access tracking for the static LRU hash map - Cmd5_ctx - CmediaTagEntryHash table entry for an arbitrary media tag (e.g., proprietary drive/medium descriptor) - CMetadataBlockHeaderHeader for a metadata block containing offsets and lengths to UTF-16LE descriptive strings - Cpriam_tag - Cprofile_tag - Croll_state - Csha1_ctx - Csha256_ctx - Csony_tag - Cspamsum_ctx - Cstatic_lru_hash_map_tFixed-size hash map with LRU-like eviction for bounded memory usage - CTapeDdtHashEntry - CTapeFileEntryDescribes a single logical file on a tape medium - CTapeFileHashEntry - CTapeFileHeaderHeader for a tape file metadata block containing file layout information - CTapePartitionEntryDescribes a single physical partition on a tape medium - CTapePartitionHashEntry - CTapePartitionHeaderHeader for a tape partition metadata block containing partition layout information - CTrackEntrySingle optical disc track descriptor (sequence, type, LBAs, session, ISRC, flags) - CTracksHeaderHeader for an optical tracks block listing track entries + CDataStreamPayloadHeaderHeader structure for a DataStreamPayloadBlock containing data stream payload + CDdtHeaderHeader preceding a version 1 (flat) deduplication table body + CDdtHeader2Header preceding a version 2 hierarchical deduplication table + CDumpExtentInclusive [start,end] logical sector range contributed by a single hardware environment + CDumpHardwareEntriesWithDataIn-memory representation of a dump hardware entry plus decoded variable-length fields & extents + CDumpHardwareEntryPer-environment length table describing subsequent UTF-8 strings and optional extent array + CDumpHardwareHeaderHeader that precedes a sequence of dump hardware entries and their variable-length payload + CFluxCaptureKeyKey structure for flux capture lookup map + CFluxCaptureMapEntryInternal hash table entry for flux capture lookup + CFluxCaptureMetaMetadata structure returned by aaruf_get_flux_captures() + CFluxCaptureRecordInternal structure for storing flux capture data during write mode + CFluxEntryMetadata entry describing a single flux capture in the FluxDataBlock + CFluxHeaderHeader structure for a FluxDataBlock containing flux capture metadata + CGeometryBlockHeaderLegacy CHS style logical geometry metadata (BlockType::GeometryBlock) + Chash_map_tMinimal open-addressing hash map for 64-bit key/value pairs used in deduplication lookup + CImageInfoHigh-level summary of an opened Aaru image containing metadata and media characteristics + CIndexEntrySingle index entry describing a block's type, (optional) data classification, and file offset + CIndexHeaderIndex header (version 1) for legacy images (identifier == IndexBlock) + CIndexHeader2Index header (version 2) with 64‑bit entry counter (identifier == IndexBlock2) + CIndexHeader3Index header (version 3) adding hierarchical chaining (identifier == IndexBlock3) + Ckv_pair_tSingle key/value slot used internally by the open-addressing hash map + Clru_kv_pair_tSingle key/value slot with access tracking for the static LRU hash map + Cmd5_ctx + CmediaTagEntryHash table entry for an arbitrary media tag (e.g., proprietary drive/medium descriptor) + CMetadataBlockHeaderHeader for a metadata block containing offsets and lengths to UTF-16LE descriptive strings + Cpriam_tag + Cprofile_tag + Croll_state + Csha1_ctx + Csha256_ctx + Csony_tag + Cspamsum_ctx + Cstatic_lru_hash_map_tFixed-size hash map with LRU-like eviction for bounded memory usage + CTapeDdtHashEntry + CTapeFileEntryDescribes a single logical file on a tape medium + CTapeFileHashEntry + CTapeFileHeaderHeader for a tape file metadata block containing file layout information + CTapePartitionEntryDescribes a single physical partition on a tape medium + CTapePartitionHashEntry + CTapePartitionHeaderHeader for a tape partition metadata block containing partition layout information + CTrackEntrySingle optical disc track descriptor (sequence, type, LBAs, session, ISRC, flags) + CTracksHeaderHeader for an optical tracks block listing track entries diff --git a/docs/html/annotated_dup.js b/docs/html/annotated_dup.js index fb86f1b..e93e434 100755 --- a/docs/html/annotated_dup.js +++ b/docs/html/annotated_dup.js @@ -16,12 +16,19 @@ var annotated_dup = [ "Checksums", "structChecksums.html", "structChecksums" ], [ "CicmMetadataBlock", "structCicmMetadataBlock.html", "structCicmMetadataBlock" ], [ "crc64_ctx", "structcrc64__ctx.html", "structcrc64__ctx" ], + [ "DataStreamPayloadHeader", "structDataStreamPayloadHeader.html", "structDataStreamPayloadHeader" ], [ "DdtHeader", "structDdtHeader.html", "structDdtHeader" ], [ "DdtHeader2", "structDdtHeader2.html", "structDdtHeader2" ], [ "DumpExtent", "structDumpExtent.html", "structDumpExtent" ], [ "DumpHardwareEntriesWithData", "structDumpHardwareEntriesWithData.html", "structDumpHardwareEntriesWithData" ], [ "DumpHardwareEntry", "structDumpHardwareEntry.html", "structDumpHardwareEntry" ], [ "DumpHardwareHeader", "structDumpHardwareHeader.html", "structDumpHardwareHeader" ], + [ "FluxCaptureKey", "structFluxCaptureKey.html", "structFluxCaptureKey" ], + [ "FluxCaptureMapEntry", "structFluxCaptureMapEntry.html", "structFluxCaptureMapEntry" ], + [ "FluxCaptureMeta", "structFluxCaptureMeta.html", "structFluxCaptureMeta" ], + [ "FluxCaptureRecord", "structFluxCaptureRecord.html", "structFluxCaptureRecord" ], + [ "FluxEntry", "structFluxEntry.html", "structFluxEntry" ], + [ "FluxHeader", "structFluxHeader.html", "structFluxHeader" ], [ "GeometryBlockHeader", "structGeometryBlockHeader.html", "structGeometryBlockHeader" ], [ "hash_map_t", "structhash__map__t.html", "structhash__map__t" ], [ "ImageInfo", "structImageInfo.html", "structImageInfo" ], diff --git a/docs/html/blocks_2dump_8c.html b/docs/html/blocks_2dump_8c.html index f8bddfe..73465de 100644 --- a/docs/html/blocks_2dump_8c.html +++ b/docs/html/blocks_2dump_8c.html @@ -183,7 +183,7 @@ Functions

Definition at line 107 of file dump.c.

-

References aaruf_crc64_data(), AARUF_VERSION_V1, IndexEntry::blockType, bswap_64, compare_extents(), DumpHardwareHeader::crc64, aaruformat_context::dump_hardware_entries_with_data, aaruformat_context::dump_hardware_header, DumpHardwareBlock, DumpHardwareHeader::entries, DumpHardwareEntriesWithData::entry, DumpHardwareEntriesWithData::extents, DumpHardwareEntry::extents, FATAL, DumpHardwareEntriesWithData::firmware, DumpHardwareEntry::firmwareLength, free_dump_hardware_entries_array(), aaruformat_context::header, DumpHardwareHeader::identifier, AaruHeaderV2::imageMajorVersion, aaruformat_context::imageStream, DumpHardwareHeader::length, DumpHardwareEntriesWithData::manufacturer, DumpHardwareEntry::manufacturerLength, DumpHardwareEntriesWithData::model, DumpHardwareEntry::modelLength, IndexEntry::offset, read_dump_string(), reset_dump_hardware_context(), DumpHardwareEntriesWithData::revision, DumpHardwareEntry::revisionLength, DumpHardwareEntriesWithData::serial, DumpHardwareEntry::serialLength, DumpHardwareEntriesWithData::softwareName, DumpHardwareEntry::softwareNameLength, DumpHardwareEntriesWithData::softwareOperatingSystem, DumpHardwareEntry::softwareOperatingSystemLength, DumpHardwareEntriesWithData::softwareVersion, DumpHardwareEntry::softwareVersionLength, and TRACE.

+

References aaruf_crc64_data(), AARUF_VERSION_V1, IndexEntry::blockType, bswap_64, compare_extents(), DumpHardwareHeader::crc64, aaruformat_context::dump_hardware_entries_with_data, aaruformat_context::dump_hardware_header, DumpHardwareBlock, DumpHardwareHeader::entries, DumpHardwareEntriesWithData::entry, DumpHardwareEntriesWithData::extents, DumpHardwareEntry::extents, FATAL, DumpHardwareEntriesWithData::firmware, DumpHardwareEntry::firmwareLength, free_dump_hardware_entries_array(), aaruformat_context::header, DumpHardwareHeader::identifier, AaruHeaderV2::imageMajorVersion, aaruformat_context::imageStream, DumpHardwareHeader::length, DumpHardwareEntriesWithData::manufacturer, DumpHardwareEntry::manufacturerLength, DumpHardwareEntriesWithData::model, DumpHardwareEntry::modelLength, IndexEntry::offset, read_dump_string(), reset_dump_hardware_context(), DumpHardwareEntriesWithData::revision, DumpHardwareEntry::revisionLength, DumpHardwareEntriesWithData::serial, DumpHardwareEntry::serialLength, DumpHardwareEntriesWithData::softwareName, DumpHardwareEntry::softwareNameLength, DumpHardwareEntriesWithData::softwareOperatingSystem, DumpHardwareEntry::softwareOperatingSystemLength, DumpHardwareEntriesWithData::softwareVersion, DumpHardwareEntry::softwareVersionLength, and TRACE.

Referenced by aaruf_open().

@@ -264,7 +264,7 @@ Functions

Definition at line 54 of file dump.c.

-

References aaruformat_context::dump_hardware_entries_with_data, aaruformat_context::dump_hardware_header, DumpHardwareHeader::entries, and free_dump_hardware_entries_array().

+

References aaruformat_context::dump_hardware_entries_with_data, aaruformat_context::dump_hardware_header, DumpHardwareHeader::entries, and free_dump_hardware_entries_array().

Referenced by process_dumphw_block().

diff --git a/docs/html/blocks_2dump_8c_source.html b/docs/html/blocks_2dump_8c_source.html index 4e303e0..c3f573f 100644 --- a/docs/html/blocks_2dump_8c_source.html +++ b/docs/html/blocks_2dump_8c_source.html @@ -458,7 +458,7 @@ $(function(){initNavTree('blocks_2dump_8c_source.html','',''); });
endian.h
bswap_64
#define bswap_64(x)
Definition endian.h:81
enums.h
-
DumpHardwareBlock
@ DumpHardwareBlock
Block containing an array of hardware used to create the image.
Definition enums.h:158
+
DumpHardwareBlock
@ DumpHardwareBlock
Block containing an array of hardware used to create the image.
Definition enums.h:160
index.h
On‑disk index block header and entry structures (versions 1, 2 and 3).
internal.h
compare_extents
int compare_extents(const void *a, const void *b)
Comparison function for sorting DumpExtent arrays by start sector.
Definition helpers.c:463
@@ -466,18 +466,18 @@ $(function(){initNavTree('blocks_2dump_8c_source.html','',''); });
FATAL
#define FATAL(fmt,...)
Definition log.h:40
TRACE
#define TRACE(fmt,...)
Definition log.h:25
AaruHeaderV2::imageMajorVersion
uint8_t imageMajorVersion
Container format major version.
Definition header.h:110
-
DumpExtent
Inclusive [start,end] logical sector range contributed by a single hardware environment.
Definition context.h:359
-
DumpHardwareEntriesWithData
In-memory representation of a dump hardware entry plus decoded variable-length fields & extents.
Definition context.h:340
-
DumpHardwareEntriesWithData::firmware
uint8_t * firmware
Firmware version string or NULL.
Definition context.h:346
-
DumpHardwareEntriesWithData::revision
uint8_t * revision
Hardware revision string or NULL.
Definition context.h:345
-
DumpHardwareEntriesWithData::model
uint8_t * model
Model string or NULL.
Definition context.h:344
-
DumpHardwareEntriesWithData::softwareName
uint8_t * softwareName
Dump software name or NULL.
Definition context.h:348
-
DumpHardwareEntriesWithData::extents
struct DumpExtent * extents
Array of extents (entry.extents elements) or NULL.
Definition context.h:342
-
DumpHardwareEntriesWithData::manufacturer
uint8_t * manufacturer
Manufacturer string (UTF-8) or NULL.
Definition context.h:343
-
DumpHardwareEntriesWithData::softwareVersion
uint8_t * softwareVersion
Dump software version or NULL.
Definition context.h:349
-
DumpHardwareEntriesWithData::serial
uint8_t * serial
Serial number string or NULL.
Definition context.h:347
-
DumpHardwareEntriesWithData::entry
DumpHardwareEntry entry
Fixed-size header with lengths & counts.
Definition context.h:341
-
DumpHardwareEntriesWithData::softwareOperatingSystem
uint8_t * softwareOperatingSystem
Host operating system string or NULL.
Definition context.h:350
+
DumpExtent
Inclusive [start,end] logical sector range contributed by a single hardware environment.
Definition context.h:369
+
DumpHardwareEntriesWithData
In-memory representation of a dump hardware entry plus decoded variable-length fields & extents.
Definition context.h:350
+
DumpHardwareEntriesWithData::firmware
uint8_t * firmware
Firmware version string or NULL.
Definition context.h:356
+
DumpHardwareEntriesWithData::revision
uint8_t * revision
Hardware revision string or NULL.
Definition context.h:355
+
DumpHardwareEntriesWithData::model
uint8_t * model
Model string or NULL.
Definition context.h:354
+
DumpHardwareEntriesWithData::softwareName
uint8_t * softwareName
Dump software name or NULL.
Definition context.h:358
+
DumpHardwareEntriesWithData::extents
struct DumpExtent * extents
Array of extents (entry.extents elements) or NULL.
Definition context.h:352
+
DumpHardwareEntriesWithData::manufacturer
uint8_t * manufacturer
Manufacturer string (UTF-8) or NULL.
Definition context.h:353
+
DumpHardwareEntriesWithData::softwareVersion
uint8_t * softwareVersion
Dump software version or NULL.
Definition context.h:359
+
DumpHardwareEntriesWithData::serial
uint8_t * serial
Serial number string or NULL.
Definition context.h:357
+
DumpHardwareEntriesWithData::entry
DumpHardwareEntry entry
Fixed-size header with lengths & counts.
Definition context.h:351
+
DumpHardwareEntriesWithData::softwareOperatingSystem
uint8_t * softwareOperatingSystem
Host operating system string or NULL.
Definition context.h:360
DumpHardwareEntry
Per-environment length table describing subsequent UTF-8 strings and optional extent array.
Definition dump.h:113
DumpHardwareEntry::softwareNameLength
uint32_t softwareNameLength
Length in bytes of dumping software name string.
Definition dump.h:119
DumpHardwareEntry::manufacturerLength
uint32_t manufacturerLength
Length in bytes of manufacturer UTF-8 string.
Definition dump.h:114
@@ -496,11 +496,11 @@ $(function(){initNavTree('blocks_2dump_8c_source.html','',''); });
IndexEntry
Single index entry describing a block's type, (optional) data classification, and file offset.
Definition index.h:109
IndexEntry::blockType
uint32_t blockType
Block identifier of the referenced block (value from BlockType).
Definition index.h:110
IndexEntry::offset
uint64_t offset
Absolute byte offset in the image where the referenced block header begins.
Definition index.h:112
-
aaruformat_context
Master context representing an open or in‑creation Aaru image.
Definition context.h:172
-
aaruformat_context::header
AaruHeaderV2 header
Parsed container header (v2).
Definition context.h:175
-
aaruformat_context::dump_hardware_entries_with_data
struct DumpHardwareEntriesWithData * dump_hardware_entries_with_data
Array of dump hardware entries + strings.
Definition context.h:212
-
aaruformat_context::imageStream
FILE * imageStream
Underlying FILE* stream (binary mode).
Definition context.h:176
-
aaruformat_context::dump_hardware_header
DumpHardwareHeader dump_hardware_header
Dump hardware header.
Definition context.h:232
+
aaruformat_context
Master context representing an open or in‑creation Aaru image.
Definition context.h:175
+
aaruformat_context::header
AaruHeaderV2 header
Parsed container header (v2).
Definition context.h:178
+
aaruformat_context::dump_hardware_entries_with_data
struct DumpHardwareEntriesWithData * dump_hardware_entries_with_data
Array of dump hardware entries + strings.
Definition context.h:215
+
aaruformat_context::imageStream
FILE * imageStream
Underlying FILE* stream (binary mode).
Definition context.h:179
+
aaruformat_context::dump_hardware_header
DumpHardwareHeader dump_hardware_header
Dump hardware header.
Definition context.h:235
diff --git a/docs/html/blocks_2metadata_8c.html b/docs/html/blocks_2metadata_8c.html index 4ebed46..175d909 100644 --- a/docs/html/blocks_2metadata_8c.html +++ b/docs/html/blocks_2metadata_8c.html @@ -182,7 +182,7 @@ Query Mode: To query the required buffer size, pass buffer == NULL or *length &l

Definition at line 711 of file metadata.c.

-

References AARU_CALL, AARU_EXPORT, AARU_MAGIC, AARUF_ERROR_BUFFER_TOO_SMALL, AARUF_ERROR_NOT_AARUFORMAT, AARUF_STATUS_OK, FATAL, aaruformat_context::magic, MaxMediaTag, aaruformat_context::mediaTags, and TRACE.

+

References AARU_CALL, AARU_EXPORT, AARU_MAGIC, AARUF_ERROR_BUFFER_TOO_SMALL, AARUF_ERROR_NOT_AARUFORMAT, AARUF_STATUS_OK, FATAL, aaruformat_context::magic, MaxMediaTag, aaruformat_context::mediaTags, and TRACE.

@@ -278,7 +278,7 @@ If readableSectorTags is NULL in the context, AARUF_ERROR_NOT_FOUND is returned.

Definition at line 623 of file metadata.c.

-

References AARU_CALL, AARU_EXPORT, AARU_MAGIC, AARUF_ERROR_BUFFER_TOO_SMALL, AARUF_ERROR_METADATA_NOT_PRESENT, AARUF_ERROR_NOT_AARUFORMAT, AARUF_STATUS_OK, FATAL, aaruformat_context::magic, MaxSectorTag, aaruformat_context::readableSectorTags, and TRACE.

+

References AARU_CALL, AARU_EXPORT, AARU_MAGIC, AARUF_ERROR_BUFFER_TOO_SMALL, AARUF_ERROR_METADATA_NOT_PRESENT, AARUF_ERROR_NOT_AARUFORMAT, AARUF_STATUS_OK, FATAL, aaruformat_context::magic, MaxSectorTag, aaruformat_context::readableSectorTags, and TRACE.

@@ -374,7 +374,7 @@ This function does not validate JSON syntax or schema. Corrupted JSON data will

Definition at line 475 of file metadata.c.

-

References AaruMetadataJsonBlock, FATAL, AaruMetadataJsonBlockHeader::identifier, aaruformat_context::image_info, ImageInfo::ImageSize, aaruformat_context::imageStream, aaruformat_context::json_block, aaruformat_context::json_block_header, AaruMetadataJsonBlockHeader::length, IndexEntry::offset, and TRACE.

+

References AaruMetadataJsonBlock, FATAL, AaruMetadataJsonBlockHeader::identifier, aaruformat_context::image_info, ImageInfo::ImageSize, aaruformat_context::imageStream, aaruformat_context::json_block, aaruformat_context::json_block_header, AaruMetadataJsonBlockHeader::length, IndexEntry::offset, and TRACE.

Referenced by aaruf_open().

@@ -411,7 +411,7 @@ This function does not validate JSON syntax or schema. Corrupted JSON data will

Definition at line 311 of file metadata.c.

-

References aaruformat_context::cicm_block, aaruformat_context::cicm_block_header, CicmBlock, FATAL, CicmMetadataBlock::identifier, aaruformat_context::image_info, ImageInfo::ImageSize, aaruformat_context::imageStream, CicmMetadataBlock::length, IndexEntry::offset, and TRACE.

+

References aaruformat_context::cicm_block, aaruformat_context::cicm_block_header, CicmBlock, FATAL, CicmMetadataBlock::identifier, aaruformat_context::image_info, ImageInfo::ImageSize, aaruformat_context::imageStream, CicmMetadataBlock::length, IndexEntry::offset, and TRACE.

Referenced by aaruf_open().

@@ -448,7 +448,7 @@ This function does not validate JSON syntax or schema. Corrupted JSON data will

Definition at line 251 of file metadata.c.

-

References aaruformat_context::cylinders, GeometryBlockHeader::cylinders, FATAL, aaruformat_context::geometry_block, GeometryBlock, aaruformat_context::heads, GeometryBlockHeader::heads, GeometryBlockHeader::identifier, aaruformat_context::image_info, ImageInfo::ImageSize, aaruformat_context::imageStream, IndexEntry::offset, aaruformat_context::sectors_per_track, GeometryBlockHeader::sectorsPerTrack, and TRACE.

+

References aaruformat_context::cylinders, GeometryBlockHeader::cylinders, FATAL, aaruformat_context::geometry_block, GeometryBlock, aaruformat_context::heads, GeometryBlockHeader::heads, GeometryBlockHeader::identifier, aaruformat_context::image_info, ImageInfo::ImageSize, aaruformat_context::imageStream, IndexEntry::offset, aaruformat_context::sectors_per_track, GeometryBlockHeader::sectorsPerTrack, and TRACE.

Referenced by aaruf_open().

@@ -485,7 +485,7 @@ This function does not validate JSON syntax or schema. Corrupted JSON data will

Definition at line 35 of file metadata.c.

-

References MetadataBlockHeader::blockSize, IndexEntry::blockType, aaruformat_context::comments, MetadataBlockHeader::commentsLength, MetadataBlockHeader::commentsOffset, aaruformat_context::creator, MetadataBlockHeader::creatorLength, MetadataBlockHeader::creatorOffset, aaruformat_context::drive_firmware_revision, aaruformat_context::drive_manufacturer, aaruformat_context::drive_model, aaruformat_context::drive_serial_number, MetadataBlockHeader::driveFirmwareRevisionLength, MetadataBlockHeader::driveFirmwareRevisionOffset, MetadataBlockHeader::driveManufacturerLength, MetadataBlockHeader::driveManufacturerOffset, MetadataBlockHeader::driveModelLength, MetadataBlockHeader::driveModelOffset, MetadataBlockHeader::driveSerialNumberLength, MetadataBlockHeader::driveSerialNumberOffset, FATAL, MetadataBlockHeader::identifier, aaruformat_context::image_info, ImageInfo::ImageSize, aaruformat_context::imageStream, aaruformat_context::last_media_sequence, MetadataBlockHeader::lastMediaSequence, aaruformat_context::media_barcode, aaruformat_context::media_manufacturer, aaruformat_context::media_model, aaruformat_context::media_part_number, aaruformat_context::media_sequence, aaruformat_context::media_serial_number, aaruformat_context::media_title, MetadataBlockHeader::mediaBarcodeLength, MetadataBlockHeader::mediaBarcodeOffset, MetadataBlockHeader::mediaManufacturerLength, MetadataBlockHeader::mediaManufacturerOffset, MetadataBlockHeader::mediaModelLength, MetadataBlockHeader::mediaModelOffset, MetadataBlockHeader::mediaPartNumberLength, MetadataBlockHeader::mediaPartNumberOffset, MetadataBlockHeader::mediaSequence, MetadataBlockHeader::mediaSerialNumberLength, MetadataBlockHeader::mediaSerialNumberOffset, MetadataBlockHeader::mediaTitleLength, MetadataBlockHeader::mediaTitleOffset, aaruformat_context::metadata_block, aaruformat_context::metadata_block_header, IndexEntry::offset, and TRACE.

+

References MetadataBlockHeader::blockSize, IndexEntry::blockType, aaruformat_context::comments, MetadataBlockHeader::commentsLength, MetadataBlockHeader::commentsOffset, aaruformat_context::creator, MetadataBlockHeader::creatorLength, MetadataBlockHeader::creatorOffset, aaruformat_context::drive_firmware_revision, aaruformat_context::drive_manufacturer, aaruformat_context::drive_model, aaruformat_context::drive_serial_number, MetadataBlockHeader::driveFirmwareRevisionLength, MetadataBlockHeader::driveFirmwareRevisionOffset, MetadataBlockHeader::driveManufacturerLength, MetadataBlockHeader::driveManufacturerOffset, MetadataBlockHeader::driveModelLength, MetadataBlockHeader::driveModelOffset, MetadataBlockHeader::driveSerialNumberLength, MetadataBlockHeader::driveSerialNumberOffset, FATAL, MetadataBlockHeader::identifier, aaruformat_context::image_info, ImageInfo::ImageSize, aaruformat_context::imageStream, aaruformat_context::last_media_sequence, MetadataBlockHeader::lastMediaSequence, aaruformat_context::media_barcode, aaruformat_context::media_manufacturer, aaruformat_context::media_model, aaruformat_context::media_part_number, aaruformat_context::media_sequence, aaruformat_context::media_serial_number, aaruformat_context::media_title, MetadataBlockHeader::mediaBarcodeLength, MetadataBlockHeader::mediaBarcodeOffset, MetadataBlockHeader::mediaManufacturerLength, MetadataBlockHeader::mediaManufacturerOffset, MetadataBlockHeader::mediaModelLength, MetadataBlockHeader::mediaModelOffset, MetadataBlockHeader::mediaPartNumberLength, MetadataBlockHeader::mediaPartNumberOffset, MetadataBlockHeader::mediaSequence, MetadataBlockHeader::mediaSerialNumberLength, MetadataBlockHeader::mediaSerialNumberOffset, MetadataBlockHeader::mediaTitleLength, MetadataBlockHeader::mediaTitleOffset, aaruformat_context::metadata_block, aaruformat_context::metadata_block_header, IndexEntry::offset, and TRACE.

Referenced by aaruf_open().

diff --git a/docs/html/blocks_2metadata_8c_source.html b/docs/html/blocks_2metadata_8c_source.html index c605900..84a5f88 100644 --- a/docs/html/blocks_2metadata_8c_source.html +++ b/docs/html/blocks_2metadata_8c_source.html @@ -649,12 +649,12 @@ $(function(){initNavTree('blocks_2metadata_8c_source.html','',''); });
aaruf_get_readable_media_tags
int32_t aaruf_get_readable_media_tags(const void *context, uint8_t *buffer, size_t *length)
Retrieves which media tags are present in the AaruFormat image.
Definition metadata.c:711
aaruf_get_readable_sector_tags
int32_t aaruf_get_readable_sector_tags(const void *context, uint8_t *buffer, size_t *length)
Retrieves which sector tags are readable in the AaruFormat image.
Definition metadata.c:623
AARU_MAGIC
#define AARU_MAGIC
Magic identifier for AaruFormat container (ASCII "AARUFRMT").
Definition consts.h:64
-
AARU_CALL
#define AARU_CALL
Definition decls.h:45
-
AARU_EXPORT
#define AARU_EXPORT
Definition decls.h:54
-
GeometryBlock
@ GeometryBlock
Block containing logical geometry.
Definition enums.h:150
-
AaruMetadataJsonBlock
@ AaruMetadataJsonBlock
Block containing JSON version of Aaru Metadata.
Definition enums.h:161
-
CicmBlock
@ CicmBlock
Block containing CICM XML metadata.
Definition enums.h:153
-
AARUF_STATUS_OK
#define AARUF_STATUS_OK
Sector present and read without uncorrectable errors.
Definition errors.h:76
+
AARU_CALL
#define AARU_CALL
Definition decls.h:46
+
AARU_EXPORT
#define AARU_EXPORT
Definition decls.h:55
+
GeometryBlock
@ GeometryBlock
Block containing logical geometry.
Definition enums.h:152
+
AaruMetadataJsonBlock
@ AaruMetadataJsonBlock
Block containing JSON version of Aaru Metadata.
Definition enums.h:163
+
CicmBlock
@ CicmBlock
Block containing CICM XML metadata.
Definition enums.h:155
+
AARUF_STATUS_OK
#define AARUF_STATUS_OK
Sector present and read without uncorrectable errors.
Definition errors.h:77
AARUF_ERROR_METADATA_NOT_PRESENT
#define AARUF_ERROR_METADATA_NOT_PRESENT
Requested metadata not present in image.
Definition errors.h:69
AARUF_ERROR_NOT_AARUFORMAT
#define AARUF_ERROR_NOT_AARUFORMAT
Input file/stream failed magic or structural validation.
Definition errors.h:40
AARUF_ERROR_BUFFER_TOO_SMALL
#define AARUF_ERROR_BUFFER_TOO_SMALL
Caller-supplied buffer insufficient for data.
Definition errors.h:49
@@ -707,37 +707,37 @@ $(function(){initNavTree('blocks_2metadata_8c_source.html','',''); });
MetadataBlockHeader::creatorLength
uint32_t creatorLength
Length in bytes (including null) of creator string (0 if absent).
Definition metadata.h:76
MetadataBlockHeader::driveFirmwareRevisionLength
uint32_t driveFirmwareRevisionLength
Length in bytes (including null) of drive firmware revision string.
Definition metadata.h:98
MetadataBlockHeader::mediaBarcodeOffset
uint32_t mediaBarcodeOffset
Offset to UTF-16LE media barcode string.
Definition metadata.h:87
-
aaruformat_context
Master context representing an open or in‑creation Aaru image.
Definition context.h:172
-
aaruformat_context::media_barcode
uint8_t * media_barcode
Barcode of the media represented by the image.
Definition context.h:222
-
aaruformat_context::creator
uint8_t * creator
Who (person) created the image?
Definition context.h:216
-
aaruformat_context::cicm_block
uint8_t * cicm_block
CICM XML payload.
Definition context.h:214
-
aaruformat_context::cylinders
uint32_t cylinders
Cylinders of the media represented by the image.
Definition context.h:234
-
aaruformat_context::drive_firmware_revision
uint8_t * drive_firmware_revision
Firmware revision of the drive used to read the media represented by the image.
Definition context.h:228
-
aaruformat_context::media_serial_number
uint8_t * media_serial_number
Serial number of the media represented by the image.
Definition context.h:221
-
aaruformat_context::metadata_block_header
MetadataBlockHeader metadata_block_header
Metadata block header.
Definition context.h:230
-
aaruformat_context::media_sequence
int32_t media_sequence
Number in sequence for the media represented by the image.
Definition context.h:238
-
aaruformat_context::media_model
uint8_t * media_model
Model of the media represented by the image.
Definition context.h:220
-
aaruformat_context::drive_serial_number
uint8_t * drive_serial_number
Serial number of the drive used to read the media represented by the image.
Definition context.h:226
-
aaruformat_context::drive_manufacturer
uint8_t * drive_manufacturer
Manufacturer of the drive used to read the media represented by the image.
Definition context.h:224
-
aaruformat_context::cicm_block_header
CicmMetadataBlock cicm_block_header
CICM metadata header (if present).
Definition context.h:231
-
aaruformat_context::drive_model
uint8_t * drive_model
Model of the drive used to read the media represented by the image.
Definition context.h:225
-
aaruformat_context::magic
uint64_t magic
File magic (AARU_MAGIC) post-open.
Definition context.h:174
-
aaruformat_context::mediaTags
mediaTagEntry * mediaTags
Hash table of extra media tags (uthash root).
Definition context.h:264
-
aaruformat_context::geometry_block
GeometryBlockHeader geometry_block
Logical geometry block (if present).
Definition context.h:229
-
aaruformat_context::json_block
uint8_t * json_block
JSON metadata block payload (UTF-8).
Definition context.h:215
-
aaruformat_context::media_part_number
uint8_t * media_part_number
Part number of the media represented by the image.
Definition context.h:223
-
aaruformat_context::json_block_header
AaruMetadataJsonBlockHeader json_block_header
JSON metadata block header (if present).
Definition context.h:233
-
aaruformat_context::sectors_per_track
uint32_t sectors_per_track
Sectors per track of the media represented by the image (for variable image, the smallest).
Definition context.h:236
-
aaruformat_context::comments
uint8_t * comments
Image comments.
Definition context.h:218
-
aaruformat_context::heads
uint32_t heads
Heads of the media represented by the image.
Definition context.h:235
-
aaruformat_context::imageStream
FILE * imageStream
Underlying FILE* stream (binary mode).
Definition context.h:176
-
aaruformat_context::image_info
ImageInfo image_info
Exposed high-level image info summary.
Definition context.h:260
-
aaruformat_context::readableSectorTags
bool * readableSectorTags
Per-sector boolean array (optical tags read successfully?).
Definition context.h:263
-
aaruformat_context::metadata_block
uint8_t * metadata_block
Raw metadata UTF-16LE concatenated strings.
Definition context.h:213
-
aaruformat_context::media_title
uint8_t * media_title
Title of the media represented by the image.
Definition context.h:217
-
aaruformat_context::last_media_sequence
int32_t last_media_sequence
Last media of the sequence the media represented by the image corresponds to.
Definition context.h:239
-
aaruformat_context::media_manufacturer
uint8_t * media_manufacturer
Manufacturer of the media represented by the image.
Definition context.h:219
-
mediaTagEntry
Hash table entry for an arbitrary media tag (e.g., proprietary drive/medium descriptor).
Definition context.h:119
+
aaruformat_context
Master context representing an open or in‑creation Aaru image.
Definition context.h:175
+
aaruformat_context::media_barcode
uint8_t * media_barcode
Barcode of the media represented by the image.
Definition context.h:225
+
aaruformat_context::creator
uint8_t * creator
Who (person) created the image?
Definition context.h:219
+
aaruformat_context::cicm_block
uint8_t * cicm_block
CICM XML payload.
Definition context.h:217
+
aaruformat_context::cylinders
uint32_t cylinders
Cylinders of the media represented by the image.
Definition context.h:237
+
aaruformat_context::drive_firmware_revision
uint8_t * drive_firmware_revision
Firmware revision of the drive used to read the media represented by the image.
Definition context.h:231
+
aaruformat_context::media_serial_number
uint8_t * media_serial_number
Serial number of the media represented by the image.
Definition context.h:224
+
aaruformat_context::metadata_block_header
MetadataBlockHeader metadata_block_header
Metadata block header.
Definition context.h:233
+
aaruformat_context::media_sequence
int32_t media_sequence
Number in sequence for the media represented by the image.
Definition context.h:241
+
aaruformat_context::media_model
uint8_t * media_model
Model of the media represented by the image.
Definition context.h:223
+
aaruformat_context::drive_serial_number
uint8_t * drive_serial_number
Serial number of the drive used to read the media represented by the image.
Definition context.h:229
+
aaruformat_context::drive_manufacturer
uint8_t * drive_manufacturer
Manufacturer of the drive used to read the media represented by the image.
Definition context.h:227
+
aaruformat_context::cicm_block_header
CicmMetadataBlock cicm_block_header
CICM metadata header (if present).
Definition context.h:234
+
aaruformat_context::drive_model
uint8_t * drive_model
Model of the drive used to read the media represented by the image.
Definition context.h:228
+
aaruformat_context::magic
uint64_t magic
File magic (AARU_MAGIC) post-open.
Definition context.h:177
+
aaruformat_context::mediaTags
mediaTagEntry * mediaTags
Hash table of extra media tags (uthash root).
Definition context.h:267
+
aaruformat_context::geometry_block
GeometryBlockHeader geometry_block
Logical geometry block (if present).
Definition context.h:232
+
aaruformat_context::json_block
uint8_t * json_block
JSON metadata block payload (UTF-8).
Definition context.h:218
+
aaruformat_context::media_part_number
uint8_t * media_part_number
Part number of the media represented by the image.
Definition context.h:226
+
aaruformat_context::json_block_header
AaruMetadataJsonBlockHeader json_block_header
JSON metadata block header (if present).
Definition context.h:236
+
aaruformat_context::sectors_per_track
uint32_t sectors_per_track
Sectors per track of the media represented by the image (for variable image, the smallest).
Definition context.h:239
+
aaruformat_context::comments
uint8_t * comments
Image comments.
Definition context.h:221
+
aaruformat_context::heads
uint32_t heads
Heads of the media represented by the image.
Definition context.h:238
+
aaruformat_context::imageStream
FILE * imageStream
Underlying FILE* stream (binary mode).
Definition context.h:179
+
aaruformat_context::image_info
ImageInfo image_info
Exposed high-level image info summary.
Definition context.h:263
+
aaruformat_context::readableSectorTags
bool * readableSectorTags
Per-sector boolean array (optical tags read successfully?).
Definition context.h:266
+
aaruformat_context::metadata_block
uint8_t * metadata_block
Raw metadata UTF-16LE concatenated strings.
Definition context.h:216
+
aaruformat_context::media_title
uint8_t * media_title
Title of the media represented by the image.
Definition context.h:220
+
aaruformat_context::last_media_sequence
int32_t last_media_sequence
Last media of the sequence the media represented by the image corresponds to.
Definition context.h:242
+
aaruformat_context::media_manufacturer
uint8_t * media_manufacturer
Manufacturer of the media represented by the image.
Definition context.h:222
+
mediaTagEntry
Hash table entry for an arbitrary media tag (e.g., proprietary drive/medium descriptor).
Definition context.h:122
diff --git a/docs/html/checksum_8c.html b/docs/html/checksum_8c.html index c6e7d2a..040c11e 100644 --- a/docs/html/checksum_8c.html +++ b/docs/html/checksum_8c.html @@ -142,7 +142,7 @@ Functions

Definition at line 39 of file checksum.c.

-

References ChecksumBlock, aaruformat_context::checksums, ChecksumHeader::entries, FATAL, Checksums::hasMd5, Checksums::hasSha1, Checksums::hasSha256, Checksums::hasSpamSum, ChecksumHeader::identifier, aaruformat_context::imageStream, ChecksumEntry::length, ChecksumHeader::length, Md5, Checksums::md5, MD5_DIGEST_LENGTH, IndexEntry::offset, Sha1, Checksums::sha1, SHA1_DIGEST_LENGTH, Sha256, Checksums::sha256, SHA256_DIGEST_LENGTH, SpamSum, Checksums::spamsum, TRACE, and ChecksumEntry::type.

+

References ChecksumBlock, aaruformat_context::checksums, ChecksumHeader::entries, FATAL, Checksums::hasMd5, Checksums::hasSha1, Checksums::hasSha256, Checksums::hasSpamSum, ChecksumHeader::identifier, aaruformat_context::imageStream, ChecksumEntry::length, ChecksumHeader::length, Md5, Checksums::md5, MD5_DIGEST_LENGTH, IndexEntry::offset, Sha1, Checksums::sha1, SHA1_DIGEST_LENGTH, Sha256, Checksums::sha256, SHA256_DIGEST_LENGTH, SpamSum, Checksums::spamsum, TRACE, and ChecksumEntry::type.

Referenced by aaruf_open().

diff --git a/docs/html/checksum_8c_source.html b/docs/html/checksum_8c_source.html index 40e1566..4d67169 100644 --- a/docs/html/checksum_8c_source.html +++ b/docs/html/checksum_8c_source.html @@ -278,13 +278,13 @@ $(function(){initNavTree('checksum_8c_source.html','',''); });
process_checksum_block
void process_checksum_block(aaruformat_context *ctx, const IndexEntry *entry)
Processes a checksum block from the image stream.
Definition checksum.c:39
checksum.h
On-disk layout definitions for the checksum block (BlockType::ChecksumBlock).
context.h
Central runtime context structures for libaaruformat (image state, caches, checksum buffers).
-
MD5_DIGEST_LENGTH
#define MD5_DIGEST_LENGTH
Definition context.h:69
+
MD5_DIGEST_LENGTH
#define MD5_DIGEST_LENGTH
Definition context.h:72
enums.h
-
ChecksumBlock
@ ChecksumBlock
Block containing contents checksums.
Definition enums.h:154
-
Sha1
@ Sha1
SHA-1 hash.
Definition enums.h:172
-
Md5
@ Md5
MD5 hash.
Definition enums.h:171
-
Sha256
@ Sha256
SHA-256 hash.
Definition enums.h:173
-
SpamSum
@ SpamSum
SpamSum (context-triggered piecewise hash).
Definition enums.h:174
+
ChecksumBlock
@ ChecksumBlock
Block containing contents checksums.
Definition enums.h:156
+
Sha1
@ Sha1
SHA-1 hash.
Definition enums.h:176
+
Md5
@ Md5
MD5 hash.
Definition enums.h:175
+
Sha256
@ Sha256
SHA-256 hash.
Definition enums.h:177
+
SpamSum
@ SpamSum
SpamSum (context-triggered piecewise hash).
Definition enums.h:178
index.h
On‑disk index block header and entry structures (versions 1, 2 and 3).
log.h
FATAL
#define FATAL(fmt,...)
Definition log.h:40
@@ -298,19 +298,19 @@ $(function(){initNavTree('checksum_8c_source.html','',''); });
ChecksumHeader::identifier
uint32_t identifier
Block identifier, must be BlockType::ChecksumBlock.
Definition checksum.h:75
ChecksumHeader::length
uint32_t length
Length in bytes of the payload (all entries + their digest data, excluding this header).
Definition checksum.h:76
ChecksumHeader::entries
uint8_t entries
Number of checksum entries that follow in the payload.
Definition checksum.h:77
-
Checksums::spamsum
uint8_t * spamsum
SpamSum fuzzy hash (ASCII), allocated length+1 with trailing 0.
Definition context.h:110
-
Checksums::hasSha256
bool hasSha256
True if sha256[] buffer populated.
Definition context.h:103
-
Checksums::sha1
uint8_t sha1[20]
SHA-1 digest (20 bytes).
Definition context.h:107
-
Checksums::sha256
uint8_t sha256[32]
SHA-256 digest (32 bytes).
Definition context.h:108
-
Checksums::md5
uint8_t md5[16]
MD5 digest (16 bytes).
Definition context.h:106
-
Checksums::hasSpamSum
bool hasSpamSum
True if spamsum pointer allocated and signature read.
Definition context.h:105
-
Checksums::hasSha1
bool hasSha1
True if sha1[] buffer populated.
Definition context.h:102
-
Checksums::hasMd5
bool hasMd5
True if md5[] buffer populated.
Definition context.h:101
+
Checksums::spamsum
uint8_t * spamsum
SpamSum fuzzy hash (ASCII), allocated length+1 with trailing 0.
Definition context.h:113
+
Checksums::hasSha256
bool hasSha256
True if sha256[] buffer populated.
Definition context.h:106
+
Checksums::sha1
uint8_t sha1[20]
SHA-1 digest (20 bytes).
Definition context.h:110
+
Checksums::sha256
uint8_t sha256[32]
SHA-256 digest (32 bytes).
Definition context.h:111
+
Checksums::md5
uint8_t md5[16]
MD5 digest (16 bytes).
Definition context.h:109
+
Checksums::hasSpamSum
bool hasSpamSum
True if spamsum pointer allocated and signature read.
Definition context.h:108
+
Checksums::hasSha1
bool hasSha1
True if sha1[] buffer populated.
Definition context.h:105
+
Checksums::hasMd5
bool hasMd5
True if md5[] buffer populated.
Definition context.h:104
IndexEntry
Single index entry describing a block's type, (optional) data classification, and file offset.
Definition index.h:109
IndexEntry::offset
uint64_t offset
Absolute byte offset in the image where the referenced block header begins.
Definition index.h:112
-
aaruformat_context
Master context representing an open or in‑creation Aaru image.
Definition context.h:172
-
aaruformat_context::checksums
Checksums checksums
Whole-image checksums discovered.
Definition context.h:269
-
aaruformat_context::imageStream
FILE * imageStream
Underlying FILE* stream (binary mode).
Definition context.h:176
+
aaruformat_context
Master context representing an open or in‑creation Aaru image.
Definition context.h:175
+
aaruformat_context::checksums
Checksums checksums
Whole-image checksums discovered.
Definition context.h:272
+
aaruformat_context::imageStream
FILE * imageStream
Underlying FILE* stream (binary mode).
Definition context.h:179
diff --git a/docs/html/classes.html b/docs/html/classes.html index 5d57f63..eb77d31 100644 --- a/docs/html/classes.html +++ b/docs/html/classes.html @@ -92,7 +92,7 @@ $(function(){initNavTree('classes.html','',''); });
Data Structure Index
-
A | B | C | D | G | H | I | K | L | M | P | R | S | T
+
A | B | C | D | F | G | H | I | K | L | M | P | R | S | T
A
@@ -105,35 +105,38 @@ $(function(){initNavTree('classes.html','',''); });
CacheEntry
CacheHeader
CdEccContext
ChecksumEntry
ChecksumHeader
Checksums
CicmMetadataBlock
crc64_ctx
D
-
DdtHeader
DdtHeader2
DumpExtent
DumpHardwareEntriesWithData
DumpHardwareEntry
DumpHardwareHeader
+
DataStreamPayloadHeader
DdtHeader
DdtHeader2
DumpExtent
DumpHardwareEntriesWithData
DumpHardwareEntry
DumpHardwareHeader
+
F
+
FluxCaptureKey
FluxCaptureMapEntry
FluxCaptureMeta
FluxCaptureRecord
FluxEntry
FluxHeader
+
G
GeometryBlockHeader
-
+
H
hash_map_t
-
+
I
ImageInfo
IndexEntry
IndexHeader
IndexHeader2
IndexHeader3
-
+
K
kv_pair_t
-
+
L
lru_kv_pair_t
-
+
M
md5_ctx
mediaTagEntry
MetadataBlockHeader
-
+
P
priam_tag
profile_tag
-
+
R
roll_state
-
+
S
sha1_ctx
sha256_ctx
sony_tag
spamsum_ctx
static_lru_hash_map_t
-
+
T
TapeDdtHashEntry
TapeFileEntry
TapeFileHashEntry
TapeFileHeader
TapePartitionEntry
TapePartitionHashEntry
TapePartitionHeader
TrackEntry
TracksHeader
diff --git a/docs/html/close_8c.html b/docs/html/close_8c.html index eb90051..5681550 100644 --- a/docs/html/close_8c.html +++ b/docs/html/close_8c.html @@ -150,6 +150,10 @@ Functions  Serialize the CICM XML metadata block to the image file.
static void write_aaru_json_block (aaruformat_context *ctx)  Serialize the Aaru metadata JSON block to the image file.
+static int32_t write_flux_capture_payload (aaruformat_context *ctx, FluxCaptureRecord *record, FluxEntry *entry) + Serialize a single flux capture payload block to the image file.
+static int32_t write_flux_blocks (aaruformat_context *ctx) + Serialize all accumulated flux capture blocks to the image file.
static int32_t write_index_block (aaruformat_context *ctx)  Serialize the accumulated index entries at the end of the image and back-patch the header.
int aaruf_close (void *context) @@ -212,9 +216,9 @@ Functions
Note
On success the context memory itself is freed; the caller must not reuse the pointer.
-

Definition at line 4340 of file close.c.

+

Definition at line 5011 of file close.c.

-

References AARU_CALL, AARU_EXPORT, AARU_MAGIC, aaruf_close_current_block(), aaruf_ecc_cd_free(), AARUF_ERROR_CANNOT_WRITE_HEADER, AARUF_STATUS_OK, aaruformat_context::block_cache, aaruformat_context::block_header_cache, aaruformat_context::cached_secondary_ddt2, aaruformat_context::checksums, aaruformat_context::cicm_block, mediaTagEntry::data, aaruformat_context::data_tracks, aaruformat_context::deduplicate, aaruformat_context::dirty_checksum_block, aaruformat_context::dirty_cicm_block, aaruformat_context::dirty_dumphw_block, aaruformat_context::dirty_dvd_long_sector_blocks, aaruformat_context::dirty_dvd_title_key_decrypted_block, aaruformat_context::dirty_geometry_block, aaruformat_context::dirty_index_block, aaruformat_context::dirty_json_block, aaruformat_context::dirty_media_tags, aaruformat_context::dirty_metadata_block, aaruformat_context::dirty_mode2_subheaders_block, aaruformat_context::dirty_primary_ddt, aaruformat_context::dirty_secondary_ddt, aaruformat_context::dirty_sector_prefix_block, aaruformat_context::dirty_sector_prefix_ddt, aaruformat_context::dirty_sector_subchannel_block, aaruformat_context::dirty_sector_suffix_block, aaruformat_context::dirty_sector_suffix_ddt, aaruformat_context::dirty_single_level_ddt, aaruformat_context::dirty_tape_ddt, aaruformat_context::dirty_tape_file_block, aaruformat_context::dirty_tape_partition_block, aaruformat_context::dirty_tracks_block, aaruformat_context::dump_hardware_entries_with_data, aaruformat_context::dump_hardware_header, aaruformat_context::ecc_cd_context, DumpHardwareHeader::entries, DumpHardwareEntriesWithData::extents, FATAL, DumpHardwareEntriesWithData::firmware, free_cache(), free_map(), aaruformat_context::header, aaruformat_context::imageStream, aaruformat_context::in_memory_ddt, aaruformat_context::index_entries, aaruformat_context::is_tape, aaruformat_context::is_writing, aaruformat_context::magic, DumpHardwareEntriesWithData::manufacturer, aaruformat_context::mapped_memory_ddt_size, aaruformat_context::mediaTags, aaruformat_context::metadata_block, aaruformat_context::mode2_subheaders, DumpHardwareEntriesWithData::model, aaruformat_context::readableSectorTags, DumpHardwareEntriesWithData::revision, aaruformat_context::sector_cpr_mai, aaruformat_context::sector_edc, aaruformat_context::sector_hash_map, aaruformat_context::sector_id, aaruformat_context::sector_ied, aaruformat_context::sector_prefix, aaruformat_context::sector_prefix_corrected, aaruformat_context::sector_prefix_ddt, aaruformat_context::sector_prefix_ddt2, aaruformat_context::sector_subchannel, aaruformat_context::sector_suffix, aaruformat_context::sector_suffix_corrected, aaruformat_context::sector_suffix_ddt, aaruformat_context::sector_suffix_ddt2, DumpHardwareEntriesWithData::serial, DumpHardwareEntriesWithData::softwareName, DumpHardwareEntriesWithData::softwareOperatingSystem, DumpHardwareEntriesWithData::softwareVersion, Checksums::spamsum, TRACE, aaruformat_context::track_entries, aaruformat_context::user_data_ddt, aaruformat_context::user_data_ddt2, write_aaru_json_block(), write_cached_secondary_ddt(), write_checksum_block(), write_cicm_block(), write_dumphw_block(), write_dvd_long_sector_blocks(), write_dvd_title_key_decrypted_block(), write_geometry_block(), write_index_block(), write_media_tags(), write_metadata_block(), write_mode2_subheaders_block(), write_primary_ddt(), write_sector_prefix(), write_sector_prefix_ddt(), write_sector_subchannel(), write_sector_suffix(), write_sector_suffix_ddt(), write_single_level_ddt(), write_tape_ddt(), write_tape_file_block(), write_tape_partition_block(), write_tracks_block(), and aaruformat_context::writing_buffer.

+

References AARU_CALL, AARU_EXPORT, AARU_MAGIC, aaruf_close_current_block(), aaruf_ecc_cd_free(), AARUF_ERROR_CANNOT_WRITE_HEADER, AARUF_STATUS_OK, aaruformat_context::block_cache, aaruformat_context::block_header_cache, aaruformat_context::cached_secondary_ddt2, aaruformat_context::checksums, aaruformat_context::cicm_block, mediaTagEntry::data, aaruformat_context::data_tracks, aaruformat_context::deduplicate, aaruformat_context::dirty_checksum_block, aaruformat_context::dirty_cicm_block, aaruformat_context::dirty_dumphw_block, aaruformat_context::dirty_dvd_long_sector_blocks, aaruformat_context::dirty_dvd_title_key_decrypted_block, aaruformat_context::dirty_flux_block, aaruformat_context::dirty_geometry_block, aaruformat_context::dirty_index_block, aaruformat_context::dirty_json_block, aaruformat_context::dirty_media_tags, aaruformat_context::dirty_metadata_block, aaruformat_context::dirty_mode2_subheaders_block, aaruformat_context::dirty_primary_ddt, aaruformat_context::dirty_secondary_ddt, aaruformat_context::dirty_sector_prefix_block, aaruformat_context::dirty_sector_prefix_ddt, aaruformat_context::dirty_sector_subchannel_block, aaruformat_context::dirty_sector_suffix_block, aaruformat_context::dirty_sector_suffix_ddt, aaruformat_context::dirty_single_level_ddt, aaruformat_context::dirty_tape_ddt, aaruformat_context::dirty_tape_file_block, aaruformat_context::dirty_tape_partition_block, aaruformat_context::dirty_tracks_block, aaruformat_context::dump_hardware_entries_with_data, aaruformat_context::dump_hardware_header, aaruformat_context::ecc_cd_context, DumpHardwareHeader::entries, DumpHardwareEntriesWithData::extents, FATAL, DumpHardwareEntriesWithData::firmware, free_cache(), free_map(), aaruformat_context::header, aaruformat_context::imageStream, aaruformat_context::in_memory_ddt, aaruformat_context::index_entries, aaruformat_context::is_tape, aaruformat_context::is_writing, aaruformat_context::magic, DumpHardwareEntriesWithData::manufacturer, aaruformat_context::mapped_memory_ddt_size, aaruformat_context::mediaTags, aaruformat_context::metadata_block, aaruformat_context::mode2_subheaders, DumpHardwareEntriesWithData::model, aaruformat_context::readableSectorTags, DumpHardwareEntriesWithData::revision, aaruformat_context::sector_cpr_mai, aaruformat_context::sector_edc, aaruformat_context::sector_hash_map, aaruformat_context::sector_id, aaruformat_context::sector_ied, aaruformat_context::sector_prefix, aaruformat_context::sector_prefix_corrected, aaruformat_context::sector_prefix_ddt, aaruformat_context::sector_prefix_ddt2, aaruformat_context::sector_subchannel, aaruformat_context::sector_suffix, aaruformat_context::sector_suffix_corrected, aaruformat_context::sector_suffix_ddt, aaruformat_context::sector_suffix_ddt2, DumpHardwareEntriesWithData::serial, DumpHardwareEntriesWithData::softwareName, DumpHardwareEntriesWithData::softwareOperatingSystem, DumpHardwareEntriesWithData::softwareVersion, Checksums::spamsum, TRACE, aaruformat_context::track_entries, aaruformat_context::user_data_ddt, aaruformat_context::user_data_ddt2, write_aaru_json_block(), write_cached_secondary_ddt(), write_checksum_block(), write_cicm_block(), write_dumphw_block(), write_dvd_long_sector_blocks(), write_dvd_title_key_decrypted_block(), write_flux_blocks(), write_geometry_block(), write_index_block(), write_media_tags(), write_metadata_block(), write_mode2_subheaders_block(), write_primary_ddt(), write_sector_prefix(), write_sector_prefix_ddt(), write_sector_subchannel(), write_sector_suffix(), write_sector_suffix_ddt(), write_single_level_ddt(), write_tape_ddt(), write_tape_file_block(), write_tape_partition_block(), write_tracks_block(), and aaruformat_context::writing_buffer.

Referenced by aaruf_open().

@@ -330,9 +334,9 @@ Distinction from CICM XML:
@@ -381,9 +385,9 @@ Distinction from CICM XML: