/usr/share/doc/liblzma-doc/html/hardware_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 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 | <!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: xz/hardware.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_53e01eec41348db90f08d9ee7e6793af.html">xz</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">hardware.c File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Detection of available hardware resources.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "<a class="el" href="private_8h.html">private.h</a>"</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a339ea6948781e261447510faf7d46004"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="hardware_8c.html#a339ea6948781e261447510faf7d46004">hardware_threads_set</a> (uint32_t n)</td></tr>
<tr class="memdesc:a339ea6948781e261447510faf7d46004"><td class="mdescLeft"> </td><td class="mdescRight">Set the maximum number of worker threads. <a href="#a339ea6948781e261447510faf7d46004">More...</a><br /></td></tr>
<tr class="separator:a339ea6948781e261447510faf7d46004"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a524ded1b672fa85fafd2c39c12c42366"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="hardware_8c.html#a524ded1b672fa85fafd2c39c12c42366">hardware_threads_get</a> (void)</td></tr>
<tr class="memdesc:a524ded1b672fa85fafd2c39c12c42366"><td class="mdescLeft"> </td><td class="mdescRight">Get the maximum number of worker threads. <a href="#a524ded1b672fa85fafd2c39c12c42366">More...</a><br /></td></tr>
<tr class="separator:a524ded1b672fa85fafd2c39c12c42366"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a00d0e7d3dfbc21538d84a6fa4d0a70c0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="hardware_8c.html#a00d0e7d3dfbc21538d84a6fa4d0a70c0">hardware_memlimit_set</a> (uint64_t new_memlimit, bool set_compress, bool set_decompress, bool is_percentage)</td></tr>
<tr class="separator:a00d0e7d3dfbc21538d84a6fa4d0a70c0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af8f63ad66d839bff50e46464f0ad630f"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="hardware_8c.html#af8f63ad66d839bff50e46464f0ad630f">hardware_memlimit_get</a> (enum operation_mode mode)</td></tr>
<tr class="memdesc:af8f63ad66d839bff50e46464f0ad630f"><td class="mdescLeft"> </td><td class="mdescRight">Get the current memory usage limit for compression or decompression. <a href="#af8f63ad66d839bff50e46464f0ad630f">More...</a><br /></td></tr>
<tr class="separator:af8f63ad66d839bff50e46464f0ad630f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad56580adea56000e543fb4cda80fc003"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="hardware_8c.html#ad56580adea56000e543fb4cda80fc003">memlimit_show</a> (const char *str, uint64_t value)</td></tr>
<tr class="memdesc:ad56580adea56000e543fb4cda80fc003"><td class="mdescLeft"> </td><td class="mdescRight">Helper for <a class="el" href="hardware_8c.html#a7b6901e0938a5a55c5724b4ac42ea3e4" title="Display the amount of RAM and memory usage limits and exit. ">hardware_memlimit_show()</a> to print one human-readable info line. <a href="#ad56580adea56000e543fb4cda80fc003">More...</a><br /></td></tr>
<tr class="separator:ad56580adea56000e543fb4cda80fc003"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7b6901e0938a5a55c5724b4ac42ea3e4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="hardware_8c.html#a7b6901e0938a5a55c5724b4ac42ea3e4">hardware_memlimit_show</a> (void)</td></tr>
<tr class="memdesc:a7b6901e0938a5a55c5724b4ac42ea3e4"><td class="mdescLeft"> </td><td class="mdescRight">Display the amount of RAM and memory usage limits and exit. <a href="#a7b6901e0938a5a55c5724b4ac42ea3e4">More...</a><br /></td></tr>
<tr class="separator:a7b6901e0938a5a55c5724b4ac42ea3e4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a47191dfa6786da2498eb49ae28f8d361"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="hardware_8c.html#a47191dfa6786da2498eb49ae28f8d361">hardware_init</a> (void)</td></tr>
<tr class="separator:a47191dfa6786da2498eb49ae28f8d361"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:ab9596b097d7bb86b51dc754c1194a8ca"><td class="memItemLeft" align="right" valign="top">static uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="hardware_8c.html#ab9596b097d7bb86b51dc754c1194a8ca">threads_max</a> = 1</td></tr>
<tr class="separator:ab9596b097d7bb86b51dc754c1194a8ca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a480d1795efd25be46715244fade38e34"><td class="memItemLeft" align="right" valign="top">static uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="hardware_8c.html#a480d1795efd25be46715244fade38e34">memlimit_compress</a></td></tr>
<tr class="memdesc:a480d1795efd25be46715244fade38e34"><td class="mdescLeft"> </td><td class="mdescRight">Memory usage limit for compression. <a href="#a480d1795efd25be46715244fade38e34">More...</a><br /></td></tr>
<tr class="separator:a480d1795efd25be46715244fade38e34"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adcc72cef875d7fdc985d66bf61f9de38"><td class="memItemLeft" align="right" valign="top">static uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="hardware_8c.html#adcc72cef875d7fdc985d66bf61f9de38">memlimit_decompress</a></td></tr>
<tr class="memdesc:adcc72cef875d7fdc985d66bf61f9de38"><td class="mdescLeft"> </td><td class="mdescRight">Memory usage limit for decompression. <a href="#adcc72cef875d7fdc985d66bf61f9de38">More...</a><br /></td></tr>
<tr class="separator:adcc72cef875d7fdc985d66bf61f9de38"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3bade126d9aa72b3e34532c13828c955"><td class="memItemLeft" align="right" valign="top">static uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="hardware_8c.html#a3bade126d9aa72b3e34532c13828c955">total_ram</a></td></tr>
<tr class="memdesc:a3bade126d9aa72b3e34532c13828c955"><td class="mdescLeft"> </td><td class="mdescRight">Total amount of physical RAM. <a href="#a3bade126d9aa72b3e34532c13828c955">More...</a><br /></td></tr>
<tr class="separator:a3bade126d9aa72b3e34532c13828c955"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Detection of available hardware resources. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a339ea6948781e261447510faf7d46004"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a339ea6948781e261447510faf7d46004">§ </a></span>hardware_threads_set()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hardware_threads_set </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>n</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the maximum number of worker threads. </p>
<p>References <a class="el" href="liblzma_2api_2lzma_2hardware_8h.html#a22f7a882b7a4b741a226abf62bdf46ca">lzma_cputhreads()</a>, and <a class="el" href="hardware_8c.html#ab9596b097d7bb86b51dc754c1194a8ca">threads_max</a>.</p>
</div>
</div>
<a id="a524ded1b672fa85fafd2c39c12c42366"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a524ded1b672fa85fafd2c39c12c42366">§ </a></span>hardware_threads_get()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t hardware_threads_get </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the maximum number of worker threads. </p>
<p>References <a class="el" href="hardware_8c.html#ab9596b097d7bb86b51dc754c1194a8ca">threads_max</a>.</p>
</div>
</div>
<a id="a00d0e7d3dfbc21538d84a6fa4d0a70c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a00d0e7d3dfbc21538d84a6fa4d0a70c0">§ </a></span>hardware_memlimit_set()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hardware_memlimit_set </td>
<td>(</td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>new_memlimit</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>set_compress</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>set_decompress</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>is_percentage</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the memory usage limit. There are separate limits for compression and decompression (the latter includes also –list), one or both can be set with a single call to this function. Zero indicates resetting the limit back to the defaults. The limit can also be set as a percentage of installed RAM; the percentage must be in the range [1, 100]. </p>
<p>Referenced by <a class="el" href="hardware_8c.html#a47191dfa6786da2498eb49ae28f8d361">hardware_init()</a>.</p>
</div>
</div>
<a id="af8f63ad66d839bff50e46464f0ad630f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af8f63ad66d839bff50e46464f0ad630f">§ </a></span>hardware_memlimit_get()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t hardware_memlimit_get </td>
<td>(</td>
<td class="paramtype">enum operation_mode </td>
<td class="paramname"><em>mode</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current memory usage limit for compression or decompression. </p>
<p>Referenced by <a class="el" href="message_8h.html#a6953ba5a13ff12f32091346b5772e992">message_mem_needed()</a>.</p>
</div>
</div>
<a id="ad56580adea56000e543fb4cda80fc003"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad56580adea56000e543fb4cda80fc003">§ </a></span>memlimit_show()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void memlimit_show </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Helper for <a class="el" href="hardware_8c.html#a7b6901e0938a5a55c5724b4ac42ea3e4" title="Display the amount of RAM and memory usage limits and exit. ">hardware_memlimit_show()</a> to print one human-readable info line. </p>
</div>
</div>
<a id="a7b6901e0938a5a55c5724b4ac42ea3e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b6901e0938a5a55c5724b4ac42ea3e4">§ </a></span>hardware_memlimit_show()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hardware_memlimit_show </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Display the amount of RAM and memory usage limits and exit. </p>
</div>
</div>
<a id="a47191dfa6786da2498eb49ae28f8d361"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a47191dfa6786da2498eb49ae28f8d361">§ </a></span>hardware_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hardware_init </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize some hardware-specific variables, which are needed by other hardware_* functions. </p>
<p>References <a class="el" href="hardware_8c.html#a00d0e7d3dfbc21538d84a6fa4d0a70c0">hardware_memlimit_set()</a>, <a class="el" href="liblzma_2api_2lzma_2hardware_8h.html#a85363e453b34272a9f26c9fdffb041ee">lzma_physmem()</a>, and <a class="el" href="hardware_8c.html#a3bade126d9aa72b3e34532c13828c955">total_ram</a>.</p>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="ab9596b097d7bb86b51dc754c1194a8ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9596b097d7bb86b51dc754c1194a8ca">§ </a></span>threads_max</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint32_t threads_max = 1</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum number of worker threads. This can be set with the –threads=NUM command line option. </p>
<p>Referenced by <a class="el" href="hardware_8c.html#a524ded1b672fa85fafd2c39c12c42366">hardware_threads_get()</a>, and <a class="el" href="hardware_8c.html#a339ea6948781e261447510faf7d46004">hardware_threads_set()</a>.</p>
</div>
</div>
<a id="a480d1795efd25be46715244fade38e34"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a480d1795efd25be46715244fade38e34">§ </a></span>memlimit_compress</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint64_t memlimit_compress</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Memory usage limit for compression. </p>
</div>
</div>
<a id="adcc72cef875d7fdc985d66bf61f9de38"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adcc72cef875d7fdc985d66bf61f9de38">§ </a></span>memlimit_decompress</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint64_t memlimit_decompress</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Memory usage limit for decompression. </p>
</div>
</div>
<a id="a3bade126d9aa72b3e34532c13828c955"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3bade126d9aa72b3e34532c13828c955">§ </a></span>total_ram</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint64_t total_ram</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Total amount of physical RAM. </p>
<p>Referenced by <a class="el" href="hardware_8c.html#a47191dfa6786da2498eb49ae28f8d361">hardware_init()</a>.</p>
</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>
|