/usr/share/doc/liblzma-doc/html/outqueue_8c.html is in liblzma-doc 5.2.2-1.2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>XZ Utils: liblzma/common/outqueue.c 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>
<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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">XZ Utils
 <span id="projectnumber">5.2.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_2e0898c272e1f0f93c8ef15f5da2a912.html">liblzma</a></li><li class="navelem"><a class="el" href="dir_db777975f8e21a5de5f283e04473bf67.html">common</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">outqueue.c File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Output queue handling in multithreaded coding.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "<a class="el" href="outqueue_8h.html">outqueue.h</a>"</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a750659e05502f04f67deb298f5eb22d3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="outqueue_8c.html#a750659e05502f04f67deb298f5eb22d3">BUF_SIZE_MAX</a>   (UINT64_MAX / <a class="el" href="common_8h.html#aa4b23f9eb51a547255386963c9ff0529">LZMA_THREADS_MAX</a> / 2 / 2)</td></tr>
<tr class="separator:a750659e05502f04f67deb298f5eb22d3"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a57b3aa1259d0b27d02a240c48c3c8f70"><td class="memItemLeft" align="right" valign="top"><a id="a57b3aa1259d0b27d02a240c48c3c8f70"></a>
static <a class="el" href="base_8h.html#a8494e0457e1463d6d2b6836018d87b6e">lzma_ret</a> </td><td class="memItemRight" valign="bottom"><b>get_options</b> (uint64_t *bufs_alloc_size, uint32_t *bufs_count, uint64_t buf_size_max, uint32_t threads)</td></tr>
<tr class="separator:a57b3aa1259d0b27d02a240c48c3c8f70"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a77d74387abe8047dfc4e1b0ea6c4c56c"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="outqueue_8c.html#a77d74387abe8047dfc4e1b0ea6c4c56c">lzma_outq_memusage</a> (uint64_t buf_size_max, uint32_t threads)</td></tr>
<tr class="memdesc:a77d74387abe8047dfc4e1b0ea6c4c56c"><td class="mdescLeft"> </td><td class="mdescRight">Calculate the memory usage of an output queue. <a href="#a77d74387abe8047dfc4e1b0ea6c4c56c">More...</a><br /></td></tr>
<tr class="separator:a77d74387abe8047dfc4e1b0ea6c4c56c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aab9efe4ddc4f3a0a8ccf85607bd9e773"><td class="memItemLeft" align="right" valign="top"><a class="el" href="base_8h.html#a8494e0457e1463d6d2b6836018d87b6e">lzma_ret</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="outqueue_8c.html#aab9efe4ddc4f3a0a8ccf85607bd9e773">lzma_outq_init</a> (<a class="el" href="structlzma__outq.html">lzma_outq</a> *outq, const <a class="el" href="structlzma__allocator.html">lzma_allocator</a> *allocator, uint64_t buf_size_max, uint32_t threads)</td></tr>
<tr class="memdesc:aab9efe4ddc4f3a0a8ccf85607bd9e773"><td class="mdescLeft"> </td><td class="mdescRight">Initialize an output queue. <a href="#aab9efe4ddc4f3a0a8ccf85607bd9e773">More...</a><br /></td></tr>
<tr class="separator:aab9efe4ddc4f3a0a8ccf85607bd9e773"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a536bfd1db5c6d66bb91fbd43f358885e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="outqueue_8c.html#a536bfd1db5c6d66bb91fbd43f358885e">lzma_outq_end</a> (<a class="el" href="structlzma__outq.html">lzma_outq</a> *outq, const <a class="el" href="structlzma__allocator.html">lzma_allocator</a> *allocator)</td></tr>
<tr class="memdesc:a536bfd1db5c6d66bb91fbd43f358885e"><td class="mdescLeft"> </td><td class="mdescRight">Free the memory associated with the output queue. <a href="#a536bfd1db5c6d66bb91fbd43f358885e">More...</a><br /></td></tr>
<tr class="separator:a536bfd1db5c6d66bb91fbd43f358885e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0f428c8b0585cddaa1d5a803d54c78c0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structlzma__outbuf.html">lzma_outbuf</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="outqueue_8c.html#a0f428c8b0585cddaa1d5a803d54c78c0">lzma_outq_get_buf</a> (<a class="el" href="structlzma__outq.html">lzma_outq</a> *outq)</td></tr>
<tr class="memdesc:a0f428c8b0585cddaa1d5a803d54c78c0"><td class="mdescLeft"> </td><td class="mdescRight">Get a new buffer. <a href="#a0f428c8b0585cddaa1d5a803d54c78c0">More...</a><br /></td></tr>
<tr class="separator:a0f428c8b0585cddaa1d5a803d54c78c0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5e79b72c4b35a39ab86c18b91f43dca0"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="outqueue_8c.html#a5e79b72c4b35a39ab86c18b91f43dca0">lzma_outq_is_readable</a> (const <a class="el" href="structlzma__outq.html">lzma_outq</a> *outq)</td></tr>
<tr class="memdesc:a5e79b72c4b35a39ab86c18b91f43dca0"><td class="mdescLeft"> </td><td class="mdescRight">Test if there is data ready to be read. <a href="#a5e79b72c4b35a39ab86c18b91f43dca0">More...</a><br /></td></tr>
<tr class="separator:a5e79b72c4b35a39ab86c18b91f43dca0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6731d12d51638c89c1c42ba92aba6cfa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="base_8h.html#a8494e0457e1463d6d2b6836018d87b6e">lzma_ret</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="outqueue_8c.html#a6731d12d51638c89c1c42ba92aba6cfa">lzma_outq_read</a> (<a class="el" href="structlzma__outq.html">lzma_outq</a> *restrict outq, uint8_t *restrict out, size_t *restrict out_pos, size_t out_size, <a class="el" href="vli_8h.html#a1dbc0ffc3e72748f64df8f7f71898272">lzma_vli</a> *restrict unpadded_size, <a class="el" href="vli_8h.html#a1dbc0ffc3e72748f64df8f7f71898272">lzma_vli</a> *restrict uncompressed_size)</td></tr>
<tr class="memdesc:a6731d12d51638c89c1c42ba92aba6cfa"><td class="mdescLeft"> </td><td class="mdescRight">Read finished data. <a href="#a6731d12d51638c89c1c42ba92aba6cfa">More...</a><br /></td></tr>
<tr class="separator:a6731d12d51638c89c1c42ba92aba6cfa"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Output queue handling in multithreaded coding. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a750659e05502f04f67deb298f5eb22d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a750659e05502f04f67deb298f5eb22d3">§ </a></span>BUF_SIZE_MAX</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BUF_SIZE_MAX   (UINT64_MAX / <a class="el" href="common_8h.html#aa4b23f9eb51a547255386963c9ff0529">LZMA_THREADS_MAX</a> / 2 / 2)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This is to ease integer overflow checking: We may allocate up to 2 * LZMA_THREADS_MAX buffers and we need some extra memory for other data structures (that's the second /2). </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a77d74387abe8047dfc4e1b0ea6c4c56c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a77d74387abe8047dfc4e1b0ea6c4c56c">§ </a></span>lzma_outq_memusage()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t lzma_outq_memusage </td>
<td>(</td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>buf_size_max</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>threads</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculate the memory usage of an output queue. </p>
<dl class="section return"><dt>Returns</dt><dd>Approximate memory usage in bytes or UINT64_MAX on error. </dd></dl>
<p>References <a class="el" href="stream__encoder__mt_8c.html#ad604ebedc1e6378d9ea187caab98e742">get_options()</a>, and <a class="el" href="base_8h.html#a8494e0457e1463d6d2b6836018d87b6eac003781ccb81bbd5578e29abed8a8cfe">LZMA_OK</a>.</p>
</div>
</div>
<a id="aab9efe4ddc4f3a0a8ccf85607bd9e773"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aab9efe4ddc4f3a0a8ccf85607bd9e773">§ </a></span>lzma_outq_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="base_8h.html#a8494e0457e1463d6d2b6836018d87b6e">lzma_ret</a> lzma_outq_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlzma__outq.html">lzma_outq</a> * </td>
<td class="paramname"><em>outq</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structlzma__allocator.html">lzma_allocator</a> * </td>
<td class="paramname"><em>allocator</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>buf_size_max</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>threads</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize an output queue. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">outq</td><td>Pointer to an output queue. Before calling this function the first time, *outq should have been zeroed with memzero() so that this function knows that there are no previous allocations to free. </td></tr>
<tr><td class="paramname">allocator</td><td>Pointer to allocator or NULL </td></tr>
<tr><td class="paramname">buf_size_max</td><td>Maximum amount of data that a single buffer in the queue may need to store. </td></tr>
<tr><td class="paramname">threads</td><td>Number of buffers that may be in use concurrently. Note that more than this number of buffers will actually get allocated to improve performance when buffers finish out of order.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>- LZMA_OK<ul>
<li>LZMA_MEM_ERROR </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a536bfd1db5c6d66bb91fbd43f358885e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a536bfd1db5c6d66bb91fbd43f358885e">§ </a></span>lzma_outq_end()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void lzma_outq_end </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlzma__outq.html">lzma_outq</a> * </td>
<td class="paramname"><em>outq</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structlzma__allocator.html">lzma_allocator</a> * </td>
<td class="paramname"><em>allocator</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free the memory associated with the output queue. </p>
</div>
</div>
<a id="a0f428c8b0585cddaa1d5a803d54c78c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0f428c8b0585cddaa1d5a803d54c78c0">§ </a></span>lzma_outq_get_buf()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structlzma__outbuf.html">lzma_outbuf</a>* lzma_outq_get_buf </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlzma__outq.html">lzma_outq</a> * </td>
<td class="paramname"><em>outq</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a new buffer. </p>
<p><a class="el" href="outqueue_8h.html#a364f1d1ae262603c27ec8cfedcc90b97" title="Test if there is at least one buffer free. ">lzma_outq_has_buf()</a> must be used to check that there is a buffer available before calling <a class="el" href="outqueue_8h.html#a0f428c8b0585cddaa1d5a803d54c78c0" title="Get a new buffer. ">lzma_outq_get_buf()</a>. </p>
</div>
</div>
<a id="a5e79b72c4b35a39ab86c18b91f43dca0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e79b72c4b35a39ab86c18b91f43dca0">§ </a></span>lzma_outq_is_readable()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool lzma_outq_is_readable </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structlzma__outq.html">lzma_outq</a> * </td>
<td class="paramname"><em>outq</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Test if there is data ready to be read. </p>
<p>Call to this function must be protected with the same mutex that is used to protect <a class="el" href="structlzma__outbuf.html#a19bf43c912ab386e93814268802d228c">lzma_outbuf.finished</a>. </p>
<p>References <a class="el" href="structlzma__outq.html#a0e55c27cec34c39908dca76f72e74ccf">lzma_outq::bufs</a>, <a class="el" href="structlzma__outq.html#ad1a9bc89ad7e0b33e0d2a296bdd3d5f0">lzma_outq::bufs_allocated</a>, <a class="el" href="structlzma__outq.html#ad1fec503b96f2a650a6c8d22ccc51985">lzma_outq::bufs_pos</a>, <a class="el" href="structlzma__outq.html#aec57711931fc18da7465706e3b83766b">lzma_outq::bufs_used</a>, and <a class="el" href="structlzma__outbuf.html#a19bf43c912ab386e93814268802d228c">lzma_outbuf::finished</a>.</p>
<p>Referenced by <a class="el" href="stream__encoder__mt_8c.html#af70cca26cf2ca5dba84894452962ccd6">wait_for_work()</a>.</p>
</div>
</div>
<a id="a6731d12d51638c89c1c42ba92aba6cfa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6731d12d51638c89c1c42ba92aba6cfa">§ </a></span>lzma_outq_read()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="base_8h.html#a8494e0457e1463d6d2b6836018d87b6e">lzma_ret</a> lzma_outq_read </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlzma__outq.html">lzma_outq</a> *restrict </td>
<td class="paramname"><em>outq</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *restrict </td>
<td class="paramname"><em>out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t *restrict </td>
<td class="paramname"><em>out_pos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>out_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="vli_8h.html#a1dbc0ffc3e72748f64df8f7f71898272">lzma_vli</a> *restrict </td>
<td class="paramname"><em>unpadded_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="vli_8h.html#a1dbc0ffc3e72748f64df8f7f71898272">lzma_vli</a> *restrict </td>
<td class="paramname"><em>uncompressed_size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read finished data. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">outq</td><td>Pointer to an output queue </td></tr>
<tr><td class="paramname">out</td><td>Beginning of the output buffer </td></tr>
<tr><td class="paramname">out_pos</td><td>The next byte will be written to out[*out_pos]. </td></tr>
<tr><td class="paramname">out_size</td><td>Size of the out buffer; the first byte into which no data is written to is out[out_size]. </td></tr>
<tr><td class="paramname">unpadded_size</td><td>Unpadded Size from the Block encoder </td></tr>
<tr><td class="paramname">uncompressed_size</td><td>Uncompressed Size from the Block encoder</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>- LZMA: All OK. Either no data was available or the buffer being read didn't become empty yet.<ul>
<li>LZMA_STREAM_END: The buffer being read was finished. *unpadded_size and *uncompressed_size were set.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This reads <a class="el" href="structlzma__outbuf.html#a19bf43c912ab386e93814268802d228c">lzma_outbuf.finished</a> variables and thus call to this function needs to be protected with a mutex. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.12
</small></address>
</body>
</html>
|