Skip to content

Commit 228c502

Browse files
kkhalailkkhalail
committed
Update XED Documentation
Align XED documentation with November 2024 external release [SDE-4368]
1 parent 0f5b649 commit 228c502

File tree

269 files changed

+163415
-110143
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

269 files changed

+163415
-110143
lines changed

‎build-manual/index.html‎

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎ref-manual/functions_e.html‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,9 @@ <h3><a id="index_e"></a>- e -</h3><ul>
9696
<li>element_size
9797
: <a class="el" href="structxed__operand__storage__s.html#acbce437fe6914af047fae06df2368a1c">xed_operand_storage_s</a>
9898
</li>
99+
<li>emit_ignored_branch_taken_hint
100+
: <a class="el" href="structxed__format__options__t.html#ae241ede0d62ea594d6cb4d3b2b3e8460">xed_format_options_t</a>
101+
</li>
99102
<li>emitted
100103
: <a class="el" href="structxed__print__info__t.html#a426697c198943f37470982f3f956c35d">xed_print_info_t</a>
101104
</li>

‎ref-manual/functions_vars_e.html‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,9 @@ <h3><a id="index_e"></a>- e -</h3><ul>
9696
<li>element_size
9797
: <a class="el" href="structxed__operand__storage__s.html#acbce437fe6914af047fae06df2368a1c">xed_operand_storage_s</a>
9898
</li>
99+
<li>emit_ignored_branch_taken_hint
100+
: <a class="el" href="structxed__format__options__t.html#ae241ede0d62ea594d6cb4d3b2b3e8460">xed_format_options_t</a>
101+
</li>
99102
<li>emitted
100103
: <a class="el" href="structxed__print__info__t.html#a426697c198943f37470982f3f956c35d">xed_print_info_t</a>
101104
</li>

‎ref-manual/globals_defs.html‎

Lines changed: 4146 additions & 54 deletions
Large diffs are not rendered by default.

‎ref-manual/globals_eval.html‎

Lines changed: 4146 additions & 54 deletions
Large diffs are not rendered by default.

‎ref-manual/globals_func_x.html‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2034,9 +2034,6 @@ <h3><a id="index_x"></a>- x -</h3><ul>
20342034
<li>xed_operand_values_has_branch_displacement()
20352035
: <a class="el" href="group__OPERANDS.html#ga4ad34793ee0b41476c742182fa625caa">xed-operand-values-interface.h</a>
20362036
</li>
2037-
<li>xed_operand_values_has_disp()
2038-
: <a class="el" href="group__OPERANDS.html#gab0d49de82df18773d120efd1b5facb96">xed-operand-values-interface.h</a>
2039-
</li>
20402037
<li>xed_operand_values_has_displacement()
20412038
: <a class="el" href="group__OPERANDS.html#ga35cc443e8ea463cfe087ed5ad3287de5">xed-operand-values-interface.h</a>
20422039
</li>
@@ -2073,6 +2070,12 @@ <h3><a id="index_x"></a>- x -</h3><ul>
20732070
<li>xed_operand_values_has_sib_byte()
20742071
: <a class="el" href="group__OPERANDS.html#ga87e7a1bf6ad7fc739d57334c60da30f3">xed-operand-values-interface.h</a>
20752072
</li>
2073+
<li>xed_operand_values_ignored_branch_not_taken_hint()
2074+
: <a class="el" href="group__OPERANDS.html#ga5ad363d31f2bb56a184e050f9d726574">xed-operand-values-interface.h</a>
2075+
</li>
2076+
<li>xed_operand_values_ignored_branch_taken_hint()
2077+
: <a class="el" href="group__OPERANDS.html#ga2a003fcb55418bbb7bab8936fcb56237">xed-operand-values-interface.h</a>
2078+
</li>
20762079
<li>xed_operand_values_init()
20772080
: <a class="el" href="group__OPERANDS.html#ga5b6cd7ad6c5c853c8ae1179df71fe6d1">xed-operand-values-interface.h</a>
20782081
</li>
@@ -2085,9 +2088,6 @@ <h3><a id="index_x"></a>- x -</h3><ul>
20852088
<li>xed_operand_values_is_nop()
20862089
: <a class="el" href="group__OPERANDS.html#ga1e19112db73aea4cb91a8682cf7c1dac">xed-operand-values-interface.h</a>
20872090
</li>
2088-
<li>xed_operand_values_is_prefetch()
2089-
: <a class="el" href="group__OPERANDS.html#gaf1b7e94aa1e7bc4a75d707d31ca66254">xed-operand-values-interface.h</a>
2090-
</li>
20912091
<li>xed_operand_values_lockable()
20922092
: <a class="el" href="group__OPERANDS.html#gad6f0386f64431371591ce8c6cb914e7f">xed-operand-values-interface.h</a>
20932093
</li>
@@ -2410,7 +2410,7 @@ <h3><a id="index_x"></a>- x -</h3><ul>
24102410
: <a class="el" href="group__ENUM.html#gaee6d6cc72a43e967fcd2c4879aa469dc">xed-syntax-enum.h</a>
24112411
</li>
24122412
<li>xed_tables_init()
2413-
: <a class="el" href="group__INIT.html#gacc180d75159533eb63e61611004d4512">xed-init.h</a>
2413+
: <a class="el" href="group__INIT.html#ga0fba52fba611ceaf93ace0a236d9cb7c">xed-init.h</a>
24142414
</li>
24152415
<li>xed_zero_extend16_32()
24162416
: <a class="el" href="xed-util_8h.html#a4f79aeaa6a48f0826e9e240330e132d4">xed-util.h</a>

