Files
libaaruformat/docs/html/tape_8h.html

231 lines
13 KiB
HTML
Raw Normal View History

2025-10-11 01:35:43 +01:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.14.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libaaruformat: include/aaruformat/structs/tape.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">libaaruformat<span id="projectnumber">&#160;1.0</span>
</div>
<div id="projectbrief">Aaru Data Preservation Suite - Format Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.14.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(function(){initNavTree('tape_8h.html','',''); });
</script>
<div id="container">
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">tape.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Data structures for tape media support in Aaru disk images.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;stdint.h&gt;</code><br />
</div>
<p><a href="tape_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-nested-classes" class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:TapeFileEntry" id="r_TapeFileEntry"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTapeFileEntry.html">TapeFileEntry</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Describes a single logical file on a tape medium. <a href="structTapeFileEntry.html#details">More...</a><br /></td></tr>
<tr class="memitem:TapeFileHeader" id="r_TapeFileHeader"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTapeFileHeader.html">TapeFileHeader</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Header for a tape file metadata block containing file layout information. <a href="structTapeFileHeader.html#details">More...</a><br /></td></tr>
<tr class="memitem:TapePartitionEntry" id="r_TapePartitionEntry"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTapePartitionEntry.html">TapePartitionEntry</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Describes a single physical partition on a tape medium. <a href="structTapePartitionEntry.html#details">More...</a><br /></td></tr>
<tr class="memitem:TapePartitionHeader" id="r_TapePartitionHeader"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTapePartitionHeader.html">TapePartitionHeader</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Header for a tape partition metadata block containing partition layout information. <a href="structTapePartitionHeader.html#details">More...</a><br /></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-typedef-members" class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ade8125364d763d57d167c0b521beaf64" id="r_ade8125364d763d57d167c0b521beaf64"><td class="memItemLeft" align="right" valign="top">typedef struct TapeFileEntry&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ade8125364d763d57d167c0b521beaf64">TapeFileEntry</a></td></tr>
<tr class="memitem:a0ce39d637f56346a0d859f94b8fc1f40" id="r_a0ce39d637f56346a0d859f94b8fc1f40"><td class="memItemLeft" align="right" valign="top">typedef struct TapeFileHeader&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0ce39d637f56346a0d859f94b8fc1f40">TapeFileHeader</a></td></tr>
<tr class="memitem:af947dbe92eb87a6bba23183f14686539" id="r_af947dbe92eb87a6bba23183f14686539"><td class="memItemLeft" align="right" valign="top">typedef struct TapePartitionEntry&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af947dbe92eb87a6bba23183f14686539">TapePartitionEntry</a></td></tr>
<tr class="memitem:a4f28f93bd2166f390ec24f1c3525584f" id="r_a4f28f93bd2166f390ec24f1c3525584f"><td class="memItemLeft" align="right" valign="top">typedef struct TapePartitionHeader&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4f28f93bd2166f390ec24f1c3525584f">TapePartitionHeader</a></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Data structures for tape media support in Aaru disk images. </p>
<p>This header defines structures used to represent tape-specific metadata in the Aaru image format. Tape media differs from disk media in several key ways:</p>
<p><b>Tape Organization:</b></p><ul>
<li>Tapes are organized into sequential blocks rather than random-access sectors</li>
<li>Multiple logical files can exist on a single tape</li>
<li>Tapes may be divided into multiple partitions</li>
<li>Files are defined by contiguous ranges of blocks within a partition</li>
</ul>
<p><b>File Structure:</b> Tape files are logical groupings of blocks that represent discrete data units. Each file has:</p><ul>
<li>A unique file number identifying it within its partition</li>
<li>A partition number indicating which physical partition contains it</li>
<li>A block range (FirstBlock to LastBlock, inclusive) defining its extent</li>
</ul>
<p><b>Partition Structure:</b> Tape partitions are physical divisions of the tape medium. Each partition:</p><ul>
<li>Has a unique partition number</li>
<li>Contains a contiguous range of blocks</li>
<li>Can contain multiple files or none</li>
<li>May have different formatting or characteristics</li>
</ul>
<p><b>Block Addressing:</b> Block numbers are sequential within a partition, starting from 0. The FirstBlock and LastBlock values are inclusive, meaning both boundary blocks are part of the file or partition. For example, a file with FirstBlock=100 and LastBlock=199 contains 100 blocks (blocks 100 through 199 inclusive).</p>
<p><b>Use Cases:</b></p><ul>
<li>Archiving legacy tape media (DAT, DLT, LTO, QIC, etc.)</li>
<li>Preserving tape structure for restoration to physical media</li>
<li>Forensic imaging of tape evidence</li>
<li>Migration of tape archives to modern storage</li>
<li>Documentation of tape organization for archival purposes</li>
</ul>
<p><b>Storage in Aaru Images:</b> The tape metadata blocks (<a class="el" href="structTapeFileHeader.html" title="Header for a tape file metadata block containing file layout information.">TapeFileHeader</a> and <a class="el" href="structTapePartitionHeader.html" title="Header for a tape partition metadata block containing partition layout information.">TapePartitionHeader</a>) are optional structural blocks written during image finalization. They allow readers to understand the logical organization of the tape without parsing the entire data stream.</p>
<dl class="section note"><dt>Note</dt><dd>All structures in this file use packed alignment (#pragma pack(push, 1)) to ensure consistent on-disk layout across different compilers and platforms.</dd>
<dd>
Block addresses are 0-based and partition numbers typically start from 0 (though some tape formats may use 1-based numbering).</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="enums_8h.html#a54420623f26ab6bb61042b41cccf37a3" title="List of known block types contained in an Aaru image.">BlockType</a> for the identifier constants used in <a class="el" href="structTapeFileHeader.html" title="Header for a tape file metadata block containing file layout information.">TapeFileHeader</a> and <a class="el" href="structTapePartitionHeader.html" title="Header for a tape partition metadata block containing partition layout information.">TapePartitionHeader</a> </dd></dl>
<p class="definition">Definition in file <a class="el" href="tape_8h_source.html">tape.h</a>.</p>
</div><a name="doc-typedef-members" id="doc-typedef-members"></a><h2 id="header-doc-typedef-members" class="groupheader">Typedef Documentation</h2>
<a id="ade8125364d763d57d167c0b521beaf64" name="ade8125364d763d57d167c0b521beaf64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade8125364d763d57d167c0b521beaf64">&#9670;&#160;</a></span>TapeFileEntry</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct TapeFileEntry TapeFileEntry</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a0ce39d637f56346a0d859f94b8fc1f40" name="a0ce39d637f56346a0d859f94b8fc1f40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ce39d637f56346a0d859f94b8fc1f40">&#9670;&#160;</a></span>TapeFileHeader</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct TapeFileHeader TapeFileHeader</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="af947dbe92eb87a6bba23183f14686539" name="af947dbe92eb87a6bba23183f14686539"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af947dbe92eb87a6bba23183f14686539">&#9670;&#160;</a></span>TapePartitionEntry</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct TapePartitionEntry TapePartitionEntry</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a4f28f93bd2166f390ec24f1c3525584f" name="a4f28f93bd2166f390ec24f1c3525584f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f28f93bd2166f390ec24f1c3525584f">&#9670;&#160;</a></span>TapePartitionHeader</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct TapePartitionHeader TapePartitionHeader</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a href="dir_aeff2545c9dfcfc842fe9d84b123cb31.html">aaruformat</a></li><li class="navelem"><a href="dir_6387aeb6e475a334d8dc12d69f21999e.html">structs</a></li><li class="navelem"><a href="tape_8h.html">tape.h</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.14.0 </li>
</ul>
</div>
</body>
</html>