/usr/share/doc/liblzma-doc/html/tuklib__integer_8h.html is in liblzma-doc 5.1.1alpha+20120614-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 | <!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"/>
<title>XZ Utils: common/tuklib_integer.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>
<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 style="padding-left: 0.5em;">
<div id="projectname">XZ Utils
 <span id="projectnumber">5.1.0alpha</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_bdd9a5d540de89e9fe90efdfc6973a4f.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">tuklib_integer.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Various integer and bit operations.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "<a class="el" href="tuklib__common_8h.html">tuklib_common.h</a>"</code><br/>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a9bc188ccb2085aca13b9e411db6bae11"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9bc188ccb2085aca13b9e411db6bae11"></a>
#define </td><td class="memItemRight" valign="bottom"><b>bswap16</b>(num)   (((uint16_t)(num) << 8) | ((uint16_t)(num) >> 8))</td></tr>
<tr class="memitem:a2610a88a071ec508edbc15ee90094e64"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><b>bswap32</b>(num)</td></tr>
<tr class="memitem:ac9db02787e6a4bc63d62808b357df8ce"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><b>bswap64</b>(num)</td></tr>
<tr class="memitem:a6b2b9d836ddb7dc5d299ead15101f57a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6b2b9d836ddb7dc5d299ead15101f57a"></a>
#define </td><td class="memItemRight" valign="bottom"><b>conv16be</b>(num)   bswap16(num)</td></tr>
<tr class="memitem:a812ae5d9be2d45d34f37744eb35c6ec4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a812ae5d9be2d45d34f37744eb35c6ec4"></a>
#define </td><td class="memItemRight" valign="bottom"><b>conv32be</b>(num)   bswap32(num)</td></tr>
<tr class="memitem:a8ed018b58daffeb1bb83871cf4e09f2d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8ed018b58daffeb1bb83871cf4e09f2d"></a>
#define </td><td class="memItemRight" valign="bottom"><b>conv64be</b>(num)   bswap64(num)</td></tr>
<tr class="memitem:a3f517ab0a93d921fd78a2d0647ab906f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3f517ab0a93d921fd78a2d0647ab906f"></a>
#define </td><td class="memItemRight" valign="bottom"><b>conv16le</b>(num)   ((uint16_t)(num))</td></tr>
<tr class="memitem:aaa18c21f5b341ddb6952b6b798be9795"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa18c21f5b341ddb6952b6b798be9795"></a>
#define </td><td class="memItemRight" valign="bottom"><b>conv32le</b>(num)   ((uint32_t)(num))</td></tr>
<tr class="memitem:a2cb6884e43cdd40bf5c5e67bebec7b27"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2cb6884e43cdd40bf5c5e67bebec7b27"></a>
#define </td><td class="memItemRight" valign="bottom"><b>conv64le</b>(num)   ((uint64_t)(num))</td></tr>
<tr class="memitem:a1f3fa212057250e94c915987ee6c3d0b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1f3fa212057250e94c915987ee6c3d0b"></a>
#define </td><td class="memItemRight" valign="bottom"><b>write16be</b>(buf, num)   write16ne((buf), conv16be(num))</td></tr>
<tr class="memitem:af0b9424360d88d83fe8161d5e210b4b2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af0b9424360d88d83fe8161d5e210b4b2"></a>
#define </td><td class="memItemRight" valign="bottom"><b>write16le</b>(buf, num)   write16ne((buf), conv16le(num))</td></tr>
<tr class="memitem:af4f4e88616e71eb539a9dd7589475fa1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af4f4e88616e71eb539a9dd7589475fa1"></a>
#define </td><td class="memItemRight" valign="bottom"><b>write32be</b>(buf, num)   write32ne((buf), conv32be(num))</td></tr>
<tr class="memitem:af29be033fcc28c5c2b11a7f580761e79"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af29be033fcc28c5c2b11a7f580761e79"></a>
#define </td><td class="memItemRight" valign="bottom"><b>write32le</b>(buf, num)   write32ne((buf), conv32le(num))</td></tr>
<tr class="memitem:ab6fb0927aa9e804d9200ffdab0c23b40"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab6fb0927aa9e804d9200ffdab0c23b40"></a>
#define </td><td class="memItemRight" valign="bottom"><b>write64be</b>(buf, num)   write64ne((buf), conv64be(num))</td></tr>
<tr class="memitem:a097c6c866bd97162c7f01eb73433a068"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a097c6c866bd97162c7f01eb73433a068"></a>
#define </td><td class="memItemRight" valign="bottom"><b>write64le</b>(buf, num)   write64ne((buf), conv64le(num))</td></tr>
<tr class="memitem:a510e889b2b5726d0e44c11b88cfc80bf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a510e889b2b5726d0e44c11b88cfc80bf"></a>
#define </td><td class="memItemRight" valign="bottom"><b>bsf32</b>   ctz32</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ade5dfb160423314015a92f9d3b41364e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ade5dfb160423314015a92f9d3b41364e"></a>
static uint16_t </td><td class="memItemRight" valign="bottom"><b>read16be</b> (const uint8_t *buf)</td></tr>
<tr class="memitem:aabdb9935979bb9e6d6b9c43b4ea09219"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aabdb9935979bb9e6d6b9c43b4ea09219"></a>
static uint16_t </td><td class="memItemRight" valign="bottom"><b>read16le</b> (const uint8_t *buf)</td></tr>
<tr class="memitem:ad61e457beb44cca201afa4e22a991f7c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad61e457beb44cca201afa4e22a991f7c"></a>
static uint32_t </td><td class="memItemRight" valign="bottom"><b>read32be</b> (const uint8_t *buf)</td></tr>
<tr class="memitem:a0c1af647880b49c2783a1b8fb5ceb8b3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0c1af647880b49c2783a1b8fb5ceb8b3"></a>
static uint32_t </td><td class="memItemRight" valign="bottom"><b>read32le</b> (const uint8_t *buf)</td></tr>
<tr class="memitem:a6ef94494f1932d82ccd8eec33c84f2ba"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6ef94494f1932d82ccd8eec33c84f2ba"></a>
static uint64_t </td><td class="memItemRight" valign="bottom"><b>read64be</b> (const uint8_t *buf)</td></tr>
<tr class="memitem:a188612f1b09af87b03a4b5f97c236771"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a188612f1b09af87b03a4b5f97c236771"></a>
static uint64_t </td><td class="memItemRight" valign="bottom"><b>read64le</b> (const uint8_t *buf)</td></tr>
<tr class="memitem:a87d1e8e3c3158b34f10644ba14bb4bce"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a87d1e8e3c3158b34f10644ba14bb4bce"></a>
static void </td><td class="memItemRight" valign="bottom"><b>write16ne</b> (uint8_t *buf, uint16_t num)</td></tr>
<tr class="memitem:ae1bb649e12f5096e4e17a67027dda451"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae1bb649e12f5096e4e17a67027dda451"></a>
static void </td><td class="memItemRight" valign="bottom"><b>write32ne</b> (uint8_t *buf, uint32_t num)</td></tr>
<tr class="memitem:a018f795a238067705b3ed704625ae816"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a018f795a238067705b3ed704625ae816"></a>
static void </td><td class="memItemRight" valign="bottom"><b>write64ne</b> (uint8_t *buf, uint64_t num)</td></tr>
<tr class="memitem:a61a37dadae8ea79c9728758acab6f375"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a61a37dadae8ea79c9728758acab6f375"></a>
static uint16_t </td><td class="memItemRight" valign="bottom"><b>unaligned_read16be</b> (const uint8_t *buf)</td></tr>
<tr class="memitem:a03f4001c17c5907e160653277953066a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a03f4001c17c5907e160653277953066a"></a>
static uint16_t </td><td class="memItemRight" valign="bottom"><b>unaligned_read16le</b> (const uint8_t *buf)</td></tr>
<tr class="memitem:a32dbc938f43376657e411cb6a6285fb5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a32dbc938f43376657e411cb6a6285fb5"></a>
static uint32_t </td><td class="memItemRight" valign="bottom"><b>unaligned_read32be</b> (const uint8_t *buf)</td></tr>
<tr class="memitem:a29527305cc7fb6ba4b4fe8f6f44d2147"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a29527305cc7fb6ba4b4fe8f6f44d2147"></a>
static uint32_t </td><td class="memItemRight" valign="bottom"><b>unaligned_read32le</b> (const uint8_t *buf)</td></tr>
<tr class="memitem:a822e6b949cf0f6606754e315b015421e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a822e6b949cf0f6606754e315b015421e"></a>
static void </td><td class="memItemRight" valign="bottom"><b>unaligned_write16be</b> (uint8_t *buf, uint16_t num)</td></tr>
<tr class="memitem:a36528cdd7dbf52b7c4aa438fc3c6619b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a36528cdd7dbf52b7c4aa438fc3c6619b"></a>
static void </td><td class="memItemRight" valign="bottom"><b>unaligned_write16le</b> (uint8_t *buf, uint16_t num)</td></tr>
<tr class="memitem:a2283faf2589131fb98468fa6a2238d5d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2283faf2589131fb98468fa6a2238d5d"></a>
static void </td><td class="memItemRight" valign="bottom"><b>unaligned_write32be</b> (uint8_t *buf, uint32_t num)</td></tr>
<tr class="memitem:a80a90d3c7e8bde942b718aefc4eb6e8f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a80a90d3c7e8bde942b718aefc4eb6e8f"></a>
static void </td><td class="memItemRight" valign="bottom"><b>unaligned_write32le</b> (uint8_t *buf, uint32_t num)</td></tr>
<tr class="memitem:ace3a388259583931adc6cb3a2f5a8167"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ace3a388259583931adc6cb3a2f5a8167"></a>
static uint32_t </td><td class="memItemRight" valign="bottom"><b>bsr32</b> (uint32_t n)</td></tr>
<tr class="memitem:a108e65d5fe1aae56171dee1be2dcb0a4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a108e65d5fe1aae56171dee1be2dcb0a4"></a>
static uint32_t </td><td class="memItemRight" valign="bottom"><b>clz32</b> (uint32_t n)</td></tr>
<tr class="memitem:a80e9adeba7b4eea789a09ad5e6683d04"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a80e9adeba7b4eea789a09ad5e6683d04"></a>
static uint32_t </td><td class="memItemRight" valign="bottom"><b>ctz32</b> (uint32_t n)</td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Various integer and bit operations. </p>
<p>This file provides macros or functions to do some basic integer and bit operations.</p>
<p>Endianness related integer operations (XX = 16, 32, or 64; Y = b or l):</p>
<ul>
<li>Byte swapping: bswapXX(num)</li>
<li>Byte order conversions to/from native: convXXYe(num)</li>
<li>Aligned reads: readXXYe(ptr)</li>
<li>Aligned writes: writeXXYe(ptr, num)</li>
<li>Unaligned reads (16/32-bit only): unaligned_readXXYe(ptr)</li>
<li>Unaligned writes (16/32-bit only): unaligned_writeXXYe(ptr, num)</li>
</ul>
<p>Since they can macros, the arguments should have no side effects since they may be evaluated more than once.</p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>PowerPC and possibly some other architectures support byte swapping load and store instructions. This file doesn't take advantage of those instructions.</dd></dl>
<p>Bit scan operations for non-zero 32-bit integers:</p>
<ul>
<li>Bit scan reverse (find highest non-zero bit): bsr32(num)</li>
<li>Count leading zeros: clz32(num)</li>
<li>Count trailing zeros: ctz32(num)</li>
<li>Bit scan forward (simply an alias for ctz32()): bsf32(num)</li>
</ul>
<p>The above bit scan operations return 0-31. If num is zero, the result is undefined. </p>
</div><h2>Macro Definition Documentation</h2>
<a class="anchor" id="a2610a88a071ec508edbc15ee90094e64"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define bswap32</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">num</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line">( (((uint32_t)(num) << 24) ) \</div>
<div class="line"> | (((uint32_t)(num) << 8) & UINT32_C(0x00FF0000)) \</div>
<div class="line"> | (((uint32_t)(num) >> 8) & UINT32_C(0x0000FF00)) \</div>
<div class="line"> | (((uint32_t)(num) >> 24) ) )</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ac9db02787e6a4bc63d62808b357df8ce"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define bswap64</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">num</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line">( (((uint64_t)(num) << 56) ) \</div>
<div class="line"> | (((uint64_t)(num) << 40) & UINT64_C(0x00FF000000000000)) \</div>
<div class="line"> | (((uint64_t)(num) << 24) & UINT64_C(0x0000FF0000000000)) \</div>
<div class="line"> | (((uint64_t)(num) << 8) & UINT64_C(0x000000FF00000000)) \</div>
<div class="line"> | (((uint64_t)(num) >> 8) & UINT64_C(0x00000000FF000000)) \</div>
<div class="line"> | (((uint64_t)(num) >> 24) & UINT64_C(0x0000000000FF0000)) \</div>
<div class="line"> | (((uint64_t)(num) >> 40) & UINT64_C(0x000000000000FF00)) \</div>
<div class="line"> | (((uint64_t)(num) >> 56) ) )</div>
</div><!-- fragment -->
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Nov 18 2012 19:30:21 for XZ Utils by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>
|