‎ref-manual/globals_x.html‎

Lines changed: 8302 additions & 118 deletions
Large diffs are not rendered by default.

‎ref-manual/group__CMDLINE.html‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,7 @@
153153
<div class="line"> -uc (upper <span class="keywordflow">case</span> hex formatting)</div>
154154
<div class="line"> -pmd (positive memory displacement formatting)</div>
155155
<div class="line"> -nwm (Format AVX512 without curly braces <span class="keywordflow">for</span> writemasks, include k0)</div>
156+
<div class="line"> -emit-ignored-branch-hint (emit ignored branch hints during disassembly)</div>
156157
<div class="line"> -emit (Output __emit statements <span class="keywordflow">for</span> the Intel compiler)</div>
157158
<div class="line"> -S file Read symbol table in <span class="stringliteral">&quot;nm&quot;</span> format from file</div>
158159
<div class="line"> -dot FN (Emit a <span class="keyword">register</span> dependence graph file in dot format.</div>
@@ -999,8 +1000,8 @@
9991000
<div class="ttc" id="axed-operand-enum_8h_html_a09c2a35d8bb7bfe68bb3d34b0a5e011aa89727de05ece94e9ddcd53a74b6cf8c2"><div class="ttname"><a href="xed-operand-enum_8h.html#a09c2a35d8bb7bfe68bb3d34b0a5e011aa89727de05ece94e9ddcd53a74b6cf8c2">XED_OPERAND_ABSBR</a></div><div class="ttdeci">@ XED_OPERAND_ABSBR</div><div class="ttdef"><b>Definition:</b> xed-operand-enum.h:170</div></div>
10001001
<div class="ttc" id="axed-portability_8h_html_a4eab1affb8a1c6e1db4c0e6585cbd120"><div class="ttname"><a href="xed-portability_8h.html#a4eab1affb8a1c6e1db4c0e6585cbd120">xed_strncpy</a></div><div class="ttdeci">XED_DLL_EXPORT int xed_strncpy(char *dst, const char *src, int len)</div><div class="ttdoc">returns the number of bytes remaining for the next use of xed_strncpy() or xed_strncat() .</div></div>
10011002
<div class="ttc" id="axed-operand-enum_8h_html_a09c2a35d8bb7bfe68bb3d34b0a5e011aa17757f8f75fb149d6a9ceff628403994"><div class="ttname"><a href="xed-operand-enum_8h.html#a09c2a35d8bb7bfe68bb3d34b0a5e011aa17757f8f75fb149d6a9ceff628403994">XED_OPERAND_MEM0</a></div><div class="ttdeci">@ XED_OPERAND_MEM0</div><div class="ttdef"><b>Definition:</b> xed-operand-enum.h:218</div></div>
1002-
<div class="ttc" id="axed-iclass-enum_8h_html_ad318511ae9cc50f102251b3c91a1ab9fa2c77d475f97998fe763062db09fd15de"><div class="ttname"><a href="xed-iclass-enum_8h.html#ad318511ae9cc50f102251b3c91a1ab9fa2c77d475f97998fe763062db09fd15de">XED_ICLASS_INVALID</a></div><div class="ttdeci">@ XED_ICLASS_INVALID</div><div class="ttdef"><b>Definition:</b> xed-iclass-enum.h:1887</div></div>
1003-
<div class="ttc" id="axed-iclass-enum_8h_html_ad318511ae9cc50f102251b3c91a1ab9f"><div class="ttname"><a href="xed-iclass-enum_8h.html#ad318511ae9cc50f102251b3c91a1ab9f">xed_iclass_enum_t</a></div><div class="ttdeci">xed_iclass_enum_t</div><div class="ttdef"><b>Definition:</b> xed-iclass-enum.h:1886</div></div>
1003+
<div class="ttc" id="axed-iclass-enum_8h_html_ad318511ae9cc50f102251b3c91a1ab9fa2c77d475f97998fe763062db09fd15de"><div class="ttname"><a href="xed-iclass-enum_8h.html#ad318511ae9cc50f102251b3c91a1ab9fa2c77d475f97998fe763062db09fd15de">XED_ICLASS_INVALID</a></div><div class="ttdeci">@ XED_ICLASS_INVALID</div><div class="ttdef"><b>Definition:</b> xed-iclass-enum.h:2003</div></div>
1004+
<div class="ttc" id="axed-iclass-enum_8h_html_ad318511ae9cc50f102251b3c91a1ab9f"><div class="ttname"><a href="xed-iclass-enum_8h.html#ad318511ae9cc50f102251b3c91a1ab9f">xed_iclass_enum_t</a></div><div class="ttdeci">xed_iclass_enum_t</div><div class="ttdef"><b>Definition:</b> xed-iclass-enum.h:2002</div></div>
10041005
<div class="ttc" id="axed-operand-enum_8h_html_a09c2a35d8bb7bfe68bb3d34b0a5e011aaf84141b5908fd0d494f446a66f3eeef3"><div class="ttname"><a href="xed-operand-enum_8h.html#a09c2a35d8bb7bfe68bb3d34b0a5e011aaf84141b5908fd0d494f446a66f3eeef3">XED_OPERAND_PTR</a></div><div class="ttdeci">@ XED_OPERAND_PTR</div><div class="ttdef"><b>Definition:</b> xed-operand-enum.h:256</div></div>
10051006
<div class="ttc" id="axed-operand-enum_8h_html_a09c2a35d8bb7bfe68bb3d34b0a5e011aabe26987877ba7bfe6b67c7106fd77286"><div class="ttname"><a href="xed-operand-enum_8h.html#a09c2a35d8bb7bfe68bb3d34b0a5e011aabe26987877ba7bfe6b67c7106fd77286">XED_OPERAND_MEM1</a></div><div class="ttdeci">@ XED_OPERAND_MEM1</div><div class="ttdef"><b>Definition:</b> xed-operand-enum.h:219</div></div>
10061007
<div class="ttc" id="axed-portability_8h_html_ae0cdf0e8a0284d011be1a08e8a4e3094"><div class="ttname"><a href="xed-portability_8h.html#ae0cdf0e8a0284d011be1a08e8a4e3094">XED_STATIC_CAST</a></div><div class="ttdeci">#define XED_STATIC_CAST(x, y)</div><div class="ttdef"><b>Definition:</b> xed-portability.h:27</div></div>

‎ref-manual/group__INIT.html‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -113,8 +113,8 @@
113113
<tr class="separator:ga884629a9ddd4db55da6aa0b012423108"><td class="memSeparator" colspan="2">&#160;</td></tr>
114114
<tr class="memitem:ga017b6fcac483ea9f1621c4cdd0af84bd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="xed-common-hdrs_8h.html#a029d5ee2957ac2af5e2b75ec09f1daf9">XED_DLL_EXPORT</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__INIT.html#ga017b6fcac483ea9f1621c4cdd0af84bd">xed_register_abort_function</a> (<a class="el" href="xed-util_8h.html#a45f6a52b3be7c5335e5b59827e43ca23">xed_user_abort_function_t</a> fn, void *other)</td></tr>
115115
<tr class="separator:ga017b6fcac483ea9f1621c4cdd0af84bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
116-
<tr class="memitem:gacc180d75159533eb63e61611004d4512"><td class="memItemLeft" align="right" valign="top">void <a class="el" href="xed-common-hdrs_8h.html#a029d5ee2957ac2af5e2b75ec09f1daf9">XED_DLL_EXPORT</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__INIT.html#gacc180d75159533eb63e61611004d4512">xed_tables_init</a> (void)</td></tr>
117-
<tr class="separator:gacc180d75159533eb63e61611004d4512"><td class="memSeparator" colspan="2">&#160;</td></tr>
116+
<tr class="memitem:ga0fba52fba611ceaf93ace0a236d9cb7c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="xed-common-hdrs_8h.html#a029d5ee2957ac2af5e2b75ec09f1daf9">XED_DLL_EXPORT</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__INIT.html#ga0fba52fba611ceaf93ace0a236d9cb7c">xed_tables_init</a> (void)</td></tr>
117+
<tr class="separator:ga0fba52fba611ceaf93ace0a236d9cb7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
118118
</table><table class="memberdecls">
119119
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
120120
Initialization</h2></td></tr>
@@ -171,7 +171,7 @@
171171
<div class="fragment"><div class="line"><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
172172
<div class="line"><span class="preprocessor">#include &quot;<a class="code" href="xed-interface_8h.html">xed-interface.h</a>&quot;</span></div>
173173
<div class="line">}</div>
174-
</div><!-- fragment --><p>Once, before using Intel&reg; XED, you must call <a class="el" href="group__INIT.html#gacc180d75159533eb63e61611004d4512">xed_tables_init()</a> to initialize the tables Intel&reg; XED uses for encoding and decoding: </p><div class="fragment"><div class="line"><a class="code" href="group__INIT.html#gacc180d75159533eb63e61611004d4512">xed_tables_init</a>();</div>
174+
</div><!-- fragment --><p>Once, before using Intel&reg; XED, you must call <a class="el" href="group__INIT.html#ga0fba52fba611ceaf93ace0a236d9cb7c">xed_tables_init()</a> to initialize the tables Intel&reg; XED uses for encoding and decoding: </p><div class="fragment"><div class="line"><a class="code" href="group__INIT.html#ga0fba52fba611ceaf93ace0a236d9cb7c">xed_tables_init</a>();</div>
175175
</div><!-- fragment --><p>Once initialized, Intel&reg; XED is reentrant (multithread safe). All values used for encoding and decoding live on the caller's stack or in the passed-in parameters.</p>
176176
<p>If your program is multithreaded, initialize Intel&reg; XED once (and only once) using the above call before you attempt to decode or encode from any thread. Each thread does NOT need to initialize Intel&reg; XED. The idea is to initialize Intel&reg; XED before creating your threads. </p>
177177
<h2 class="groupheader">Typedef Documentation</h2>
@@ -708,14 +708,14 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga8eea80ff7aa0fc77c3c3e90
708708

