libaaruformat/docs/html/dpm_8c.html

<!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.18.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libaaruformat: src/dpm.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="codefolding.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.18.0 -->
<script type="text/javascript">
let searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
document.addEventListener('DOMContentLoaded', codefold.init);
</script>
<script type="application/json" id="doxygen-config">
{
  "relPath": "",
  "generateTreeView": true,
  "searchEngine": true,
  "serverBasedSearch": false,
  "disableIndex": false,
  "dynamicMenus": true,
  "fullSidebar": false
}
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<div id="main-nav-mobile">
<div class="sm sm-dox"><input id="main-menu-state" type="checkbox"/>
<label class="main-menu-btn" for="main-menu-state">
<span class="main-menu-btn-icon"></span> Toggle main menu visibility</label>
<span id="searchBoxPos1"></span>
</div>
</div><!-- main-nav-mobile -->
<div id="main-nav">
  <ul class="sm sm-dox" id="main-menu">
    <li id="searchBoxPos2">
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <span id="MSearchSelect" class="search-icon"><span class="search-icon-dropdown"></span></span>
          <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><div id="MSearchCloseImg" class="close-icon"></div></a>
          </span>
        </div>
    </li>
  </ul>
</div><!-- main-nav -->
</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" class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
document.addEventListener('DOMContentLoaded',() => { initNavTree('dpm_8c.html','',''); });
</script>
<div id="container">
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow">
</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">dpm.c File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;stdint.h&gt;</code><br />
<code>#include &lt;stdlib.h&gt;</code><br />
<code>#include &lt;string.h&gt;</code><br />
<code>#include &quot;<a class="el" href="aaruformat_8h_source.html">aaruformat.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="internal_8h_source.html">internal.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="log_8h_source.html">log.h</a>&quot;</code><br />
</div>
<p><a href="dpm_8c_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a2a5895e15916ffcffec176e7693d618f" id="r_a2a5895e15916ffcffec176e7693d618f"><td class="memItemLeft">int32_t&#160;</td><td class="memItemRight"><a class="el" href="#a2a5895e15916ffcffec176e7693d618f">aaruf_get_dpm</a> (const void *context, uint8_t *buffer, size_t *length)</td></tr>
<tr class="memdesc:a2a5895e15916ffcffec176e7693d618f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the Data Position Measurement block.  <br /></td></tr>
<tr class="memitem:a3fab43f31b8b8c0181e8a9d33f6fcc9d" id="r_a3fab43f31b8b8c0181e8a9d33f6fcc9d"><td class="memItemLeft">int32_t&#160;</td><td class="memItemRight"><a class="el" href="#a3fab43f31b8b8c0181e8a9d33f6fcc9d">aaruf_set_dpm</a> (void *context, const uint8_t *data, size_t length)</td></tr>
<tr class="memdesc:a3fab43f31b8b8c0181e8a9d33f6fcc9d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the Data Position Measurement block.  <br /></td></tr>
<tr class="memitem:af44db9fad21942b3521c7e739d398ef9" id="r_af44db9fad21942b3521c7e739d398ef9"><td class="memItemLeft">int32_t&#160;</td><td class="memItemRight"><a class="el" href="#af44db9fad21942b3521c7e739d398ef9">aaruf_clear_dpm</a> (void *context)</td></tr>
<tr class="memdesc:af44db9fad21942b3521c7e739d398ef9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes the Data Position Measurement block.  <br /></td></tr>
</table>
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
<a id="af44db9fad21942b3521c7e739d398ef9" name="af44db9fad21942b3521c7e739d398ef9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af44db9fad21942b3521c7e739d398ef9">&#9670;&#160;</a></span>aaruf_clear_dpm()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t aaruf_clear_dpm </td>
          <td>(</td>
          <td class="paramtype">void *</td>          <td class="paramname"><span class="paramname"><em>context</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Removes the Data Position Measurement block. </p>
<p>Discards the DPM kept in the context. When the image is closed, the DPM block is removed from the index, so a resumed image loses the DPM it had.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">context</td><td>Pointer to the aaruformat context, opened for writing. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>AARUF_STATUS_OK on success, AARUF_ERROR_NOT_AARUFORMAT if the context is invalid, AARUF_READ_ONLY if the image is not being written. </dd></dl>

<p class="definition">Definition at line <a class="el" href="dpm_8c_source.html#l00172">172</a> of file <a class="el" href="dpm_8c_source.html">dpm.c</a>.</p>

<p class="reference">References <a class="el" href="decls_8h_source.html#l00046">AARU_CALL</a>, <a class="el" href="decls_8h_source.html#l00055">AARU_EXPORT</a>, <a class="el" href="consts_8h_source.html#l00064">AARU_MAGIC</a>, <a class="el" href="dpm_8c_source.html#l00172">aaruf_clear_dpm()</a>, <a class="el" href="errors_8h_source.html#l00040">AARUF_ERROR_NOT_AARUFORMAT</a>, <a class="el" href="errors_8h_source.html#l00061">AARUF_READ_ONLY</a>, <a class="el" href="errors_8h_source.html#l00082">AARUF_STATUS_OK</a>, <a class="el" href="context_8h_source.html#l00352">aaruformat_context::dirty_dpm_block</a>, <a class="el" href="context_8h_source.html#l00223">aaruformat_context::dpm_block</a>, <a class="el" href="context_8h_source.html#l00224">aaruformat_context::dpm_block_length</a>, <a class="el" href="log_8h_source.html#l00075">FATAL</a>, <a class="el" href="context_8h_source.html#l00302">aaruformat_context::is_writing</a>, <a class="el" href="context_8h_source.html#l00180">aaruformat_context::magic</a>, and <a class="el" href="log_8h_source.html#l00069">TRACE</a>.</p>

<p class="reference">Referenced by <a class="el" href="dpm_8c_source.html#l00172">aaruf_clear_dpm()</a>.</p>

</div>
</div>
<a id="a2a5895e15916ffcffec176e7693d618f" name="a2a5895e15916ffcffec176e7693d618f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a5895e15916ffcffec176e7693d618f">&#9670;&#160;</a></span>aaruf_get_dpm()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t aaruf_get_dpm </td>
          <td>(</td>
          <td class="paramtype">const void *</td>          <td class="paramname"><span class="paramname"><em>context</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t *</td>          <td class="paramname"><span class="paramname"><em>buffer</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t *</td>          <td class="paramname"><span class="paramname"><em>length</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Retrieves the Data Position Measurement block. </p>
<p>Copies the serialized block, a <a class="el" href="structDpmHeader.html" title="Header of the Data Position Measurement block.">DpmHeader</a> followed by its payload exactly as stored in the image, to <code class="param">buffer</code>. When <code class="param">buffer</code> is NULL or too small, <code class="param">length</code> is set to the required size and AARUF_ERROR_BUFFER_TOO_SMALL is returned, so the caller can allocate and call again.</p>
<p>Works on images opened for reading and on images being created or resumed.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">context</td><td>Pointer to the aaruformat context. </td></tr>
    <tr><td class="paramname">buffer</td><td>Buffer that receives the block, may be NULL to query the size. </td></tr>
    <tr><td class="paramname">length</td><td>On input the size of <code class="param">buffer</code>, on output the size of the block. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>AARUF_STATUS_OK on success, AARUF_ERROR_NOT_AARUFORMAT if the context is invalid, AARUF_ERROR_METADATA_NOT_PRESENT if the image has no DPM, AARUF_ERROR_BUFFER_TOO_SMALL if <code class="param">buffer</code> is too small. </dd></dl>

<p class="definition">Definition at line <a class="el" href="dpm_8c_source.html#l00043">43</a> of file <a class="el" href="dpm_8c_source.html">dpm.c</a>.</p>

<p class="reference">References <a class="el" href="decls_8h_source.html#l00046">AARU_CALL</a>, <a class="el" href="decls_8h_source.html#l00055">AARU_EXPORT</a>, <a class="el" href="consts_8h_source.html#l00064">AARU_MAGIC</a>, <a class="el" href="errors_8h_source.html#l00049">AARUF_ERROR_BUFFER_TOO_SMALL</a>, <a class="el" href="errors_8h_source.html#l00069">AARUF_ERROR_METADATA_NOT_PRESENT</a>, <a class="el" href="errors_8h_source.html#l00040">AARUF_ERROR_NOT_AARUFORMAT</a>, <a class="el" href="dpm_8c_source.html#l00043">aaruf_get_dpm()</a>, <a class="el" href="errors_8h_source.html#l00082">AARUF_STATUS_OK</a>, <a class="el" href="context_8h_source.html#l00223">aaruformat_context::dpm_block</a>, <a class="el" href="context_8h_source.html#l00224">aaruformat_context::dpm_block_length</a>, <a class="el" href="log_8h_source.html#l00075">FATAL</a>, <a class="el" href="context_8h_source.html#l00180">aaruformat_context::magic</a>, and <a class="el" href="log_8h_source.html#l00069">TRACE</a>.</p>

<p class="reference">Referenced by <a class="el" href="dpm_8c_source.html#l00043">aaruf_get_dpm()</a>.</p>

</div>
</div>
<a id="a3fab43f31b8b8c0181e8a9d33f6fcc9d" name="a3fab43f31b8b8c0181e8a9d33f6fcc9d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3fab43f31b8b8c0181e8a9d33f6fcc9d">&#9670;&#160;</a></span>aaruf_set_dpm()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t aaruf_set_dpm </td>
          <td>(</td>
          <td class="paramtype">void *</td>          <td class="paramname"><span class="paramname"><em>context</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint8_t *</td>          <td class="paramname"><span class="paramname"><em>data</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t</td>          <td class="paramname"><span class="paramname"><em>length</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the Data Position Measurement block. </p>
<p>Takes the serialized block, a <a class="el" href="structDpmHeader.html" title="Header of the Data Position Measurement block.">DpmHeader</a> followed by its payload, validates its identifier, sizes and CRC64, and keeps a copy that is written when the image is closed, replacing any DPM the image already had.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">context</td><td>Pointer to the aaruformat context, opened for writing. </td></tr>
    <tr><td class="paramname">data</td><td>Serialized block. </td></tr>
    <tr><td class="paramname">length</td><td>Length of <code class="param">data</code> in bytes. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>AARUF_STATUS_OK on success, AARUF_ERROR_NOT_AARUFORMAT if the context is invalid, AARUF_READ_ONLY if the image is not being written, AARUF_ERROR_INCORRECT_DATA_SIZE, AARUF_ERROR_CANNOT_READ_BLOCK or AARUF_ERROR_INVALID_BLOCK_CRC if the block is invalid, AARUF_ERROR_NOT_ENOUGH_MEMORY. </dd></dl>

<p class="definition">Definition at line <a class="el" href="dpm_8c_source.html#l00102">102</a> of file <a class="el" href="dpm_8c_source.html">dpm.c</a>.</p>

<p class="reference">References <a class="el" href="decls_8h_source.html#l00046">AARU_CALL</a>, <a class="el" href="decls_8h_source.html#l00055">AARU_EXPORT</a>, <a class="el" href="consts_8h_source.html#l00064">AARU_MAGIC</a>, <a class="el" href="errors_8h_source.html#l00040">AARUF_ERROR_NOT_AARUFORMAT</a>, <a class="el" href="errors_8h_source.html#l00048">AARUF_ERROR_NOT_ENOUGH_MEMORY</a>, <a class="el" href="errors_8h_source.html#l00061">AARUF_READ_ONLY</a>, <a class="el" href="dpm_8c_source.html#l00102">aaruf_set_dpm()</a>, <a class="el" href="errors_8h_source.html#l00082">AARUF_STATUS_OK</a>, <a class="el" href="context_8h_source.html#l00352">aaruformat_context::dirty_dpm_block</a>, <a class="el" href="context_8h_source.html#l00223">aaruformat_context::dpm_block</a>, <a class="el" href="context_8h_source.html#l00224">aaruformat_context::dpm_block_length</a>, <a class="el" href="log_8h_source.html#l00075">FATAL</a>, <a class="el" href="context_8h_source.html#l00302">aaruformat_context::is_writing</a>, <a class="el" href="context_8h_source.html#l00180">aaruformat_context::magic</a>, <a class="el" href="log_8h_source.html#l00069">TRACE</a>, and <a class="el" href="blocks_2dpm_8c_source.html#l00053">validate_dpm_block()</a>.</p>

<p class="reference">Referenced by <a class="el" href="dpm_8c_source.html#l00102">aaruf_set_dpm()</a>.</p>

</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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a href="dpm_8c.html">dpm.c</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.18.0 </li>
  </ul>
</div>
</body>
</html>