misc/decoder_test/XED2/doc/html/structxed__decoded__inst__s.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
   3 <title>XED2: XED2 User Guide - Thu May 15 03:15:09 2008 </title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 <link href="tabs.css" rel="stylesheet" type="text/css">
   6 </head><body>
   7 <!-- Generated by Doxygen 1.4.6 -->
   8 <div class="tabs">
   9   <ul>
  10     <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
  11     <li><a href="modules.html"><span>Modules</span></a></li>
  12     <li id="current"><a href="classes.html"><span>Data&nbsp;Structures</span></a></li>
  13     <li><a href="files.html"><span>Files</span></a></li>
  14     <li>
  15       <form action="search.php" method="get">
  16         <table cellspacing="0" cellpadding="0" border="0">
  17           <tr>
  18             <td><label>&nbsp;<u>S</u>earch&nbsp;for&nbsp;</label></td>
  19             <td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
  20           </tr>
  21         </table>
  22       </form>
  23     </li>
  24   </ul></div>
  25 <div class="tabs">
  26   <ul>
  27     <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
  28     <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
  29     <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
  30     <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
  31   </ul></div>
  32 <h1>xed_decoded_inst_s Struct Reference<br>
  33 <small>
  34 [<a class="el" href="group__DEC.html">Decoding Instructions</a>]</small>
  35 </h1><!-- doxytag: class="xed_decoded_inst_s" --><code>#include &lt;<a class="el" href="xed-decoded-inst_8h-source.html">xed-decoded-inst.h</a>&gt;</code>
  36 <p>
  37 <hr><a name="_details"></a><h2>Detailed Description</h2>
  38 The main container for instructions.
  39 <p>
  40 After decode, it holds an array of operands with derived information from decode and also valid <a class="el" href="group__DEC.html#g2b28c31e1e83e74ef5f613b38e0cc0ec">xed_inst_t</a> pointer which describes the operand templates and the operand order. See <a class="el" href="group__DEC.html">Decoding Instructions</a> for API documentation.
  41 <p>
  42
  43 <p>
  44 Definition at line <a class="el" href="xed-decoded-inst_8h-source.html#l00061">61</a> of file <a class="el" href="xed-decoded-inst_8h-source.html">xed-decoded-inst.h</a>.<table border="0" cellpadding="0" cellspacing="0">
  45 <tr><td></td></tr>
  46 <tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
  47 <tr><td class="memItemLeft" nowrap>union {</td></tr>
  48
  49 <tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;const xed_uint8_t *&nbsp;&nbsp;&nbsp;<a class="el" href="structxed__decoded__inst__s.html#412cdad60af0a1b6764572bd1e06341a">_dec</a></td></tr>
  50
  51 <tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;xed_uint8_t *&nbsp;&nbsp;&nbsp;<a class="el" href="structxed__decoded__inst__s.html#cd3a82f4a7db2f2d84e13b80953fe5a1">_enc</a></td></tr>
  52
  53 <tr><td class="memItemLeft" nowrap valign="top">}&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxed__decoded__inst__s.html#38b03be58fb05fab25bb86995a92e5fe">_byte_array</a></td></tr>
  54
  55 <tr><td class="memItemLeft" nowrap align="right" valign="top">xed_uint8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxed__decoded__inst__s.html#1fab5a1da476258bf447ee424db583da">_decoded_length</a></td></tr>
  56
  57 <tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="group__DEC.html#g2b28c31e1e83e74ef5f613b38e0cc0ec">xed_inst_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxed__decoded__inst__s.html#b08a8c51fc2965d6bd2f741281375145">_inst</a></td></tr>
  58
  59 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">when we decode an instruction, we set the _inst and get the properites of that instruction here.  <a href="#b08a8c51fc2965d6bd2f741281375145"></a><br></td></tr>
  60 <tr><td class="memItemLeft" nowrap align="right" valign="top">xed_uint8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxed__decoded__inst__s.html#18dfd5080b21ef3e0dbdb4ee25eb607c">_n_operand_order</a></td></tr>
  61
  62 <tr><td class="memItemLeft" nowrap align="right" valign="top">xed_uint8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxed__decoded__inst__s.html#39fccfddf6af7f038aa90aa643ae0a88">_operand_order</a> [XED_ENCODE_ORDER_MAX_OPERANDS]</td></tr>
  63
  64 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Used for encode operand ordering. Not set by decode.  <a href="#39fccfddf6af7f038aa90aa643ae0a88"></a><br></td></tr>
  65 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="xed-operand-storage_8h.html#eb1037b79ccdc048af4887376f6382a4">xed_operand_values_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxed__decoded__inst__s.html#d9edc8d0f915f058522a69588cf82b8e">_operands</a> [XED_OPERAND_LAST]</td></tr>
  66
  67 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The operand storage fields discovered during decoding. This same array is used by encode.  <a href="#d9edc8d0f915f058522a69588cf82b8e"></a><br></td></tr>
  68 <tr><td class="memItemLeft" nowrap>union {</td></tr>
  69
  70 <tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;xed_decoder_vars_s *&nbsp;&nbsp;&nbsp;<a class="el" href="structxed__decoded__inst__s.html#86a61793d1c864676e46e563ded5c60d">dv</a></td></tr>
  71
  72 <tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;xed_encoder_vars_s *&nbsp;&nbsp;&nbsp;<a class="el" href="structxed__decoded__inst__s.html#970cf4df570b46c91bcda570f9e909cc">ev</a></td></tr>
  73
  74 <tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;xed_uint64_t&nbsp;&nbsp;&nbsp;<a class="el" href="structxed__decoded__inst__s.html#76dd7c3749de4ea740c3ae490bc53cce">user_data</a></td></tr>
  75
  76 <tr><td class="memItemLeft" nowrap valign="top">}&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structxed__decoded__inst__s.html#0db7e2fe9fff38507c45bc83a19eece0">u</a></td></tr>
  77
  78 </table>
  79 <hr><h2>Field Documentation</h2>
  80 <a class="anchor" name="38b03be58fb05fab25bb86995a92e5fe"></a><!-- doxytag: member="xed_decoded_inst_s::_byte_array" ref="38b03be58fb05fab25bb86995a92e5fe" args="" --><p>
  81 <table class="mdTable" cellpadding="2" cellspacing="0">
  82   <tr>
  83     <td class="mdRow">
  84       <table cellpadding="0" cellspacing="0" border="0">
  85         <tr>
  86           <td class="md" nowrap valign="top">union { ... }   <a class="el" href="structxed__decoded__inst__s.html#38b03be58fb05fab25bb86995a92e5fe">_byte_array</a>          </td>
  87         </tr>
  88       </table>
  89     </td>
  90   </tr>
  91 </table>
  92 <table cellspacing="5" cellpadding="0" border="0">
  93   <tr>
  94     <td>
  95       &nbsp;
  96     </td>
  97     <td>
  98
  99 <p>
 100     </td>
 101   </tr>
 102 </table>
 103 <a class="anchor" name="412cdad60af0a1b6764572bd1e06341a"></a><!-- doxytag: member="xed_decoded_inst_s::_dec" ref="412cdad60af0a1b6764572bd1e06341a" args="" --><p>
 104 <table class="mdTable" cellpadding="2" cellspacing="0">
 105   <tr>
 106     <td class="mdRow">
 107       <table cellpadding="0" cellspacing="0" border="0">
 108         <tr>
 109           <td class="md" nowrap valign="top">const xed_uint8_t* <a class="el" href="structxed__decoded__inst__s.html#412cdad60af0a1b6764572bd1e06341a">_dec</a>          </td>
 110         </tr>
 111       </table>
 112     </td>
 113   </tr>
 114 </table>
 115 <table cellspacing="5" cellpadding="0" border="0">
 116   <tr>
 117     <td>
 118       &nbsp;
 119     </td>
 120     <td>
 121
 122 <p>
 123
 124 <p>
 125 Definition at line <a class="el" href="xed-decoded-inst_8h-source.html#l00080">80</a> of file <a class="el" href="xed-decoded-inst_8h-source.html">xed-decoded-inst.h</a>.    </td>
 126   </tr>
 127 </table>
 128 <a class="anchor" name="1fab5a1da476258bf447ee424db583da"></a><!-- doxytag: member="xed_decoded_inst_s::_decoded_length" ref="1fab5a1da476258bf447ee424db583da" args="" --><p>
 129 <table class="mdTable" cellpadding="2" cellspacing="0">
 130   <tr>
 131     <td class="mdRow">
 132       <table cellpadding="0" cellspacing="0" border="0">
 133         <tr>
 134           <td class="md" nowrap valign="top">xed_uint8_t <a class="el" href="structxed__decoded__inst__s.html#1fab5a1da476258bf447ee424db583da">_decoded_length</a>          </td>
 135         </tr>
 136       </table>
 137     </td>
 138   </tr>
 139 </table>
 140 <table cellspacing="5" cellpadding="0" border="0">
 141   <tr>
 142     <td>
 143       &nbsp;
 144     </td>
 145     <td>
 146
 147 <p>
 148
 149 <p>
 150 Definition at line <a class="el" href="xed-decoded-inst_8h-source.html#l00068">68</a> of file <a class="el" href="xed-decoded-inst_8h-source.html">xed-decoded-inst.h</a>.    </td>
 151   </tr>
 152 </table>
 153 <a class="anchor" name="cd3a82f4a7db2f2d84e13b80953fe5a1"></a><!-- doxytag: member="xed_decoded_inst_s::_enc" ref="cd3a82f4a7db2f2d84e13b80953fe5a1" args="" --><p>
 154 <table class="mdTable" cellpadding="2" cellspacing="0">
 155   <tr>
 156     <td class="mdRow">
 157       <table cellpadding="0" cellspacing="0" border="0">
 158         <tr>
 159           <td class="md" nowrap valign="top">xed_uint8_t* <a class="el" href="structxed__decoded__inst__s.html#cd3a82f4a7db2f2d84e13b80953fe5a1">_enc</a>          </td>
 160         </tr>
 161       </table>
 162     </td>
 163   </tr>
 164 </table>
 165 <table cellspacing="5" cellpadding="0" border="0">
 166   <tr>
 167     <td>
 168       &nbsp;
 169     </td>
 170     <td>
 171
 172 <p>
 173
 174 <p>
 175 Definition at line <a class="el" href="xed-decoded-inst_8h-source.html#l00079">79</a> of file <a class="el" href="xed-decoded-inst_8h-source.html">xed-decoded-inst.h</a>.    </td>
 176   </tr>
 177 </table>
 178 <a class="anchor" name="b08a8c51fc2965d6bd2f741281375145"></a><!-- doxytag: member="xed_decoded_inst_s::_inst" ref="b08a8c51fc2965d6bd2f741281375145" args="" --><p>
 179 <table class="mdTable" cellpadding="2" cellspacing="0">
 180   <tr>
 181     <td class="mdRow">
 182       <table cellpadding="0" cellspacing="0" border="0">
 183         <tr>
 184           <td class="md" nowrap valign="top">const <a class="el" href="group__DEC.html#g2b28c31e1e83e74ef5f613b38e0cc0ec">xed_inst_t</a>* <a class="el" href="structxed__decoded__inst__s.html#b08a8c51fc2965d6bd2f741281375145">_inst</a>          </td>
 185         </tr>
 186       </table>
 187     </td>
 188   </tr>
 189 </table>
 190 <table cellspacing="5" cellpadding="0" border="0">
 191   <tr>
 192     <td>
 193       &nbsp;
 194     </td>
 195     <td>
 196
 197 <p>
 198 when we decode an instruction, we set the _inst and get the properites of that instruction here.
 199 <p>
 200 This also points to the operands template array.
 201 <p>
 202 Definition at line <a class="el" href="xed-decoded-inst_8h-source.html#l00075">75</a> of file <a class="el" href="xed-decoded-inst_8h-source.html">xed-decoded-inst.h</a>.    </td>
 203   </tr>
 204 </table>
 205 <a class="anchor" name="18dfd5080b21ef3e0dbdb4ee25eb607c"></a><!-- doxytag: member="xed_decoded_inst_s::_n_operand_order" ref="18dfd5080b21ef3e0dbdb4ee25eb607c" args="" --><p>
 206 <table class="mdTable" cellpadding="2" cellspacing="0">
 207   <tr>
 208     <td class="mdRow">
 209       <table cellpadding="0" cellspacing="0" border="0">
 210         <tr>
 211           <td class="md" nowrap valign="top">xed_uint8_t <a class="el" href="structxed__decoded__inst__s.html#18dfd5080b21ef3e0dbdb4ee25eb607c">_n_operand_order</a>          </td>
 212         </tr>
 213       </table>
 214     </td>
 215   </tr>
 216 </table>
 217 <table cellspacing="5" cellpadding="0" border="0">
 218   <tr>
 219     <td>
 220       &nbsp;
 221     </td>
 222     <td>
 223
 224 <p>
 225
 226 <p>
 227 Definition at line <a class="el" href="xed-decoded-inst_8h-source.html#l00070">70</a> of file <a class="el" href="xed-decoded-inst_8h-source.html">xed-decoded-inst.h</a>.    </td>
 228   </tr>
 229 </table>
 230 <a class="anchor" name="39fccfddf6af7f038aa90aa643ae0a88"></a><!-- doxytag: member="xed_decoded_inst_s::_operand_order" ref="39fccfddf6af7f038aa90aa643ae0a88" args="[XED_ENCODE_ORDER_MAX_OPERANDS]" --><p>
 231 <table class="mdTable" cellpadding="2" cellspacing="0">
 232   <tr>
 233     <td class="mdRow">
 234       <table cellpadding="0" cellspacing="0" border="0">
 235         <tr>
 236           <td class="md" nowrap valign="top">xed_uint8_t <a class="el" href="structxed__decoded__inst__s.html#39fccfddf6af7f038aa90aa643ae0a88">_operand_order</a>[XED_ENCODE_ORDER_MAX_OPERANDS]          </td>
 237         </tr>
 238       </table>
 239     </td>
 240   </tr>
 241 </table>
 242 <table cellspacing="5" cellpadding="0" border="0">
 243   <tr>
 244     <td>
 245       &nbsp;
 246     </td>
 247     <td>
 248
 249 <p>
 250 Used for encode operand ordering. Not set by decode.
 251 <p>
 252
 253 <p>
 254 Definition at line <a class="el" href="xed-decoded-inst_8h-source.html#l00066">66</a> of file <a class="el" href="xed-decoded-inst_8h-source.html">xed-decoded-inst.h</a>.    </td>
 255   </tr>
 256 </table>
 257 <a class="anchor" name="d9edc8d0f915f058522a69588cf82b8e"></a><!-- doxytag: member="xed_decoded_inst_s::_operands" ref="d9edc8d0f915f058522a69588cf82b8e" args="[XED_OPERAND_LAST]" --><p>
 258 <table class="mdTable" cellpadding="2" cellspacing="0">
 259   <tr>
 260     <td class="mdRow">
 261       <table cellpadding="0" cellspacing="0" border="0">
 262         <tr>
 263           <td class="md" nowrap valign="top"><a class="el" href="xed-operand-storage_8h.html#eb1037b79ccdc048af4887376f6382a4">xed_operand_values_t</a> <a class="el" href="structxed__decoded__inst__s.html#d9edc8d0f915f058522a69588cf82b8e">_operands</a>[XED_OPERAND_LAST]          </td>
 264         </tr>
 265       </table>
 266     </td>
 267   </tr>
 268 </table>
 269 <table cellspacing="5" cellpadding="0" border="0">
 270   <tr>
 271     <td>
 272       &nbsp;
 273     </td>
 274     <td>
 275
 276 <p>
 277 The operand storage fields discovered during decoding. This same array is used by encode.
 278 <p>
 279
 280 <p>
 281 Definition at line <a class="el" href="xed-decoded-inst_8h-source.html#l00063">63</a> of file <a class="el" href="xed-decoded-inst_8h-source.html">xed-decoded-inst.h</a>.    </td>
 282   </tr>
 283 </table>
 284 <a class="anchor" name="86a61793d1c864676e46e563ded5c60d"></a><!-- doxytag: member="xed_decoded_inst_s::dv" ref="86a61793d1c864676e46e563ded5c60d" args="" --><p>
 285 <table class="mdTable" cellpadding="2" cellspacing="0">
 286   <tr>
 287     <td class="mdRow">
 288       <table cellpadding="0" cellspacing="0" border="0">
 289         <tr>
 290           <td class="md" nowrap valign="top">struct xed_decoder_vars_s* <a class="el" href="structxed__decoded__inst__s.html#86a61793d1c864676e46e563ded5c60d">dv</a>          </td>
 291         </tr>
 292       </table>
 293     </td>
 294   </tr>
 295 </table>
 296 <table cellspacing="5" cellpadding="0" border="0">
 297   <tr>
 298     <td>
 299       &nbsp;
 300     </td>
 301     <td>
 302
 303 <p>
 304
 305 <p>
 306 Definition at line <a class="el" href="xed-decoded-inst_8h-source.html#l00090">90</a> of file <a class="el" href="xed-decoded-inst_8h-source.html">xed-decoded-inst.h</a>.    </td>
 307   </tr>
 308 </table>
 309 <a class="anchor" name="970cf4df570b46c91bcda570f9e909cc"></a><!-- doxytag: member="xed_decoded_inst_s::ev" ref="970cf4df570b46c91bcda570f9e909cc" args="" --><p>
 310 <table class="mdTable" cellpadding="2" cellspacing="0">
 311   <tr>
 312     <td class="mdRow">
 313       <table cellpadding="0" cellspacing="0" border="0">
 314         <tr>
 315           <td class="md" nowrap valign="top">struct xed_encoder_vars_s* <a class="el" href="structxed__decoded__inst__s.html#970cf4df570b46c91bcda570f9e909cc">ev</a>          </td>
 316         </tr>
 317       </table>
 318     </td>
 319   </tr>
 320 </table>
 321 <table cellspacing="5" cellpadding="0" border="0">
 322   <tr>
 323     <td>
 324       &nbsp;
 325     </td>
 326     <td>
 327
 328 <p>
 329
 330 <p>
 331 Definition at line <a class="el" href="xed-decoded-inst_8h-source.html#l00091">91</a> of file <a class="el" href="xed-decoded-inst_8h-source.html">xed-decoded-inst.h</a>.    </td>
 332   </tr>
 333 </table>
 334 <a class="anchor" name="0db7e2fe9fff38507c45bc83a19eece0"></a><!-- doxytag: member="xed_decoded_inst_s::u" ref="0db7e2fe9fff38507c45bc83a19eece0" args="" --><p>
 335 <table class="mdTable" cellpadding="2" cellspacing="0">
 336   <tr>
 337     <td class="mdRow">
 338       <table cellpadding="0" cellspacing="0" border="0">
 339         <tr>
 340           <td class="md" nowrap valign="top">union { ... }   <a class="el" href="structxed__decoded__inst__s.html#0db7e2fe9fff38507c45bc83a19eece0">u</a>          </td>
 341         </tr>
 342       </table>
 343     </td>
 344   </tr>
 345 </table>
 346 <table cellspacing="5" cellpadding="0" border="0">
 347   <tr>
 348     <td>
 349       &nbsp;
 350     </td>
 351     <td>
 352
 353 <p>
 354     </td>
 355   </tr>
 356 </table>
 357 <a class="anchor" name="76dd7c3749de4ea740c3ae490bc53cce"></a><!-- doxytag: member="xed_decoded_inst_s::user_data" ref="76dd7c3749de4ea740c3ae490bc53cce" args="" --><p>
 358 <table class="mdTable" cellpadding="2" cellspacing="0">
 359   <tr>
 360     <td class="mdRow">
 361       <table cellpadding="0" cellspacing="0" border="0">
 362         <tr>
 363           <td class="md" nowrap valign="top">xed_uint64_t <a class="el" href="structxed__decoded__inst__s.html#76dd7c3749de4ea740c3ae490bc53cce">user_data</a>          </td>
 364         </tr>
 365       </table>
 366     </td>
 367   </tr>
 368 </table>
 369 <table cellspacing="5" cellpadding="0" border="0">
 370   <tr>
 371     <td>
 372       &nbsp;
 373     </td>
 374     <td>
 375
 376 <p>
 377
 378 <p>
 379 Definition at line <a class="el" href="xed-decoded-inst_8h-source.html#l00089">89</a> of file <a class="el" href="xed-decoded-inst_8h-source.html">xed-decoded-inst.h</a>.    </td>
 380   </tr>
 381 </table>
 382 <hr>The documentation for this struct was generated from the following file:<ul>
 383 <li><a class="el" href="xed-decoded-inst_8h-source.html">xed-decoded-inst.h</a></ul>
 384 <hr size="1"><address style="align: right;"><small>Generated on Thu May 15 03:15:09 2008 for XED2 by&nbsp;
 385 <a href="http://www.doxygen.org/index.html">
 386 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
 387 </body>
 388 </html>