709709
</div>
710710
</div>
711-
<a id="gacc180d75159533eb63e61611004d4512"></a>
712-
<h2 class="memtitle"><span class="permalink"><a href="#gacc180d75159533eb63e61611004d4512">&#9670;&nbsp;</a></span>xed_tables_init()</h2>
711+
<a id="ga0fba52fba611ceaf93ace0a236d9cb7c"></a>
712+
<h2 class="memtitle"><span class="permalink"><a href="#ga0fba52fba611ceaf93ace0a236d9cb7c">&#9670;&nbsp;</a></span>xed_tables_init()</h2>
713713

714714
<div class="memitem">
715715
<div class="memproto">
716716
<table class="memname">
717717
<tr>
718-
<td class="memname">void <a class="el" href="xed-common-hdrs_8h.html#a029d5ee2957ac2af5e2b75ec09f1daf9">XED_DLL_EXPORT</a> xed_tables_init </td>
718+
<td class="memname"><a class="el" href="xed-common-hdrs_8h.html#a029d5ee2957ac2af5e2b75ec09f1daf9">XED_DLL_EXPORT</a> void xed_tables_init </td>
719719
<td>(</td>
720720
<td class="paramtype">void&#160;</td>
721721
<td class="paramname"></td><td>)</td>
@@ -729,7 +729,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gacc180d75159533eb63e6161
729729
</div>
730730
</div><!-- contents -->
731731
</div><!-- doc-content -->
732-
<div class="ttc" id="agroup__INIT_html_gacc180d75159533eb63e61611004d4512"><div class="ttname"><a href="group__INIT.html#gacc180d75159533eb63e61611004d4512">xed_tables_init</a></div><div class="ttdeci">void XED_DLL_EXPORT xed_tables_init(void)</div></div>
732+
<div class="ttc" id="agroup__INIT_html_ga0fba52fba611ceaf93ace0a236d9cb7c"><div class="ttname"><a href="group__INIT.html#ga0fba52fba611ceaf93ace0a236d9cb7c">xed_tables_init</a></div><div class="ttdeci">XED_DLL_EXPORT void xed_tables_init(void)</div></div>
733733
<div class="ttc" id="axed-interface_8h_html"><div class="ttname"><a href="xed-interface_8h.html">xed-interface.h</a></div></div>
734734
<!-- start footer part -->
735735
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->

‎ref-manual/group__INIT.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,5 @@ var group__INIT =
2121
[ "xed_state_set_machine_mode", "group__INIT.html#gabb8aa407f1664d9cee6201bb69e638f7", null ],
2222
[ "xed_state_set_stack_address_width", "group__INIT.html#ga724e2158223d6c97bd8fb619af042cf7", null ],
2323
[ "xed_state_zero", "group__INIT.html#ga8eea80ff7aa0fc77c3c3e90ce3e1fd64", null ],
24-
[ "xed_tables_init", "group__INIT.html#gacc180d75159533eb63e61611004d4512", null ]
24+
[ "xed_tables_init", "group__INIT.html#ga0fba52fba611ceaf93ace0a236d9cb7c", null ]
2525
];

0 commit comments

Comments
 (0)